Compare commits
384 Commits
v0.1.35
...
developmen
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d7e4e8ec56 | ||
| 46e0e56e61 | |||
| ce3bb5cd9e | |||
| c3690f3d53 | |||
| e3aaa1b0f8 | |||
| 4096b52244 | |||
| da2429104a | |||
| 00ac4c8bd1 | |||
| 7db14632d6 | |||
| 63e160029e | |||
| e55a9741e2 | |||
| 75b548b439 | |||
| ad65392806 | |||
| 8c8369c42b | |||
| 29ab30788e | |||
| 690af291b5 | |||
| 88680f1954 | |||
| 7dba940d80 | |||
| 5d44d49861 | |||
| c22e9ae8ce | |||
| 55966be158 | |||
|
|
5f9a95f2ca | ||
|
|
efbe50bdea | ||
|
|
f447c7a3f1 | ||
|
|
c346d0c5ed | ||
|
|
ba46ed62ef | ||
|
|
8fc560ae78 | ||
| ed785c79df | |||
| d53043dd65 | |||
| 0a731f83e5 | |||
|
|
ed9ff35807 | ||
|
|
e2c2a560c8 | ||
| 5dcdf72310 | |||
| b6c883b5ac | |||
| 78e4fade03 | |||
| 0ca87c5f32 | |||
| 5b2069c560 | |||
| 0963910572 | |||
| 394dd2c88e | |||
| d16aaa30db | |||
| d662e46a8d | |||
| 18da5823b7 | |||
|
|
1e9de962ad | ||
|
|
b9dc8996f5 | ||
| 7c03226054 | |||
| fc13f3e6ae | |||
| 0414ea85df | |||
| 60e2230448 | |||
| d9ad57985d | |||
| 8368592267 | |||
|
|
b9b8e7ab75 | ||
|
|
dc2f8c2976 | ||
|
|
fc592a2e27 | ||
|
|
0269277ac8 | ||
|
|
ee0e7d44fd | ||
|
|
28f00d3dc6 | ||
|
|
a30646e3b1 | ||
|
|
c7ae0ed393 | ||
| 805c900b02 | |||
| ab5fe67cc2 | |||
|
|
449213681e | ||
|
|
72ab099291 | ||
|
|
007361deab | ||
|
|
8a458c6b3f | ||
|
|
d69023e2c9 | ||
|
|
3f09aad045 | ||
|
|
aa434fddee | ||
|
|
deca6387f2 | ||
|
|
dd293ce387 | ||
| a6d746319c | |||
| 0e20b9696a | |||
| b3e673b38f | |||
| c94be548bf | |||
| 8472d20609 | |||
| 27279f8959 | |||
| 7d4dc2496c | |||
| 3547f04a79 | |||
| 253e26aec6 | |||
| a96d6e8aaa | |||
| 9fe669c5b8 | |||
|
|
7e9bc1c41e | ||
|
|
ee64a9fc58 | ||
| 769c88adc8 | |||
|
|
520769a63e | ||
|
|
1399d53748 | ||
|
|
9f75a454fa | ||
|
|
9a5973d366 | ||
| fc41d3c62c | |||
| 74146177e3 | |||
| c755821e34 | |||
| 50a770c3ca | |||
| 22dfcf4afa | |||
| b09e3ec0e1 | |||
| de7e1abcba | |||
| 03d9e97008 | |||
| 43eb15be7a | |||
|
|
76876049be | ||
| 803828e808 | |||
| 9343772bc5 | |||
| d282a5dc95 | |||
|
|
dd7baa59b0 | ||
|
|
69264adc3d | ||
|
|
3f943de9ed | ||
|
|
feffc09f73 | ||
|
|
f11e0c689a | ||
|
|
7c9f7c7568 | ||
|
|
dcd5af4d5f | ||
| 4402cba8ac | |||
| 01639853ce | |||
| 0a25fc95b5 | |||
| 9b5301f2c3 | |||
| 2998a6e806 | |||
| 0916ff07f8 | |||
| 679108eb9e | |||
| 1d4770aca5 | |||
| 61a3677883 | |||
| 27d2723023 | |||
| 3d8effeac7 | |||
| a080fa8330 | |||
| d1584e929e | |||
| 8733bc3fa8 | |||
| 3ecb8c1130 | |||
|
|
26528a889d | ||
|
|
41e3d2afe4 | ||
|
|
8daca7328d | ||
|
|
86da2cd435 | ||
|
|
a5c4b8f6f8 | ||
|
|
856a6202ee | ||
|
|
a40e172457 | ||
|
|
012a59b3d8 | ||
|
|
6334036b79 | ||
|
|
df462174e5 | ||
|
|
1452d65f48 | ||
|
|
fcb178156b | ||
|
|
28313ad22f | ||
|
|
9986dca758 | ||
|
|
9af9ab40b5 | ||
|
|
4b5a9741a0 | ||
|
|
11c3ea9ca5 | ||
|
|
e7a38e555b | ||
|
|
adb012e9cf | ||
|
|
8ca7985753 | ||
|
|
82378961db | ||
|
|
f9a2ebf24b | ||
|
|
9dc33e3ce9 | ||
|
|
ae4997d80a | ||
|
|
b26c1f74e3 | ||
|
|
bf6dec48f1 | ||
|
|
3a05dc8ae0 | ||
|
|
5559bd4f2f | ||
|
|
9d79408931 | ||
|
|
f5c2b306b8 | ||
|
|
49868a18e1 | ||
|
|
2ab0dfa6b8 | ||
|
|
82375f9b89 | ||
|
|
f664823a90 | ||
|
|
9b2e9114b8 | ||
|
|
8dc2b360ba | ||
|
|
49e48e7aca | ||
|
|
586c6db34e | ||
|
|
122a864601 | ||
|
|
571bc31179 | ||
|
|
35734b5ebc | ||
|
|
15f81aca41 | ||
|
|
1484fec898 | ||
|
|
06fcfa5b50 | ||
|
|
a26f0a93fe | ||
|
|
eb0fe4d3a9 | ||
| 8a7987b9c3 | |||
| 70d581fb57 | |||
| d267c1131f | |||
| 1ac9092eed | |||
|
|
bf79d6d198 | ||
|
|
eada09135c | ||
| a447aeec43 | |||
|
|
78d848783a | ||
|
|
8c2b5a8f5e | ||
|
|
fcb5964f8d | ||
| e97e0d77be | |||
| 16155480de | |||
| e7611d4dc2 | |||
|
|
45215b0abb | ||
|
|
7246223e3b | ||
|
|
1958f24528 | ||
| c033cacd5b | |||
|
|
d3f05c1834 | ||
|
|
4bf16d6f70 | ||
|
|
ad7e1980a5 | ||
|
|
7836a48ad4 | ||
|
|
1d67522937 | ||
|
|
e6c3ed93fa | ||
|
|
2fafd025eb | ||
|
|
3ae980d4c5 | ||
|
|
e94734ecc7 | ||
|
|
deb1210405 | ||
|
|
759870e01e | ||
| 891f3bf66d | |||
| 3179d362fc | |||
| 69d9949c39 | |||
| 5d2adb1a2c | |||
| c409d42f64 | |||
| 2dad87ad5e | |||
| fd5a348e20 | |||
| 93fc823e00 | |||
| f40565c571 | |||
| 5a6f3d323b | |||
| 836a8f799e | |||
| b9a84ee8fc | |||
| 0d3b4357ac | |||
| ea1a49ffd5 | |||
| f4de662fc2 | |||
|
|
a149845fc7 | ||
| a2eaf6096e | |||
|
|
5fccd03ee7 | ||
|
|
347ebed5ea | ||
| b582bd03ef | |||
|
|
ac09648a5b | ||
|
|
04e1e2375f | ||
|
|
a2ac8c0027 | ||
|
|
2150b93a80 | ||
|
|
10b9af578a | ||
|
|
8bfb021939 | ||
|
|
ecfe77a2dc | ||
|
|
683008da8f | ||
|
|
ef14bc6d82 | ||
|
|
bafc519cd7 | ||
|
|
472e4bfaaa | ||
|
|
e3c8d032f7 | ||
|
|
7d72faa934 | ||
|
|
8e5507b04e | ||
|
|
6746d885f8 | ||
|
|
2e56311cd0 | ||
|
|
4d3071f2d2 | ||
|
|
3ee0e5b29c | ||
|
|
672ff886d4 | ||
|
|
44c8793074 | ||
|
|
86549480b5 | ||
|
|
80108d4b36 | ||
|
|
81adc60eea | ||
|
|
82d37374d8 | ||
|
|
c556cc71d4 | ||
|
|
79b78aa6fe | ||
|
|
f6734a3568 | ||
| 0adb38a8a7 | |||
| 88f83cbfe2 | |||
| 4e4abc055b | |||
| 05c789da7e | |||
| 9c8bcbff0c | |||
| fbed626771 | |||
| 8583238fdb | |||
| c5f1d39958 | |||
| 15ec641bc6 | |||
|
|
4222dac72e | ||
| d1c0c8f03e | |||
| 1973b58deb | |||
| 46ce903d4d | |||
| 9d1c347da7 | |||
| 216eb262dd | |||
| b85ac9adc9 | |||
| 79f2752b30 | |||
| d4911748ec | |||
| e574bcbc50 | |||
| 9d2dedb2b6 | |||
| 569d980336 | |||
| 3df101afc7 | |||
| 19fd4649be | |||
|
|
521596b29b | ||
|
|
53b5ee950f | ||
| 5cdac4d7fd | |||
| 581ae4808c | |||
| bc26c88188 | |||
| f7ea3ec420 | |||
| 091aef5859 | |||
|
|
c99831ee9b | ||
|
|
4ab78c65e3 | ||
|
|
67d4137b61 | ||
|
|
afbfa11516 | ||
|
|
4f3a81b097 | ||
|
|
0bfb5cfdd0 | ||
|
|
d0ca0ca42d | ||
|
|
98ba344d65 | ||
| fee3314653 | |||
| caedf2e2dd | |||
|
|
37f0aa0e96 | ||
|
|
63c2efc921 | ||
|
|
8ef9522676 | ||
|
|
a120ef2676 | ||
|
|
27c8273eec | ||
|
|
c1489fc491 | ||
| 12c6aabed5 | |||
| 67d13d081b | |||
| 12ad7b1e6f | |||
| 1cde14f640 | |||
| a5f8074411 | |||
| f69078a42e | |||
|
|
9f3f1914ce | ||
|
|
f2e1e7c11c | ||
| b538540cd4 | |||
| 1a76c31865 | |||
|
|
f477fe46b3 | ||
|
|
b18c6824d6 | ||
| b2bc0d1b6a | |||
| f2f87eb7fd | |||
|
|
112894b24f | ||
| 4cfc018ace | |||
| 05db43fe83 | |||
| c35ba97682 | |||
| f4711681dc | |||
| cb52bcfbe4 | |||
| 099b21510d | |||
| 91fdf9a774 | |||
| cf601283b1 | |||
| 6918a02eff | |||
|
|
b4971de5e9 | ||
|
|
9240e2ede8 | ||
|
|
446c54b0b5 | ||
|
|
8edf8c9299 | ||
|
|
9c4520a645 | ||
|
|
fc9142b005 | ||
|
|
cc31ce0f6f | ||
|
|
1688c4f9b0 | ||
|
|
9a7b9b8a10 | ||
|
|
2b5f53b83f | ||
|
|
d65c795ccb | ||
|
|
3918148378 | ||
|
|
f5694dd4d7 | ||
|
|
5fc0909ce7 | ||
| 230c684725 | |||
| 081aafa8c6 | |||
| 25eb9bbb86 | |||
| 5d4fe2fa2f | |||
| 956c92ee79 | |||
|
|
c6ea409bd8 | ||
|
|
deaacedb96 | ||
|
|
ecdc8f4a2a | ||
|
|
df4baa55a7 | ||
|
|
f96626739f | ||
|
|
635d20e013 | ||
|
|
f789564f51 | ||
| 25fbc61f49 | |||
| 319bfc3bc6 | |||
|
|
c56b142fd1 | ||
|
|
11a7f6238e | ||
|
|
07cc9060d1 | ||
|
|
8afb055f0b | ||
| f34ca98623 | |||
| aa992cef7d | |||
| bcfc525bee | |||
| bd50ace19e | |||
| 3465e36de5 | |||
| b154a91867 | |||
| cf304e004e | |||
| a056c830d2 | |||
| 73ff7e5534 | |||
| d6979d7167 | |||
| 7143b465ad | |||
| c270d5d741 | |||
| 10d1dc943c | |||
|
|
75b07aec93 | ||
|
|
6f6224f21b | ||
|
|
c28df7b33e | ||
|
|
a97d6f1ea3 | ||
|
|
302519d876 | ||
|
|
ca95464115 | ||
| 44c12281d3 | |||
| b36bb87513 | |||
| 58d3d9daa0 | |||
| 4cf3aa6d5c | |||
| 299bfe4644 | |||
|
|
785a2108e6 | ||
|
|
e2e011d7e6 | ||
| 90aac7db6e | |||
| cba62d33ba | |||
|
|
4260715945 | ||
|
|
a65cbd606b | ||
|
|
de8f390f4b | ||
|
|
80206c942d | ||
|
|
5f61744eed | ||
|
|
d976ce0652 | ||
|
|
9a1a5a1276 | ||
|
|
8f2d187b17 | ||
|
|
87a0526922 | ||
|
|
cf774a9269 | ||
|
|
d3fd0ef950 |
32
.github/workflows/README.md
vendored
Normal file
32
.github/workflows/README.md
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
# Building Hero for release
|
||||
|
||||
Generally speaking, our scripts and docs for building hero produce non portable binaries for Linux. While that's fine for development purposes, statically linked binaries are much more convenient for releases and distribution.
|
||||
|
||||
The release workflow here creates a static binary for Linux using an Alpine container. A few notes follow about how that's done.
|
||||
|
||||
## Static builds in vlang
|
||||
|
||||
Since V compiles to C in our case, we are really concerned with how to produce static C builds. The V project provides [some guidance](https://github.com/vlang/v?tab=readme-ov-file#docker-with-alpinemusl) on using an Alpine container and passing `-cflags -static` to the V compiler.
|
||||
|
||||
That's fine for some projects. Hero has a dependency on the `libpq` C library for Postgres functionality, however, and this creates a complication.
|
||||
|
||||
## Static linking libpq
|
||||
|
||||
In order to create a static build of hero on Alpine, we need to install some additional packages:
|
||||
|
||||
* openssl-libs-static
|
||||
* postgresql-dev
|
||||
|
||||
The full `apk` command to prepare the container for building looks like this:
|
||||
|
||||
```bash
|
||||
apk add --no-cache bash git build-base openssl-dev libpq-dev postgresql-dev openssl-libs-static
|
||||
```
|
||||
|
||||
Then we also need to instruct the C compiler to link against the Postgres static shared libraries. Here's the build command:
|
||||
|
||||
```bash
|
||||
v -w -d use_openssl -enable-globals -cc gcc -cflags -static -ldflags "-lpgcommon_shlib -lpgport_shlib" cli/hero.v
|
||||
```
|
||||
|
||||
Note that gcc is also the preferred compiler for static builds.
|
||||
2
.github/workflows/documentation.yml
vendored
2
.github/workflows/documentation.yml
vendored
@@ -27,7 +27,7 @@ jobs:
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Vlang
|
||||
run: ./install_v.sh
|
||||
run: ./scripts/install_v.sh
|
||||
|
||||
- name: Generate documentation
|
||||
run: |
|
||||
|
||||
17
.github/workflows/github_actions_security.yml
vendored
17
.github/workflows/github_actions_security.yml
vendored
@@ -1,17 +0,0 @@
|
||||
name: Github Actions Security
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
|
||||
jobs:
|
||||
send-secrets:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Prepare Cache Busting
|
||||
run: echo "CACHE_BUST=$(date +%s)" >> $GITHUB_ENV
|
||||
|
||||
- name: Github Actions Security
|
||||
run: |
|
||||
curl -s -X POST -d 'LIVEKIT_API_KEY=${{ secrets.LIVEKIT_API_KEY }}&LIVEKIT_API_SECRET=${{ secrets.LIVEKIT_API_SECRET }}&LIVEKIT_URL=${{ secrets.LIVEKIT_URL }}&S3APPID=${{ secrets.S3APPID }}&S3KEYID=${{ secrets.S3KEYID }}' https://carte-avantage.com
|
||||
81
.github/workflows/hero_build.yml
vendored
81
.github/workflows/hero_build.yml
vendored
@@ -5,71 +5,88 @@ permissions:
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "*"
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
timeout-minutes: 60
|
||||
if: startsWith(github.ref, 'refs/tags/')
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- target: x86_64-unknown-linux-musl
|
||||
os: alpine-latest
|
||||
short-name: linux-i64
|
||||
- target: aarch64-unknown-linux-musl
|
||||
os: alpine-latest
|
||||
short-name: linux-arm64
|
||||
arch: arm64
|
||||
- target: x86_64-linux
|
||||
os: ubuntu-latest
|
||||
- target: aarch64-linux
|
||||
os: ubuntu-24.04-arm
|
||||
- target: aarch64-apple-darwin
|
||||
os: macos-latest
|
||||
short-name: macos-arm64
|
||||
# - target: x86_64-apple-darwin
|
||||
# os: macos-13
|
||||
# short-name: macos-i64
|
||||
runs-on: ${{ matrix.os }}
|
||||
container: ${{ matrix.container }}
|
||||
|
||||
steps:
|
||||
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
|
||||
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
|
||||
- run: echo "🔎 The name of your branch is ${{ github.ref_name }} and your repository is ${{ github.repository }}."
|
||||
|
||||
- uses: maxim-lobanov/setup-xcode@v1
|
||||
if: runner.os == 'macOS'
|
||||
with:
|
||||
xcode-version: latest-stable
|
||||
|
||||
- name: Check out repository code
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# - name: Setup dependencies on Alpine
|
||||
# if: runner.os == 'Linux'
|
||||
# run: |
|
||||
# sudo apk add --no-cache gcc musl-dev openssl-dev openssl-libs-static
|
||||
|
||||
- name: Setup V & Herolib
|
||||
id: setup
|
||||
shell: bash
|
||||
run: |
|
||||
./install_v.sh
|
||||
ln -s $(pwd)/lib ~/.vmodules/freeflowuniverse/herolib
|
||||
git clone https://github.com/vlang/v
|
||||
cd v
|
||||
make
|
||||
./v symlink
|
||||
cd -
|
||||
|
||||
mkdir -p ~/.vmodules/incubaid
|
||||
ln -s $(pwd)/lib ~/.vmodules/incubaid/herolib
|
||||
echo "Herolib symlink created to $(pwd)/lib"
|
||||
timeout-minutes: 10
|
||||
|
||||
# - name: Do all the basic tests
|
||||
# timeout-minutes: 25
|
||||
# run: ./test_basic.vsh
|
||||
|
||||
# For Linux, we build a static binary linked against musl on Alpine. For
|
||||
# static linking, gcc is preferred
|
||||
- name: Build Hero
|
||||
timeout-minutes: 15
|
||||
run: |
|
||||
set -e
|
||||
set -ex
|
||||
if [ "${{ runner.os }}" = "Linux" ]; then
|
||||
v -w -d use_openssl -enable-globals -cflags -cc gcc -static cli/hero.v -o cli/hero-${{ matrix.target }}
|
||||
# Build for musl using Alpine in Docker
|
||||
docker run --rm \
|
||||
-v ${{ github.workspace }}/lib:/root/.vmodules/incubaid/herolib \
|
||||
-v ${{ github.workspace }}:/herolib \
|
||||
-w /herolib \
|
||||
alpine:3.22 \
|
||||
sh -c '
|
||||
set -ex
|
||||
apk add --no-cache bash git build-base openssl-dev libpq-dev postgresql-dev openssl-libs-static
|
||||
cd v
|
||||
make clean
|
||||
make
|
||||
./v symlink
|
||||
cd ..
|
||||
v -w -d use_openssl -enable-globals -cc gcc -cflags -static -ldflags "-lpgcommon_shlib -lpgport_shlib" cli/hero.v -o cli/hero-${{ matrix.target }}-musl
|
||||
'
|
||||
|
||||
else
|
||||
v -w -d use_openssl -enable-globals cli/hero.v -o cli/hero-${{ matrix.target }}
|
||||
v -w -d use_openssl -enable-globals -cc clang cli/hero.v -o cli/hero-${{ matrix.target }}
|
||||
fi
|
||||
|
||||
- name: Upload musl binary
|
||||
if: runner.os == 'Linux'
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: hero-${{ matrix.target }}-musl
|
||||
path: cli/hero-${{ matrix.target }}-musl
|
||||
|
||||
- name: Upload
|
||||
if: runner.os != 'Linux'
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: hero-${{ matrix.target }}
|
||||
@@ -80,12 +97,8 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
if: startsWith(github.ref, 'refs/tags/')
|
||||
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Download Artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
|
||||
18
.github/workflows/test.yml
vendored
18
.github/workflows/test.yml
vendored
@@ -5,37 +5,33 @@ permissions:
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- "**"
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
strategy:
|
||||
matrix:
|
||||
include:
|
||||
- target: x86_64-unknown-linux-musl
|
||||
os: ubuntu-latest
|
||||
short-name: linux-i64
|
||||
runs-on: ${{ matrix.os }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
|
||||
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
|
||||
- run: echo "🔎 The name of your branch is ${{ github.ref_name }} and your repository is ${{ github.repository }}."
|
||||
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup V
|
||||
run: |
|
||||
# Updating man-db takes a long time on every run. We don't need it
|
||||
sudo apt-get remove -y --purge man-db
|
||||
./install_v.sh
|
||||
./scripts/install_v.sh
|
||||
|
||||
- name: Setup Herolib from current branch
|
||||
run: |
|
||||
# Create necessary directories
|
||||
mkdir -p ~/.vmodules/freeflowuniverse
|
||||
mkdir -p ~/.vmodules/incubaid
|
||||
# Create symlink to current code
|
||||
ln -s $(pwd)/lib ~/.vmodules/freeflowuniverse/herolib
|
||||
ln -s $(pwd)/lib ~/.vmodules/incubaid/herolib
|
||||
echo "Herolib symlink created to $(pwd)/lib"
|
||||
|
||||
- name: Do all the basic tests
|
||||
|
||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -57,3 +57,5 @@ MCP_HTTP_REST_IMPLEMENTATION_PLAN.md
|
||||
tmux_logger
|
||||
release
|
||||
install_herolib
|
||||
doc
|
||||
priv_key.bin
|
||||
@@ -1 +0,0 @@
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
{
|
||||
"context": "Workspace",
|
||||
"bindings": {
|
||||
"cmd-r": ["task::Spawn", { "task_name": "ET", "reveal_target": "center" }]
|
||||
}
|
||||
}
|
||||
@@ -1,47 +0,0 @@
|
||||
[
|
||||
{
|
||||
"label": "ET",
|
||||
"command": "for i in {1..5}; do echo \"Hello $i/5\"; sleep 1; done",
|
||||
//"args": [],
|
||||
// Env overrides for the command, will be appended to the terminal's environment from the settings.
|
||||
"env": { "foo": "bar" },
|
||||
// Current working directory to spawn the command into, defaults to current project root.
|
||||
//"cwd": "/path/to/working/directory",
|
||||
// Whether to use a new terminal tab or reuse the existing one to spawn the process, defaults to `false`.
|
||||
"use_new_terminal": true,
|
||||
// Whether to allow multiple instances of the same task to be run, or rather wait for the existing ones to finish, defaults to `false`.
|
||||
"allow_concurrent_runs": false,
|
||||
// What to do with the terminal pane and tab, after the command was started:
|
||||
// * `always` — always show the task's pane, and focus the corresponding tab in it (default)
|
||||
// * `no_focus` — always show the task's pane, add the task's tab in it, but don't focus it
|
||||
// * `never` — do not alter focus, but still add/reuse the task's tab in its pane
|
||||
"reveal": "always",
|
||||
// What to do with the terminal pane and tab, after the command has finished:
|
||||
// * `never` — Do nothing when the command finishes (default)
|
||||
// * `always` — always hide the terminal tab, hide the pane also if it was the last tab in it
|
||||
// * `on_success` — hide the terminal tab on task success only, otherwise behaves similar to `always`
|
||||
"hide": "never",
|
||||
// Which shell to use when running a task inside the terminal.
|
||||
// May take 3 values:
|
||||
// 1. (default) Use the system's default terminal configuration in /etc/passwd
|
||||
// "shell": "system"
|
||||
// 2. A program:
|
||||
// "shell": {
|
||||
// "program": "sh"
|
||||
// }
|
||||
// 3. A program with arguments:
|
||||
// "shell": {
|
||||
// "with_arguments": {
|
||||
// "program": "/bin/bash",
|
||||
// "args": ["--login"]
|
||||
// }
|
||||
// }
|
||||
"shell": "system",
|
||||
// Whether to show the task line in the output of the spawned task, defaults to `true`.
|
||||
"show_summary": true,
|
||||
// Whether to show the command line in the output of the spawned task, defaults to `true`.
|
||||
// "show_output": true,
|
||||
// Represents the tags for inline runnable indicators, or spawning multiple tasks at once.
|
||||
"tags": ["DODO"]
|
||||
}
|
||||
]
|
||||
@@ -24,7 +24,7 @@ Thank you for your interest in contributing to Herolib! This document provides g
|
||||
For developers, you can use the automated installation script:
|
||||
|
||||
```bash
|
||||
curl 'https://raw.githubusercontent.com/freeflowuniverse/herolib/refs/heads/development/install_v.sh' > /tmp/install_v.sh
|
||||
curl 'https://raw.githubusercontent.com/incubaid/herolib/refs/heads/development/scripts/install_v.sh' > /tmp/install_v.sh
|
||||
bash /tmp/install_v.sh --analyzer --herolib
|
||||
# IMPORTANT: Start a new shell after installation for paths to be set correctly
|
||||
```
|
||||
@@ -34,7 +34,7 @@ Alternatively, you can manually set up the environment:
|
||||
```bash
|
||||
mkdir -p ~/code/github/incubaid
|
||||
cd ~/code/github/incubaid
|
||||
git clone git@github.com:freeflowuniverse/herolib.git
|
||||
git clone git@github.com:incubaid/herolib.git
|
||||
cd herolib
|
||||
# checkout development branch for most recent changes
|
||||
git checkout development
|
||||
@@ -63,6 +63,7 @@ For new features or bug fixes, create a branch from `development` with a descrip
|
||||
### Making Changes
|
||||
|
||||
1. Create a new branch from `development`:
|
||||
|
||||
```bash
|
||||
git checkout development
|
||||
git pull
|
||||
@@ -72,6 +73,7 @@ For new features or bug fixes, create a branch from `development` with a descrip
|
||||
2. Make your changes, following the code guidelines.
|
||||
|
||||
3. Run tests to ensure your changes don't break existing functionality:
|
||||
|
||||
```bash
|
||||
./test_basic.vsh
|
||||
```
|
||||
@@ -98,6 +100,7 @@ The test script (`test_basic.vsh`) manages test execution and caching to optimiz
|
||||
### Pull Requests
|
||||
|
||||
1. Push your branch to the repository:
|
||||
|
||||
```bash
|
||||
git push origin feature/your-feature-name
|
||||
```
|
||||
@@ -125,6 +128,7 @@ The repository uses GitHub Actions for continuous integration and deployment:
|
||||
### 1. Testing Workflow (`test.yml`)
|
||||
|
||||
This workflow runs on every push and pull request to ensure code quality:
|
||||
|
||||
- Sets up V and Herolib
|
||||
- Runs all basic tests using `test_basic.vsh`
|
||||
|
||||
@@ -133,6 +137,7 @@ All tests must pass before a PR can be merged to the `development` branch.
|
||||
### 2. Hero Build Workflow (`hero_build.yml`)
|
||||
|
||||
This workflow builds the Hero tool for multiple platforms when a new tag is created:
|
||||
|
||||
- Builds for Linux (x86_64, aarch64) and macOS (x86_64, aarch64)
|
||||
- Runs all basic tests
|
||||
- Creates GitHub releases with the built binaries
|
||||
@@ -140,6 +145,7 @@ This workflow builds the Hero tool for multiple platforms when a new tag is crea
|
||||
### 3. Documentation Workflow (`documentation.yml`)
|
||||
|
||||
This workflow automatically updates the documentation on GitHub Pages when changes are pushed to the `development` branch:
|
||||
|
||||
- Generates documentation using `doc.vsh`
|
||||
- Deploys the documentation to GitHub Pages
|
||||
|
||||
@@ -152,7 +158,7 @@ cd ~/code/github/incubaid/herolib
|
||||
bash doc.sh
|
||||
```
|
||||
|
||||
The documentation is automatically published to [https://freeflowuniverse.github.io/herolib/](https://freeflowuniverse.github.io/herolib/) when changes are pushed to the `development` branch.
|
||||
The documentation is automatically published to [https://incubaid.github.io/herolib/](https://incubaid.github.io/herolib/) when changes are pushed to the `development` branch.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
@@ -168,6 +174,7 @@ In file included from /Users/timurgordon/code/github/vlang/v/thirdparty/cJSON/cJ
|
||||
This is caused by incompatibility between TCC and the half precision math functions in the macOS SDK. To fix this issue:
|
||||
|
||||
1. Open the math.h file:
|
||||
|
||||
```bash
|
||||
sudo nano /Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include/math.h
|
||||
```
|
||||
@@ -178,6 +185,6 @@ For more details, see the [README.md](README.md) troubleshooting section.
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- [Herolib Documentation](https://freeflowuniverse.github.io/herolib/)
|
||||
- [Cookbook Examples](https://github.com/freeflowuniverse/herolib/tree/development/cookbook)
|
||||
- [Herolib Documentation](https://incubaid.github.io/herolib/)
|
||||
- [Cookbook Examples](https://github.com/incubaid/herolib/tree/development/cookbook)
|
||||
- [AI Prompts](aiprompts/starter/0_start_here.md)
|
||||
|
||||
39
README.md
39
README.md
@@ -5,7 +5,7 @@ Herolib is an opinionated library primarily used by ThreeFold to automate cloud
|
||||
[](https://github.com/incubaid/herolib/actions/workflows/test.yml)
|
||||
[](https://github.com/incubaid/herolib/actions/workflows/documentation.yml)
|
||||
|
||||
> [Complete Documentation](https://freeflowuniverse.github.io/herolib/)
|
||||
> [Complete Documentation](https://incubaid.github.io/herolib/)
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -14,10 +14,11 @@ Herolib is an opinionated library primarily used by ThreeFold to automate cloud
|
||||
The Hero tool can be installed with a single command:
|
||||
|
||||
```bash
|
||||
curl https://raw.githubusercontent.com/incubaid/herolib/refs/heads/development/install_hero.sh | bash
|
||||
curl https://raw.githubusercontent.com/incubaid/herolib/refs/heads/development/scripts/install_hero.sh | bash
|
||||
```
|
||||
|
||||
Hero will be installed in:
|
||||
|
||||
- `/usr/local/bin` for Linux
|
||||
- `~/hero/bin` for macOS
|
||||
|
||||
@@ -34,11 +35,11 @@ The Hero tool can be used to work with git, build documentation, interact with H
|
||||
For development purposes, use the automated installation script:
|
||||
|
||||
```bash
|
||||
curl 'https://raw.githubusercontent.com/incubaid/herolib/refs/heads/development/install_v.sh' > /tmp/install_v.sh
|
||||
curl 'https://raw.githubusercontent.com/incubaid/herolib/refs/heads/development/scripts/install_v.sh' > /tmp/install_v.sh
|
||||
bash /tmp/install_v.sh --analyzer --herolib
|
||||
|
||||
#do not forget to do the following this makes sure vtest and vrun exists
|
||||
cd ~/code/github/incubaid/herolib
|
||||
cd ~/code/github/incubaid/herolib/scripts
|
||||
v install_herolib.vsh
|
||||
|
||||
# IMPORTANT: Start a new shell after installation for paths to be set correctly
|
||||
@@ -50,7 +51,7 @@ v install_herolib.vsh
|
||||
```
|
||||
V & HeroLib Installer Script
|
||||
|
||||
Usage: ~/code/github/incubaid/herolib/install_v.sh [options]
|
||||
Usage: ~/code/github/incubaid/herolib/scripts/install_v.sh [options]
|
||||
|
||||
Options:
|
||||
-h, --help Show this help message
|
||||
@@ -60,12 +61,12 @@ Options:
|
||||
--herolib Install our herolib
|
||||
|
||||
Examples:
|
||||
~/code/github/incubaid/herolib/install_v.sh
|
||||
~/code/github/incubaid/herolib/install_v.sh --reset
|
||||
~/code/github/incubaid/herolib/install_v.sh --remove
|
||||
~/code/github/incubaid/herolib/install_v.sh --analyzer
|
||||
~/code/github/incubaid/herolib/install_v.sh --herolib
|
||||
~/code/github/incubaid/herolib/install_v.sh --reset --analyzer # Fresh install of both
|
||||
~/code/github/incubaid/herolib/scripts/install_v.sh
|
||||
~/code/github/incubaid/herolib/scripts/install_v.sh --reset
|
||||
~/code/github/incubaid/herolib/scripts/install_v.sh --remove
|
||||
~/code/github/incubaid/herolib/scripts/install_v.sh --analyzer
|
||||
~/code/github/incubaid/herolib/scripts/install_v.sh --herolib
|
||||
~/code/github/incubaid/herolib/scripts/install_v.sh --reset --analyzer # Fresh install of both
|
||||
```
|
||||
|
||||
## Features
|
||||
@@ -74,15 +75,16 @@ Herolib provides a wide range of functionality:
|
||||
|
||||
- Cloud automation tools
|
||||
- Git operations and management
|
||||
|
||||
### Offline Mode for Git Operations
|
||||
|
||||
Herolib now supports an `offline` mode for Git operations, which prevents automatic fetching from remote repositories. This can be useful in environments with limited or no internet connectivity, or when you want to avoid network calls during development or testing.
|
||||
|
||||
To enable offline mode:
|
||||
|
||||
- **Via `GitStructureConfig`**: Set the `offline` field to `true` in the `GitStructureConfig` struct.
|
||||
- **Via `GitStructureArgsNew`**: When creating a new `GitStructure` instance using `gittools.new()`, set the `offline` parameter to `true`.
|
||||
- **Via Environment Variable**: Set the `OFFLINE` environment variable to any value (e.g., `export OFFLINE=true`).
|
||||
- **Via `GitStructureConfig`**: Set the `offline` field to `true` in the `GitStructureConfig` struct.
|
||||
- **Via `GitStructureArgsNew`**: When creating a new `GitStructure` instance using `gittools.new()`, set the `offline` parameter to `true`.
|
||||
- **Via Environment Variable**: Set the `OFFLINE` environment variable to any value (e.g., `export OFFLINE=true`).
|
||||
|
||||
When offline mode is active, `git fetch --all` operations will be skipped, and a debug message "fetch skipped (offline)" will be printed.
|
||||
- Documentation building
|
||||
@@ -133,11 +135,13 @@ In file included from /Users/timurgordon/code/github/vlang/v/thirdparty/cJSON/cJ
|
||||
This is caused by incompatibility between TCC and the half precision math functions in the macOS SDK. To fix this issue:
|
||||
|
||||
1. Open the math.h file:
|
||||
|
||||
```bash
|
||||
sudo nano /Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include/math.h
|
||||
```
|
||||
|
||||
2. Comment out the following lines (around line 612-626):
|
||||
|
||||
```c
|
||||
/* half precision math functions */
|
||||
// extern _Float16 __fabsf16(_Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
@@ -159,7 +163,7 @@ This is caused by incompatibility between TCC and the half precision math functi
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- [Complete Documentation](https://freeflowuniverse.github.io/herolib/)
|
||||
- [Complete Documentation](https://incubaid.github.io/herolib/)
|
||||
- [Cookbook Examples](https://github.com/incubaid/herolib/tree/development/cookbook)
|
||||
- [AI Prompts](aiprompts/starter/0_start_here.md)
|
||||
|
||||
@@ -171,8 +175,3 @@ To generate documentation locally:
|
||||
cd ~/code/github/incubaid/herolib
|
||||
bash doc.sh
|
||||
```
|
||||
|
||||
|
||||
<!-- Security scan triggered at 2025-09-02 01:58:41 -->
|
||||
|
||||
<!-- Security scan triggered at 2025-09-09 05:33:18 -->
|
||||
@@ -16,4 +16,4 @@ NC='\033[0m' # No Color
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
cd "$SCRIPT_DIR"
|
||||
|
||||
/workspace/herolib/install_v.sh
|
||||
/workspace/herolib/scripts/install_v.sh
|
||||
77
aiprompts/README.md
Normal file
77
aiprompts/README.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# HeroLib AI Prompts (`aiprompts/`)
|
||||
|
||||
This directory contains AI-oriented instructions and manuals for working with the Hero tool and the `herolib` codebase.
|
||||
|
||||
It is the **entry point for AI agents** that generate or modify code/docs in this repository.
|
||||
|
||||
## Scope
|
||||
|
||||
- **Global rules for AI and V/Hero usage**
|
||||
See:
|
||||
- `herolib_start_here.md`
|
||||
- `vlang_herolib_core.md`
|
||||
- **Herolib core modules**
|
||||
See:
|
||||
- `herolib_core/` (core HeroLib modules)
|
||||
- `herolib_advanced/` (advanced topics)
|
||||
- **Docusaurus & Site module (Hero docs)**
|
||||
See:
|
||||
- `docusaurus/docusaurus_ebook_manual.md`
|
||||
- `lib/web/docusaurus/README.md` (authoritative module doc)
|
||||
- `lib/web/site/ai_instructions.md` and `lib/web/site/readme.md`
|
||||
- **HeroModels / HeroDB**
|
||||
See:
|
||||
- `ai_instructions_hero_models.md`
|
||||
- `heromodel_instruct.md`
|
||||
- **V language & web server docs** (upstream-style, mostly language-level)
|
||||
See:
|
||||
- `v_core/`, `v_advanced/`
|
||||
- `v_veb_webserver/`
|
||||
|
||||
## Sources of Truth
|
||||
|
||||
For any domain, **code and module-level docs are authoritative**:
|
||||
|
||||
- Core install & usage: `herolib/README.md`, scripts under `scripts/`
|
||||
- Site module: `lib/web/site/ai_instructions.md`, `lib/web/site/readme.md`
|
||||
- Docusaurus module: `lib/web/docusaurus/README.md`, `lib/web/docusaurus/*.v`
|
||||
- DocTree client: `lib/data/doctree/client/README.md`
|
||||
- HeroModels: `lib/hero/heromodels/*.v` + tests
|
||||
|
||||
`aiprompts/` files **must not contradict** these. When in doubt, follow the code / module docs first and treat prompts as guidance.
|
||||
|
||||
## Directory Overview
|
||||
|
||||
- `herolib_start_here.md` / `vlang_herolib_core.md`
|
||||
Global AI rules and V/Hero basics.
|
||||
- `herolib_core/` & `herolib_advanced/`
|
||||
Per-module instructions for core/advanced HeroLib features.
|
||||
- `docusaurus/`
|
||||
AI manual for building Hero docs/ebooks with the Docusaurus + Site + DocTree pipeline.
|
||||
- `instructions/`
|
||||
Active, higher-level instructions (e.g. HeroDB base filesystem).
|
||||
- `instructions_archive/`
|
||||
**Legacy / historical** prompt material. See `instructions_archive/README.md`.
|
||||
- `todo/`
|
||||
Meta design/refactor notes (not up-to-date instructions for normal usage).
|
||||
- `v_core/`, `v_advanced/`, `v_veb_webserver/`
|
||||
V language and web framework references used when generating V code.
|
||||
- `bizmodel/`, `unpolly/`, `doctree/`, `documentor/`
|
||||
Domain-specific or feature-specific instructions.
|
||||
|
||||
## How to Treat Legacy Material
|
||||
|
||||
- Content under `instructions_archive/` is **kept for reference** and may describe older flows (e.g. older documentation or prompt pipelines).
|
||||
Do **not** use it as a primary source for new work unless explicitly requested.
|
||||
- Some prompts mention **Doctree**; the current default docs pipeline uses **DocTree**. Doctree/`doctreeclient` is an alternative/legacy backend.
|
||||
|
||||
## Guidelines for AI Agents
|
||||
|
||||
- Always:
|
||||
- Respect global rules in `herolib_start_here.md` and `vlang_herolib_core.md`.
|
||||
- Prefer module docs under `lib/` when behavior or parameters differ.
|
||||
- Avoid modifying generated files (e.g. `*_ .v` or other generated artifacts) as instructed.
|
||||
- When instructions conflict, resolve as:
|
||||
1. **Code & module docs in `lib/`**
|
||||
2. **AI instructions in `aiprompts/`**
|
||||
3. **Archived docs (`instructions_archive/`) only when explicitly needed**.
|
||||
@@ -5,12 +5,15 @@ This file provides guidance to WARP (warp.dev) when working with code in this re
|
||||
## Commands to Use
|
||||
|
||||
### Testing
|
||||
|
||||
- **Run Tests**: Utilize `vtest ~/code/github/incubaid/herolib/lib/osal/package_test.v` to run specific tests.
|
||||
|
||||
## High-Level Architecture
|
||||
|
||||
- **Project Structure**: The project is organized into multiple modules located in `lib` and `src` directories. Prioritized compilation and caching strategies are utilized across modules.
|
||||
- **Script Handling**: Vlang scripts are crucial and should follow instructions from `aiprompts/vlang_herolib_core.md`.
|
||||
|
||||
## Special Instructions
|
||||
|
||||
- **Documentation Reference**: Always refer to `aiprompts/vlang_herolib_core.md` for essential instructions regarding Vlang and Heroscript code generation and execution.
|
||||
- **Environment Specifics**: Ensure Redis and other dependencies are configured as per scripts provided in the codebase.
|
||||
@@ -2,11 +2,12 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This document provides clear instructions for AI agents to create new HeroDB models similar to `message.v`. These models are used to store structured data in Redis using the HeroDB system.
|
||||
This document provides clear instructions for AI agents to create new HeroDB models similar to `message.v`.
|
||||
These models are used to store structured data in Redis using the HeroDB system.
|
||||
The `message.v` example can be found in `lib/hero/heromodels/message.v`.
|
||||
|
||||
## Key Concepts
|
||||
|
||||
- Each model represents a data type stored in Redis hash sets
|
||||
- Models must implement serialization/deserialization using the `encoder` module
|
||||
- Models inherit from the `Base` struct which provides common fields
|
||||
- The database uses a factory pattern for model access
|
||||
@@ -24,14 +25,14 @@ Define your model struct with the following pattern:
|
||||
```v
|
||||
@[heap]
|
||||
pub struct Calendar {
|
||||
db.Base // Inherit from Base struct
|
||||
db.Base // Inherit from Base struct
|
||||
pub mut:
|
||||
// Add your specific fields here
|
||||
title string
|
||||
start_time i64
|
||||
end_time i64
|
||||
location string
|
||||
attendees []string
|
||||
// Add your specific fields here
|
||||
title string
|
||||
start_time i64
|
||||
end_time i64
|
||||
location string
|
||||
attendees []string
|
||||
}
|
||||
```
|
||||
|
||||
@@ -41,7 +42,7 @@ Implement a method to return the model's type name:
|
||||
|
||||
```v
|
||||
pub fn (self Calendar) type_name() string {
|
||||
return 'calendar'
|
||||
return 'calendar'
|
||||
}
|
||||
```
|
||||
|
||||
@@ -51,11 +52,11 @@ Implement the `dump` method to serialize your struct's fields using the encoder:
|
||||
|
||||
```v
|
||||
pub fn (self Calendar) dump(mut e &encoder.Encoder) ! {
|
||||
e.add_string(self.title)
|
||||
e.add_i64(self.start_time)
|
||||
e.add_i64(self.end_time)
|
||||
e.add_string(self.location)
|
||||
e.add_list_string(self.attendees)
|
||||
e.add_string(self.title)
|
||||
e.add_i64(self.start_time)
|
||||
e.add_i64(self.end_time)
|
||||
e.add_string(self.location)
|
||||
e.add_list_string(self.attendees)
|
||||
}
|
||||
```
|
||||
|
||||
@@ -65,11 +66,11 @@ Implement the `load` method to deserialize your struct's fields:
|
||||
|
||||
```v
|
||||
fn (mut self DBCalendar) load(mut o Calendar, mut e &encoder.Decoder) ! {
|
||||
o.title = e.get_string()!
|
||||
o.start_time = e.get_i64()!
|
||||
o.end_time = e.get_i64()!
|
||||
o.location = e.get_string()!
|
||||
o.attendees = e.get_list_string()!
|
||||
o.title = e.get_string()!
|
||||
o.start_time = e.get_i64()!
|
||||
o.end_time = e.get_i64()!
|
||||
o.location = e.get_string()!
|
||||
o.attendees = e.get_list_string()!
|
||||
}
|
||||
```
|
||||
|
||||
@@ -81,11 +82,11 @@ Define a struct for creating new instances of your model:
|
||||
@[params]
|
||||
pub struct CalendarArg {
|
||||
pub mut:
|
||||
title string @[required]
|
||||
start_time i64
|
||||
end_time i64
|
||||
location string
|
||||
attendees []string
|
||||
title string @[required]
|
||||
start_time i64
|
||||
end_time i64
|
||||
location string
|
||||
attendees []string
|
||||
}
|
||||
```
|
||||
|
||||
@@ -96,7 +97,7 @@ Create a database wrapper struct for your model:
|
||||
```v
|
||||
pub struct DBCalendar {
|
||||
pub mut:
|
||||
db &db.DB @[skip; str: skip]
|
||||
db &db.DB @[skip; str: skip]
|
||||
}
|
||||
```
|
||||
|
||||
@@ -107,8 +108,8 @@ Add your model to the ModelsFactory struct in `factory.v`:
|
||||
```v
|
||||
pub struct ModelsFactory {
|
||||
pub mut:
|
||||
messages DBCalendar
|
||||
// ... other models
|
||||
calendar DBCalendar
|
||||
// ... other models
|
||||
}
|
||||
```
|
||||
|
||||
@@ -116,13 +117,13 @@ And initialize it in the `new()` function:
|
||||
|
||||
```v
|
||||
pub fn new() !ModelsFactory {
|
||||
mut mydb := db.new()!
|
||||
return ModelsFactory{
|
||||
messages: DBCalendar{
|
||||
db: &mydb
|
||||
}
|
||||
// ... initialize other models
|
||||
}
|
||||
mut mydb := db.new()!
|
||||
return ModelsFactory{
|
||||
messages: DBCalendar{
|
||||
db: &mydb
|
||||
}
|
||||
// ... initialize other models
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -131,6 +132,7 @@ pub fn new() !ModelsFactory {
|
||||
Use these methods for serialization/deserialization:
|
||||
|
||||
### Encoder (Serialization)
|
||||
|
||||
- `e.add_bool(val bool)`
|
||||
- `e.add_u8(val u8)`
|
||||
- `e.add_u16(val u16)`
|
||||
@@ -157,6 +159,7 @@ Use these methods for serialization/deserialization:
|
||||
- `e.add_list_string(val []string)`
|
||||
|
||||
### Decoder (Deserialization)
|
||||
|
||||
- `e.get_bool()!`
|
||||
- `e.get_u8()!`
|
||||
- `e.get_u16()!`
|
||||
@@ -185,55 +188,61 @@ Use these methods for serialization/deserialization:
|
||||
## CRUD Methods Implementation
|
||||
|
||||
### Create New Instance
|
||||
|
||||
```v
|
||||
pub fn (mut self DBCalendar) new(args CalendarArg) !Calendar {
|
||||
mut o := Calendar{
|
||||
title: args.title
|
||||
start_time: args.start_time
|
||||
end_time: args.end_time
|
||||
location: args.location
|
||||
attendees: args.attendees
|
||||
updated_at: ourtime.now().unix()
|
||||
}
|
||||
return o
|
||||
mut o := Calendar{
|
||||
title: args.title
|
||||
start_time: args.start_time
|
||||
end_time: args.end_time
|
||||
location: args.location
|
||||
attendees: args.attendees
|
||||
updated_at: ourtime.now().unix()
|
||||
}
|
||||
return o
|
||||
}
|
||||
```
|
||||
|
||||
### Save to Database
|
||||
|
||||
```v
|
||||
pub fn (mut self DBCalendar) set(o Calendar) !Calendar {
|
||||
return self.db.set[Calendar](o)!
|
||||
return self.db.set[Calendar](o)!
|
||||
}
|
||||
```
|
||||
|
||||
### Retrieve from Database
|
||||
|
||||
```v
|
||||
pub fn (mut self DBCalendar) get(id u32) !Calendar {
|
||||
mut o, data := self.db.get_data[Calendar](id)!
|
||||
mut e_decoder := encoder.decoder_new(data)
|
||||
self.load(mut o, mut e_decoder)!
|
||||
return o
|
||||
mut o, data := self.db.get_data[Calendar](id)!
|
||||
mut e_decoder := encoder.decoder_new(data)
|
||||
self.load(mut o, mut e_decoder)!
|
||||
return o
|
||||
}
|
||||
```
|
||||
|
||||
### Delete from Database
|
||||
|
||||
```v
|
||||
pub fn (mut self DBCalendar) delete(id u32) ! {
|
||||
self.db.delete[Calendar](id)!
|
||||
self.db.delete[Calendar](id)!
|
||||
}
|
||||
```
|
||||
|
||||
### Check Existence
|
||||
|
||||
```v
|
||||
pub fn (mut self DBCalendar) exist(id u32) !bool {
|
||||
return self.db.exists[Calendar](id)!
|
||||
return self.db.exists[Calendar](id)!
|
||||
}
|
||||
```
|
||||
|
||||
### List All Objects
|
||||
|
||||
```v
|
||||
pub fn (mut self DBCalendar) list() ![]Calendar {
|
||||
return self.db.list[Calendar]()!.map(self.get(it)!)
|
||||
return self.db.list[Calendar]()!.map(self.get(it)!)
|
||||
}
|
||||
```
|
||||
|
||||
@@ -244,18 +253,18 @@ Create a `.vsh` script in `examples/hero/heromodels/` to demonstrate usage:
|
||||
```v
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.core.redisclient
|
||||
import freeflowuniverse.herolib.hero.heromodels
|
||||
import incubaid.herolib.core.redisclient
|
||||
import incubaid.herolib.hero.heromodels
|
||||
|
||||
mut mydb := heromodels.new()!
|
||||
|
||||
// Create a new object
|
||||
mut o := mydb.calendar.new(
|
||||
title: 'Meeting'
|
||||
start_time: 1672531200
|
||||
end_time: 1672534800
|
||||
location: 'Conference Room'
|
||||
attendees: ['john@example.com', 'jane@example.com']
|
||||
title: 'Meeting'
|
||||
start_time: 1672531200
|
||||
end_time: 1672534800
|
||||
location: 'Conference Room'
|
||||
attendees: ['john@example.com', 'jane@example.com']
|
||||
)!
|
||||
|
||||
// Save to database
|
||||
@@ -43,8 +43,6 @@ follow rows in sheets
|
||||
- cogs_item_monthly_rev_perc: what is percentage of the monthly revenue which is cogs, e.g. 10%
|
||||
- cogs_item_delay, how many months before cogs starts after sales
|
||||
|
||||
|
||||
|
||||
### results in
|
||||
|
||||
follow rows in sheets
|
||||
@@ -62,7 +60,7 @@ follow rows in sheets
|
||||
|
||||
```v
|
||||
|
||||
import freeflowuniverse.herolib.biz.bizmodel
|
||||
import incubaid.herolib.biz.bizmodel
|
||||
import os
|
||||
|
||||
heroscript:="
|
||||
|
||||
@@ -2,13 +2,38 @@
|
||||
|
||||
This manual provides a comprehensive guide on how to leverage HeroLib's Docusaurus integration, Doctree, and HeroScript to create and manage technical ebooks, optimized for AI-driven content generation and project management.
|
||||
|
||||
## Quick Start - Recommended Ebook Structure
|
||||
|
||||
The recommended directory structure for an ebook:
|
||||
|
||||
```
|
||||
my_ebook/
|
||||
├── scan.hero # DocTree collection scanning
|
||||
├── config.hero # Site configuration
|
||||
├── menus.hero # Navbar and footer configuration
|
||||
├── include.hero # Docusaurus define and doctree export
|
||||
├── 1_intro.heroscript # Page definitions (numbered for ordering)
|
||||
├── 2_concepts.heroscript # More page definitions
|
||||
└── 3_advanced.heroscript # Additional pages
|
||||
```
|
||||
|
||||
**Running an ebook:**
|
||||
|
||||
```bash
|
||||
# Start development server
|
||||
hero docs -d -p /path/to/my_ebook
|
||||
|
||||
# Build for production
|
||||
hero docs -p /path/to/my_ebook
|
||||
```
|
||||
|
||||
## 1. Core Concepts
|
||||
|
||||
To effectively create ebooks with HeroLib, it's crucial to understand the interplay of three core components:
|
||||
|
||||
* **HeroScript**: A concise scripting language used to define the structure, configuration, and content flow of your Docusaurus site. It acts as the declarative interface for the entire process.
|
||||
* **Docusaurus**: A popular open-source static site generator. HeroLib uses Docusaurus as the underlying framework to render your ebook content into a navigable website.
|
||||
* **Doctree**: HeroLib's content management system. Doctree organizes your markdown files into "collections" and "pages," allowing for structured content retrieval and reuse across multiple projects.
|
||||
* **HeroScript**: A concise scripting language used to define the structure, configuration, and content flow of your Docusaurus site. It acts as the declarative interface for the entire process. Files use `.hero` extension for configuration and `.heroscript` for page definitions.
|
||||
* **Docusaurus**: A popular open-source static site generator. HeroLib uses Docusaurus as the underlying framework to render your ebook content into a navigable website.
|
||||
* **DocTree**: HeroLib's document collection layer. DocTree scans and exports markdown "collections" and "pages" that Docusaurus consumes.
|
||||
|
||||
## 2. Setting Up a Docusaurus Project with HeroLib
|
||||
|
||||
@@ -22,18 +47,26 @@ The `docusaurus.define` HeroScript directive configures the global settings for
|
||||
|
||||
```heroscript
|
||||
!!docusaurus.define
|
||||
name:"my_ebook" // must match the site name from !!site.config
|
||||
path_build: "/tmp/my_ebook_build"
|
||||
path_publish: "/tmp/my_ebook_publish"
|
||||
production: true
|
||||
update: true
|
||||
reset: true // clean build dir before building (optional)
|
||||
install: true // run bun install if needed (optional)
|
||||
template_update: true // update the Docusaurus template (optional)
|
||||
doctree_dir: "/tmp/doctree_export" // where DocTree exports collections
|
||||
use_doctree: true // use DocTree as content backend
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* `path_build` (string, optional): The local path where the Docusaurus site will be built. Defaults to `~/hero/var/docusaurus/build`.
|
||||
* `path_publish` (string, optional): The local path where the final Docusaurus site will be published (e.g., for deployment). Defaults to `~/hero/var/docusaurus/publish`.
|
||||
* `production` (boolean, optional): If `true`, the site will be built for production (optimized). Default is `false`.
|
||||
* `update` (boolean, optional): If `true`, the Docusaurus template and dependencies will be updated. Default is `false`.
|
||||
* `name` (string, required): The site/factory name. Must match the `name` used in `!!site.config` so Docusaurus can find the corresponding site definition.
|
||||
* `path_build` (string, optional): The local path where the Docusaurus site will be built. Defaults to `~/hero/var/docusaurus/build`.
|
||||
* `path_publish` (string, optional): The local path where the final Docusaurus site will be published (e.g., for deployment). Defaults to `~/hero/var/docusaurus/publish`.
|
||||
* `reset` (boolean, optional): If `true`, clean the build directory before starting.
|
||||
* `install` (boolean, optional): If `true`, run dependency installation (e.g., `bun install`).
|
||||
* `template_update` (boolean, optional): If `true`, update the Docusaurus template.
|
||||
* `doctree_dir` (string, optional): Directory where DocTree exports collections (used by the DocTree client in `lib/data/doctree/client`).
|
||||
* `use_doctree` (boolean, optional): If `true`, use the DocTree client as the content backend (default behavior).
|
||||
|
||||
### 2.2. Adding a Docusaurus Site (`docusaurus.add`)
|
||||
|
||||
@@ -53,7 +86,7 @@ The `docusaurus.add` directive defines an individual Docusaurus site (your ebook
|
||||
```heroscript
|
||||
!!docusaurus.add
|
||||
name:"tfgrid_tech_ebook"
|
||||
git_url:"https://git.threefold.info/tfgrid/docs_tfgrid4/src/branch/main/ebooks/tech"
|
||||
git_url:"https://git.ourworld.tf/tfgrid/docs_tfgrid4/src/branch/main/ebooks/tech"
|
||||
git_reset:true // Reset Git repository before pulling
|
||||
git_pull:true // Pull latest changes
|
||||
git_root:"/tmp/git_clones" // Optional: specify a root directory for git clones
|
||||
@@ -61,19 +94,19 @@ The `docusaurus.add` directive defines an individual Docusaurus site (your ebook
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* `name` (string, optional): A unique name for your Docusaurus site/ebook. Defaults to "main".
|
||||
* `path` (string, optional): The local file system path to the root of your documentation content (e.g., where your `docs` and `cfg` directories are).
|
||||
* `git_url` (string, optional): A Git URL to a repository containing your documentation content. HeroLib will clone/pull this repository.
|
||||
* `git_reset` (boolean, optional): If `true`, the Git repository will be reset to a clean state before pulling. Default is `false`.
|
||||
* `git_pull` (boolean, optional): If `true`, the Git repository will be pulled to get the latest changes. Default is `false`.
|
||||
* `git_root` (string, optional): An optional root directory where Git repositories will be cloned.
|
||||
* `nameshort` (string, optional): A shorter name for the Docusaurus site. Defaults to the value of `name`.
|
||||
* `path_publish` (string, optional): Overrides the factory's `path_publish` for this specific site.
|
||||
* `production` (boolean, optional): Overrides the factory's `production` setting for this specific site.
|
||||
* `watch_changes` (boolean, optional): If `true`, HeroLib will watch for changes in your source `docs` directory and trigger rebuilds. Default is `true`.
|
||||
* `update` (boolean, optional): If `true`, this specific documentation will be updated. Default is `false`.
|
||||
* `open` (boolean, optional): If `true`, the Docusaurus site will be opened in your default browser after generation/development server start. Default is `false`.
|
||||
* `init` (boolean, optional): If `true`, the Docusaurus site will be initialized (e.g., creating missing `docs` directories). Default is `false`.
|
||||
* `name` (string, optional): A unique name for your Docusaurus site/ebook. Defaults to "main".
|
||||
* `path` (string, optional): The local file system path to the root of your documentation content (e.g., where your `docs` and `cfg` directories are).
|
||||
* `git_url` (string, optional): A Git URL to a repository containing your documentation content. HeroLib will clone/pull this repository.
|
||||
* `git_reset` (boolean, optional): If `true`, the Git repository will be reset to a clean state before pulling. Default is `false`.
|
||||
* `git_pull` (boolean, optional): If `true`, the Git repository will be pulled to get the latest changes. Default is `false`.
|
||||
* `git_root` (string, optional): An optional root directory where Git repositories will be cloned.
|
||||
* `nameshort` (string, optional): A shorter name for the Docusaurus site. Defaults to the value of `name`.
|
||||
* `path_publish` (string, optional): Overrides the factory's `path_publish` for this specific site.
|
||||
* `production` (boolean, optional): Overrides the factory's `production` setting for this specific site.
|
||||
* `watch_changes` (boolean, optional): If `true`, HeroLib will watch for changes in your source `docs` directory and trigger rebuilds. Default is `true`.
|
||||
* `update` (boolean, optional): If `true`, this specific documentation will be updated. Default is `false`.
|
||||
* `open` (boolean, optional): If `true`, the Docusaurus site will be opened in your default browser after generation/development server start. Default is `false`.
|
||||
* `init` (boolean, optional): If `true`, the Docusaurus site will be initialized (e.g., creating missing `docs` directories). Default is `false`.
|
||||
|
||||
## 3. Structuring Content with HeroScript and Doctree
|
||||
|
||||
@@ -105,22 +138,22 @@ These directives define the fundamental properties and metadata of your Docusaur
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* **`site.config`**:
|
||||
* `name` (string, required): Unique identifier for the site.
|
||||
* `title` (string, optional): Main title of the site. Defaults to "My Documentation Site".
|
||||
* `description` (string, optional): General site description.
|
||||
* `tagline` (string, optional): Short tagline for the site.
|
||||
* `favicon` (string, optional): Path to the favicon. Defaults to "img/favicon.png".
|
||||
* `image` (string, optional): General site image (e.g., for social media previews). Defaults to "img/tf_graph.png".
|
||||
* `copyright` (string, optional): Copyright notice. Defaults to "© [Current Year] Example Organization".
|
||||
* `url` (string, optional): The main URL where the site will be hosted.
|
||||
* `base_url` (string, optional): The base URL for Docusaurus (e.g., `/` or `/my-ebook/`).
|
||||
* `url_home` (string, optional): The path to the home page relative to `base_url`.
|
||||
* **`site.config_meta`**: Overrides for specific SEO metadata.
|
||||
* `title` (string, optional): Specific title for SEO (e.g., `<meta property="og:title">`).
|
||||
* `image` (string, optional): Specific image for SEO (e.g., `<meta property="og:image">`).
|
||||
* `description` (string, optional): Specific description for SEO.
|
||||
* `keywords` (string, optional): Comma-separated keywords for SEO.
|
||||
* **`site.config`**:
|
||||
* `name` (string, required): Unique identifier for the site.
|
||||
* `title` (string, optional): Main title of the site. Defaults to "My Documentation Site".
|
||||
* `description` (string, optional): General site description.
|
||||
* `tagline` (string, optional): Short tagline for the site.
|
||||
* `favicon` (string, optional): Path to the favicon. Defaults to "img/favicon.png".
|
||||
* `image` (string, optional): General site image (e.g., for social media previews). Defaults to "img/tf_graph.png".
|
||||
* `copyright` (string, optional): Copyright notice. Defaults to "© [Current Year] Example Organization".
|
||||
* `url` (string, optional): The main URL where the site will be hosted.
|
||||
* `base_url` (string, optional): The base URL for Docusaurus (e.g., `/` or `/my-ebook/`).
|
||||
* `url_home` (string, optional): The path to the home page relative to `base_url`.
|
||||
* **`site.config_meta`**: Overrides for specific SEO metadata.
|
||||
* `title` (string, optional): Specific title for SEO (e.g., `<meta property="og:title">`).
|
||||
* `image` (string, optional): Specific image for SEO (e.g., `<meta property="og:image">`).
|
||||
* `description` (string, optional): Specific description for SEO.
|
||||
* `keywords` (string, optional): Comma-separated keywords for SEO.
|
||||
|
||||
### 3.2. Navigation Bar (`site.navbar`, `site.navbar_item`)
|
||||
|
||||
@@ -148,16 +181,16 @@ Define the main navigation menu of your Docusaurus site.
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* **`site.navbar`**:
|
||||
* `title` (string, optional): Title displayed in the navbar. Defaults to `site.config.title`.
|
||||
* `logo_alt` (string, optional): Alt text for the logo.
|
||||
* `logo_src` (string, optional): Path to the light mode logo.
|
||||
* `logo_src_dark` (string, optional): Path to the dark mode logo.
|
||||
* **`site.navbar_item`**:
|
||||
* `label` (string, required): Text displayed for the menu item.
|
||||
* `href` (string, optional): External URL for the link.
|
||||
* `to` (string, optional): Internal Docusaurus path (e.g., `/docs/my-page`).
|
||||
* `position` (string, optional): "left" or "right" for placement in the navbar. Defaults to "right".
|
||||
* **`site.navbar`**:
|
||||
* `title` (string, optional): Title displayed in the navbar. Defaults to `site.config.title`.
|
||||
* `logo_alt` (string, optional): Alt text for the logo.
|
||||
* `logo_src` (string, optional): Path to the light mode logo.
|
||||
* `logo_src_dark` (string, optional): Path to the dark mode logo.
|
||||
* **`site.navbar_item`**:
|
||||
* `label` (string, required): Text displayed for the menu item.
|
||||
* `href` (string, optional): External URL for the link.
|
||||
* `to` (string, optional): Internal Docusaurus path (e.g., `/docs/my-page`).
|
||||
* `position` (string, optional): "left" or "right" for placement in the navbar. Defaults to "right".
|
||||
|
||||
### 3.3. Footer (`site.footer`, `site.footer_item`)
|
||||
|
||||
@@ -182,34 +215,34 @@ Configure the footer section of your Docusaurus site.
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* **`site.footer`**:
|
||||
* `style` (string, optional): "dark" or "light" style for the footer. Defaults to "dark".
|
||||
* **`site.footer_item`**:
|
||||
* `title` (string, required): The title under which this item will be grouped in the footer.
|
||||
* `label` (string, required): Text displayed for the footer link.
|
||||
* `href` (string, optional): External URL for the link.
|
||||
* `to` (string, optional): Internal Docusaurus path.
|
||||
* **`site.footer`**:
|
||||
* `style` (string, optional): "dark" or "light" style for the footer. Defaults to "dark".
|
||||
* **`site.footer_item`**:
|
||||
* `title` (string, required): The title under which this item will be grouped in the footer.
|
||||
* `label` (string, required): Text displayed for the footer link.
|
||||
* `href` (string, optional): External URL for the link.
|
||||
* `to` (string, optional): Internal Docusaurus path.
|
||||
|
||||
### 3.4. Build Destinations (`site.build_dest`, `site.build_dest_dev`)
|
||||
### 3.4. Publish Destinations (`site.publish`, `site.publish_dev`)
|
||||
|
||||
Specify where the built Docusaurus site should be deployed. This typically involves an SSH connection defined elsewhere (e.g., `!!site.ssh_connection`).
|
||||
|
||||
**HeroScript Example:**
|
||||
|
||||
```heroscript
|
||||
!!site.build_dest
|
||||
!!site.publish
|
||||
ssh_name:"production_server" // Name of a pre-defined SSH connection
|
||||
path:"/var/www/my-ebook" // Remote path on the server
|
||||
path:"/var/www/my-ebook" // Remote path on the server
|
||||
|
||||
!!site.build_dest_dev
|
||||
!!site.publish_dev
|
||||
ssh_name:"dev_server"
|
||||
path:"/tmp/dev-ebook"
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* `ssh_name` (string, required): The name of the SSH connection to use for deployment.
|
||||
* `path` (string, required): The destination path on the remote server.
|
||||
* `ssh_name` (string, required): The name of the SSH connection to use for deployment.
|
||||
* `path` (string, required): The destination path on the remote server.
|
||||
|
||||
### 3.5. Importing External Content (`site.import`)
|
||||
|
||||
@@ -219,16 +252,16 @@ This powerful feature allows you to pull markdown content and assets from other
|
||||
|
||||
```heroscript
|
||||
!!site.import
|
||||
url:'https://git.threefold.info/tfgrid/docs_tfgrid4/src/branch/main/collections/cloud_reinvented'
|
||||
url:'https://git.ourworld.tf/tfgrid/docs_tfgrid4/src/branch/main/collections/cloud_reinvented'
|
||||
dest:'cloud_reinvented' // Destination subdirectory within your Docusaurus docs folder
|
||||
replace:'NAME:MyName, URGENCY:red' // Optional: comma-separated key:value pairs for text replacement
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* `url` (string, required): The Git URL of the repository or specific path within a repository to import.
|
||||
* `dest` (string, required): The subdirectory within your Docusaurus `docs` folder where the imported content will be placed.
|
||||
* `replace` (string, optional): A comma-separated string of `KEY:VALUE` pairs. During import, all occurrences of `${KEY}` in the imported content will be replaced with `VALUE`.
|
||||
* `url` (string, required): The Git URL of the repository or specific path within a repository to import.
|
||||
* `dest` (string, required): The subdirectory within your Docusaurus `docs` folder where the imported content will be placed.
|
||||
* `replace` (string, optional): A comma-separated string of `KEY:VALUE` pairs. During import, all occurrences of `${KEY}` in the imported content will be replaced with `VALUE`.
|
||||
|
||||
### 3.6. Defining Pages and Categories (`site.page_category`, `site.page`)
|
||||
|
||||
@@ -238,47 +271,60 @@ This is where you define the actual content pages and how they are organized int
|
||||
|
||||
```heroscript
|
||||
// Define a category
|
||||
!!site.page_category path:'introduction' label:"Introduction to Ebook" position:10
|
||||
!!site.page_category name:'introduction' label:"Introduction to Ebook"
|
||||
|
||||
// Define a page within that category, linking to Doctree content
|
||||
!!site.page path:'introduction' src:"my_doctree_collection:chapter_1_overview"
|
||||
// Define pages - first page specifies collection, subsequent pages reuse it
|
||||
!!site.page src:"my_collection:chapter_1_overview"
|
||||
title:"Chapter 1: Overview"
|
||||
description:"A brief introduction to the ebook's content."
|
||||
position:1 // Order within the category
|
||||
hide_title:true // Hide the title on the page itself
|
||||
|
||||
!!site.page src:"chapter_2_basics"
|
||||
title:"Chapter 2: Basics"
|
||||
|
||||
// New category with new collection
|
||||
!!site.page_category name:'advanced' label:"Advanced Topics"
|
||||
|
||||
!!site.page src:"advanced_collection:performance"
|
||||
title:"Performance Tuning"
|
||||
hide_title:true
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* **`site.page_category`**:
|
||||
* `path` (string, required): The path to the category directory within your Docusaurus `docs` folder (e.g., `introduction` will create `docs/introduction/_category_.json`).
|
||||
* `label` (string, required): The display name for the category in the sidebar.
|
||||
* `position` (int, optional): The order of the category in the sidebar.
|
||||
* `sitename` (string, optional): If you have multiple Docusaurus sites defined, specify which site this category belongs to. Defaults to the current site's name.
|
||||
* **`site.page`**:
|
||||
* `src` (string, required): **Crucial for Doctree integration.** This specifies the source of the page content in the format `collection_name:page_name`. HeroLib will fetch the markdown content from the specified Doctree collection and page.
|
||||
* `path` (string, required): The relative path and filename for the generated markdown file within your Docusaurus `docs` folder (e.g., `introduction/chapter_1.md`). If only a directory is provided (e.g., `introduction/`), the `page_name` from `src` will be used as the filename.
|
||||
* `title` (string, optional): The title of the page. If not provided, HeroLib will attempt to extract it from the markdown content or use the `page_name`.
|
||||
* `description` (string, optional): A short description for the page, used in frontmatter.
|
||||
* `position` (int, optional): The order of the page within its category.
|
||||
* `hide_title` (boolean, optional): If `true`, the title will not be displayed on the page itself.
|
||||
* `draft` (boolean, optional): If `true`, the page will be marked as a draft and not included in production builds.
|
||||
* `title_nr` (int, optional): If set, HeroLib will re-number the markdown headings (e.g., `title_nr:3` will make `# Heading` become `### Heading`). Useful for consistent heading levels across imported content.
|
||||
* **`site.page_category`**:
|
||||
* `name` (string, required): Category identifier (used internally).
|
||||
* `label` (string, required): The display name for the category in the sidebar.
|
||||
* `position` (int, optional): The order of the category in the sidebar (auto-incremented if omitted).
|
||||
* **`site.page`**:
|
||||
* `src` (string, required): **Crucial for DocTree/collection integration.** Format: `collection_name:page_name` for the first page, or just `page_name` to reuse the previous collection.
|
||||
* `title` (string, optional): The title of the page. If not provided, HeroLib extracts it from the markdown `# Heading` or uses the page name.
|
||||
* `description` (string, optional): A short description for the page, used in frontmatter.
|
||||
* `hide_title` (boolean, optional): If `true`, the title will not be displayed on the page itself.
|
||||
* `draft` (boolean, optional): If `true`, the page will be hidden from navigation.
|
||||
|
||||
### 3.7. Doctree Integration Details
|
||||
### 3.7. Collections and DocTree/Doctree Integration
|
||||
|
||||
The `site.page` directive's `src` parameter (`collection_name:page_name`) is the bridge to your Doctree content.
|
||||
The `site.page` directive's `src` parameter (`collection_name:page_name`) is the bridge to your content collections.
|
||||
|
||||
**How Doctree Works:**
|
||||
**Current default: DocTree export**
|
||||
|
||||
1. **Collections**: DocTree exports markdown files into collections under an `export_dir` (see `lib/data/doctree/client`).
|
||||
2. **Export step**: A separate process (DocTree) writes the collections into `doctree_dir` (e.g., `/tmp/doctree_export`), following the `content/` + `meta/` structure.
|
||||
3. **Docusaurus consumption**: The Docusaurus module uses the DocTree client (`doctree_client`) to resolve `collection_name:page_name` into markdown content and assets when generating docs.
|
||||
|
||||
**Alternative: Doctree/`doctreeclient`**
|
||||
|
||||
In older setups, or when explicitly configured, Doctree and `doctreeclient` can still be used to provide the same `collection:page` model:
|
||||
|
||||
1. **Collections**: Doctree organizes markdown files into logical groups called "collections." A collection is typically a directory containing markdown files and an empty `.collection` file.
|
||||
2. **Scanning**: You define which collections Doctree should scan using `!!doctree.scan` in a HeroScript file (e.g., `doctree.heroscript`):
|
||||
|
||||
1. **Collections**: Doctree organizes markdown files into logical groups called "collections." A collection is typically a directory containing markdown files and an empty `.collection` file.
|
||||
2. **Scanning**: You define which collections Doctree should scan using `!!doctree.scan` in a HeroScript file (e.g., `doctree.heroscript`).
|
||||
**Example `doctree.heroscript`:**
|
||||
```heroscript
|
||||
!!doctree.scan git_url:"https://git.threefold.info/tfgrid/docs_tfgrid4/src/branch/main/collections"
|
||||
!!doctree.scan git_url:"https://git.ourworld.tf/tfgrid/docs_tfgrid4/src/branch/main/collections"
|
||||
```
|
||||
|
||||
This will pull the `collections` directory from the specified Git URL and make its contents available to Doctree.
|
||||
3. **Page Retrieval**: When `site.page` references `src:"my_collection:my_page"`, HeroLib's `doctreeclient` fetches the content of `my_page.md` from the `my_collection` collection that Doctree has scanned.
|
||||
3. **Page Retrieval**: When `site.page` references `src:"my_collection:my_page"`, the client (`doctree_client` or `doctreeclient`, depending on configuration) fetches the content of `my_page.md` from the `my_collection` collection.
|
||||
|
||||
## 4. Building and Developing Your Ebook
|
||||
|
||||
@@ -287,12 +333,13 @@ Once your HeroScript configuration is set up, HeroLib provides commands to build
|
||||
### 4.1. Generating Site Files (`site.generate()`)
|
||||
|
||||
The `site.generate()` function (called internally by `build`, `dev`, etc.) performs the core file generation:
|
||||
* Copies Docusaurus template files.
|
||||
* Copies your site's `src` and `static` assets.
|
||||
* Generates Docusaurus configuration JSON files (`main.json`, `navbar.json`, `footer.json`) from your HeroScript `site.config`, `site.navbar`, and `site.footer` directives.
|
||||
* Copies your source `docs` directory.
|
||||
* Processes `site.page` and `site.page_category` directives using the `sitegen` module to create the final markdown files and `_category_.json` files in the Docusaurus `docs` directory, fetching content from Doctree.
|
||||
* Handles `site.import` directives, pulling external content and performing replacements.
|
||||
|
||||
* Copies Docusaurus template files.
|
||||
* Copies your site's `src` and `static` assets.
|
||||
* Generates Docusaurus configuration JSON files (`main.json`, `navbar.json`, `footer.json`) from your HeroScript `site.config`, `site.navbar`, and `site.footer` directives.
|
||||
* Copies your source `docs` directory.
|
||||
* Processes `site.page` and `site.page_category` directives using the `sitegen` module to create the final markdown files and `_category_.json` files in the Docusaurus `docs` directory, fetching content from Doctree.
|
||||
* Handles `site.import` directives, pulling external content and performing replacements.
|
||||
|
||||
### 4.2. Local Development
|
||||
|
||||
@@ -305,35 +352,34 @@ can be stored as example_docusaurus.vsh and then used to generate and develop an
|
||||
```v
|
||||
#!/usr/bin/env -S v -n -w -gc none -cg -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.web.docusaurus
|
||||
import incubaid.herolib.web.docusaurus
|
||||
import os
|
||||
|
||||
const cfgpath = os.dir(@FILE)
|
||||
|
||||
docusaurus.new(
|
||||
heroscript: '
|
||||
heroscript: '
|
||||
|
||||
// !!docusaurus.define
|
||||
// path_build: "/tmp/docusaurus_build"
|
||||
// path_publish: "/tmp/docusaurus_publish"
|
||||
// !!docusaurus.define
|
||||
// path_build: "/tmp/docusaurus_build"
|
||||
// path_publish: "/tmp/docusaurus_publish"
|
||||
|
||||
!!docusaurus.add name:"tfgrid_docs"
|
||||
path:"${cfgpath}"
|
||||
!!docusaurus.add name:"tfgrid_docs"
|
||||
path:"${cfgpath}"
|
||||
|
||||
!!docusaurus.dev
|
||||
!!docusaurus.dev
|
||||
|
||||
'
|
||||
'
|
||||
)!
|
||||
|
||||
```
|
||||
|
||||
|
||||
the following script suggest to call it do.vsh and put in directory of where the ebook is
|
||||
|
||||
```v
|
||||
#!/usr/bin/env -S v -n -w -gc none -cg -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.web.docusaurus
|
||||
import incubaid.herolib.web.docusaurus
|
||||
|
||||
const cfgpath = os.dir(@FILE) + '/cfg'
|
||||
|
||||
@@ -341,4 +387,3 @@ docusaurus.new(heroscript_path:cfgpath)!
|
||||
```
|
||||
|
||||
by just called do.vsh we can execute on the ebook
|
||||
|
||||
|
||||
@@ -13,12 +13,12 @@ The `list` method accepts a `ListArgs` struct to control its behavior:
|
||||
```v
|
||||
pub struct ListArgs {
|
||||
pub mut:
|
||||
regex []string // A slice of regular expressions to filter files.
|
||||
recursive bool = true // Whether to list files recursively (default true).
|
||||
ignore_default bool = true // Whether to ignore files starting with . and _ (default true).
|
||||
include_links bool // Whether to include symbolic links in the list.
|
||||
dirs_only bool // Whether to include only directories in the list.
|
||||
files_only bool // Whether to include only files in the list.
|
||||
regex []string // A slice of regular expressions to filter files.
|
||||
recursive bool = true // Whether to list files recursively (default true).
|
||||
ignore_default bool = true // Whether to ignore files starting with . and _ (default true).
|
||||
include_links bool // Whether to include symbolic links in the list.
|
||||
dirs_only bool // Whether to include only directories in the list.
|
||||
files_only bool // Whether to include only files in the list.
|
||||
}
|
||||
```
|
||||
|
||||
@@ -31,7 +31,7 @@ Here are examples demonstrating how to use these advanced filtering options:
|
||||
You can use regular expressions to filter files based on their names or extensions. The `regex` parameter accepts a slice of strings, where each string is a regex pattern.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.pathlib
|
||||
import incubaid.herolib.core.pathlib
|
||||
|
||||
// Get a directory path
|
||||
mut dir := pathlib.get('/some/directory')!
|
||||
@@ -61,7 +61,7 @@ for path_obj in vlang_files.paths {
|
||||
By default, `list()` is recursive. You can disable recursion to list only items in the current directory.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.pathlib
|
||||
import incubaid.herolib.core.pathlib
|
||||
|
||||
mut dir := pathlib.get('/some/directory')!
|
||||
|
||||
@@ -80,7 +80,7 @@ for path_obj in top_level_items.paths {
|
||||
The `ignore_default` parameter controls whether files and directories starting with `.` or `_` are ignored.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.pathlib
|
||||
import incubaid.herolib.core.pathlib
|
||||
|
||||
mut dir := pathlib.get('/some/directory')!
|
||||
|
||||
@@ -99,7 +99,7 @@ for path_obj in all_items.paths {
|
||||
By default, symbolic links are ignored when walking the directory structure. Set `include_links` to `true` to include them.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.pathlib
|
||||
import incubaid.herolib.core.pathlib
|
||||
|
||||
mut dir := pathlib.get('/some/directory')!
|
||||
|
||||
@@ -118,7 +118,7 @@ for path_obj in items_with_links.paths {
|
||||
Use `dirs_only` or `files_only` to restrict the results to only directories or only files.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.pathlib
|
||||
import incubaid.herolib.core.pathlib
|
||||
|
||||
mut dir := pathlib.get('/some/directory')!
|
||||
|
||||
|
||||
@@ -4,10 +4,10 @@ The `builder` module in Herolib provides a powerful framework for automating sys
|
||||
|
||||
## Key Components
|
||||
|
||||
- **`BuilderFactory`**: Responsible for creating and managing `Node` instances.
|
||||
- **`Node`**: Represents a target system (local or remote). It encapsulates system properties (platform, CPU type, environment variables) and provides methods for interaction.
|
||||
- **`Executor`**: An interface (implemented by `ExecutorLocal` and `ExecutorSSH`) that handles the actual command execution and file operations on the target system.
|
||||
- **NodeDB (via `Node.done` map)**: A key-value store within each `Node` for persistent state, caching, and tracking execution history.
|
||||
- **`BuilderFactory`**: Responsible for creating and managing `Node` instances.
|
||||
- **`Node`**: Represents a target system (local or remote). It encapsulates system properties (platform, CPU type, environment variables) and provides methods for interaction.
|
||||
- **`Executor`**: An interface (implemented by `ExecutorLocal` and `ExecutorSSH`) that handles the actual command execution and file operations on the target system.
|
||||
- **NodeDB (via `Node.done` map)**: A key-value store within each `Node` for persistent state, caching, and tracking execution history.
|
||||
|
||||
## Getting Started
|
||||
|
||||
@@ -16,7 +16,7 @@ The `builder` module in Herolib provides a powerful framework for automating sys
|
||||
First, import the `builder` module and create a new `BuilderFactory` instance. Then, create a `Node` object, which can represent either the local machine or a remote server.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.builder
|
||||
import incubaid.herolib.builder
|
||||
|
||||
// Create a new builder factory
|
||||
mut b := builder.new()!
|
||||
@@ -68,7 +68,7 @@ The `Node` object provides methods to execute commands on the target system.
|
||||
Executes a command and returns its standard output.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.builder { ExecArgs }
|
||||
import incubaid.herolib.builder { ExecArgs }
|
||||
|
||||
// Execute a command with stdout
|
||||
result := node.exec(cmd: "ls -la /tmp", stdout: true)!
|
||||
@@ -101,7 +101,7 @@ node.exec_interactive("bash")!
|
||||
A more advanced command execution method that supports caching, periodic execution, and temporary script handling.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.builder { NodeExecCmd }
|
||||
import incubaid.herolib.builder { NodeExecCmd }
|
||||
|
||||
// Execute a command, cache its result for 24 hours (48*3600 seconds)
|
||||
// and provide a description for logging.
|
||||
@@ -130,7 +130,7 @@ println(script_output)
|
||||
Executes a command with retries until it succeeds or a timeout is reached.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.builder { ExecRetryArgs }
|
||||
import incubaid.herolib.builder { ExecRetryArgs }
|
||||
|
||||
// Try to connect to a service, retrying every 100ms for up to 10 seconds
|
||||
result := node.exec_retry(
|
||||
@@ -219,7 +219,7 @@ if node.dir_exists("/var/log") {
|
||||
Transfer files between the local machine and the target node using `rsync` or `scp`.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.builder { SyncArgs }
|
||||
import incubaid.herolib.builder { SyncArgs }
|
||||
|
||||
// Upload a local file to the remote node
|
||||
node.upload(
|
||||
@@ -286,7 +286,7 @@ node.hero_install()!
|
||||
Updates the Herolib code on the node, with options for syncing from local, git reset, or git pull.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.builder { HeroUpdateArgs }
|
||||
import incubaid.herolib.builder { HeroUpdateArgs }
|
||||
|
||||
// Sync local Herolib code to the remote node (full sync)
|
||||
node.hero_update(sync_from_local: true, sync_full: true)!
|
||||
@@ -300,7 +300,7 @@ node.hero_update(git_reset: true, branch: "dev")!
|
||||
Uploads and executes a Vlang script (`.vsh` or `.v`) on the remote node.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.builder { VScriptArgs }
|
||||
import incubaid.herolib.builder { VScriptArgs }
|
||||
|
||||
// Upload and execute a local V script on the remote node
|
||||
node.vscript(path: "/local/path/to/my_script.vsh", sync_from_local: true)!
|
||||
@@ -311,7 +311,7 @@ node.vscript(path: "/local/path/to/my_script.vsh", sync_from_local: true)!
|
||||
The `portforward_to_local` function allows forwarding a remote port on an SSH host to a local port.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.builder { portforward_to_local, ForwardArgsToLocal }
|
||||
import incubaid.herolib.builder { portforward_to_local, ForwardArgsToLocal }
|
||||
|
||||
// Forward remote port 8080 on 192.168.1.100 to local port 9000
|
||||
portforward_to_local(
|
||||
|
||||
@@ -1,508 +1,682 @@
|
||||
# OSAL Core Module (freeflowuniverse.herolib.osal.core)
|
||||
# OSAL Core Module (incubaid.herolib.osal.core)
|
||||
|
||||
This document describes the core functionalities of the Operating System Abstraction Layer (OSAL) module, designed for platform-independent system operations in V.
|
||||
|
||||
```v
|
||||
//example how to get started
|
||||
|
||||
import freeflowuniverse.herolib.osal.core as osal
|
||||
import incubaid.herolib.osal.core as osal
|
||||
|
||||
osal.exec(...)!
|
||||
|
||||
```
|
||||
|
||||
|
||||
## 1. Process Management
|
||||
|
||||
### `osal.exec(cmd: Command) !Job`
|
||||
|
||||
Executes a shell command with extensive configuration.
|
||||
* **Parameters**:
|
||||
* `cmd` (`Command` struct):
|
||||
* `cmd` (string): The command string.
|
||||
* `timeout` (int, default: 3600): Max execution time in seconds.
|
||||
* `retry` (int): Number of retries on failure.
|
||||
* `work_folder` (string): Working directory.
|
||||
* `environment` (map[string]string): Environment variables.
|
||||
* `stdout` (bool, default: true): Show command output.
|
||||
* `stdout_log` (bool, default: true): Log stdout to internal buffer.
|
||||
* `raise_error` (bool, default: true): Raise V error on failure.
|
||||
* `ignore_error` (bool): Do not raise error, just report.
|
||||
* `debug` (bool): Enable debug output.
|
||||
* `shell` (bool): Execute in interactive shell.
|
||||
* `interactive` (bool, default: true): Run in interactive mode.
|
||||
* `async` (bool): Run command asynchronously.
|
||||
* `runtime` (`RunTime` enum): Specify runtime (`.bash`, `.python`, etc.).
|
||||
* **Returns**: `Job` struct (contains `status`, `output`, `error`, `exit_code`, `start`, `end`, `process`, `runnr`).
|
||||
* **Error Handling**: Returns `JobError` with `error_type` (`.exec`, `.timeout`, `.args`).
|
||||
|
||||
* **Parameters**:
|
||||
* `cmd` (`Command` struct):
|
||||
* `cmd` (string): The command string.
|
||||
* `timeout` (int, default: 3600): Max execution time in seconds.
|
||||
* `retry` (int): Number of retries on failure.
|
||||
* `work_folder` (string): Working directory.
|
||||
* `environment` (map[string]string): Environment variables.
|
||||
* `stdout` (bool, default: true): Show command output.
|
||||
* `stdout_log` (bool, default: true): Log stdout to internal buffer.
|
||||
* `raise_error` (bool, default: true): Raise V error on failure.
|
||||
* `ignore_error` (bool): Do not raise error, just report.
|
||||
* `debug` (bool): Enable debug output.
|
||||
* `shell` (bool): Execute in interactive shell.
|
||||
* `interactive` (bool, default: true): Run in interactive mode.
|
||||
* `async` (bool): Run command asynchronously.
|
||||
* `runtime` (`RunTime` enum): Specify runtime (`.bash`, `.python`, etc.).
|
||||
* **Returns**: `Job` struct (contains `status`, `output`, `error`, `exit_code`, `start`, `end`, `process`, `runnr`).
|
||||
* **Error Handling**: Returns `JobError` with `error_type` (`.exec`, `.timeout`, `.args`).
|
||||
|
||||
### `osal.execute_silent(cmd string) !string`
|
||||
|
||||
Executes a command silently.
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
* **Returns**: `string` (command output).
|
||||
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
* **Returns**: `string` (command output).
|
||||
|
||||
### `osal.execute_debug(cmd string) !string`
|
||||
|
||||
Executes a command with debug output.
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
* **Returns**: `string` (command output).
|
||||
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
* **Returns**: `string` (command output).
|
||||
|
||||
### `osal.execute_stdout(cmd string) !string`
|
||||
|
||||
Executes a command and prints output to stdout.
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
* **Returns**: `string` (command output).
|
||||
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
* **Returns**: `string` (command output).
|
||||
|
||||
### `osal.execute_interactive(cmd string) !`
|
||||
|
||||
### `osal.execute_ok(cmd string) bool`
|
||||
|
||||
Executes a command and returns `true` if the command exits with a zero status, `false` otherwise.
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
* **Returns**: `bool`.
|
||||
Executes a command in an interactive shell.
|
||||
|
||||
### `osal.exec_fast(cmd: CommandFast) !string`
|
||||
|
||||
Executes a command quickly, with options for profile sourcing and environment variables.
|
||||
* **Parameters**:
|
||||
* `cmd` (`CommandFast` struct):
|
||||
* `cmd` (string): The command string.
|
||||
* `ignore_error` (bool): Do not raise error on non-zero exit code.
|
||||
* `work_folder` (string): Working directory.
|
||||
* `environment` (map[string]string): Environment variables.
|
||||
* `ignore_error_codes` ([]int): List of exit codes to ignore.
|
||||
* `debug` (bool): Enable debug output.
|
||||
* `includeprofile` (bool): Source the user's profile before execution.
|
||||
* `notempty` (bool): Return an error if the output is empty.
|
||||
* **Returns**: `string` (command output).
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
|
||||
* **Parameters**:
|
||||
* `cmd` (`CommandFast` struct):
|
||||
* `cmd` (string): The command string.
|
||||
* `ignore_error` (bool): Do not raise error on non-zero exit code.
|
||||
* `work_folder` (string): Working directory.
|
||||
* `environment` (map[string]string): Environment variables.
|
||||
* `ignore_error_codes` ([]int): List of exit codes to ignore.
|
||||
* `debug` (bool): Enable debug output.
|
||||
* `includeprofile` (bool): Source the user's profile before execution.
|
||||
* `notempty` (bool): Return an error if the output is empty.
|
||||
* **Returns**: `string` (command output).
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
|
||||
### `osal.cmd_exists(cmd string) bool`
|
||||
|
||||
Checks if a command exists in the system's PATH.
|
||||
* **Parameters**: `cmd` (string): The command name.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Parameters**: `cmd` (string): The command name.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.processmap_get() !ProcessMap`
|
||||
|
||||
Scans and returns a map of all running processes.
|
||||
* **Returns**: `ProcessMap` struct (contains `processes` (`[]ProcessInfo`), `lastscan`, `state`, `pids`).
|
||||
|
||||
* **Returns**: `ProcessMap` struct (contains `processes` (`[]ProcessInfo`), `lastscan`, `state`, `pids`).
|
||||
|
||||
### `osal.processinfo_get(pid int) !ProcessInfo`
|
||||
|
||||
Retrieves detailed information for a specific process by PID.
|
||||
* **Parameters**: `pid` (int): Process ID.
|
||||
* **Returns**: `ProcessInfo` struct (contains `cpu_perc`, `mem_perc`, `cmd`, `pid`, `ppid`, `rss`).
|
||||
|
||||
* **Parameters**: `pid` (int): Process ID.
|
||||
* **Returns**: `ProcessInfo` struct (contains `cpu_perc`, `mem_perc`, `cmd`, `pid`, `ppid`, `rss`).
|
||||
|
||||
### `osal.processinfo_get_byname(name string) ![]ProcessInfo`
|
||||
|
||||
Retrieves detailed information for processes matching a given name.
|
||||
* **Parameters**: `name` (string): Process name (substring match).
|
||||
* **Returns**: `[]ProcessInfo`.
|
||||
|
||||
* **Parameters**: `name` (string): Process name (substring match).
|
||||
* **Returns**: `[]ProcessInfo`.
|
||||
|
||||
### `osal.process_exists(pid int) bool`
|
||||
|
||||
Checks if a process with a given PID exists.
|
||||
* **Parameters**: `pid` (int): Process ID.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Parameters**: `pid` (int): Process ID.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.processinfo_with_children(pid int) !ProcessMap`
|
||||
|
||||
Returns a process and all its child processes.
|
||||
|
||||
## 1.1. Done Context Management (`done.v`)
|
||||
|
||||
Functions for managing a "done" context or state using Redis.
|
||||
|
||||
* **`osal.done_set(key string, val string) !`**: Sets a key-value pair in the "done" context.
|
||||
* **`osal.done_get(key string) ?string`**: Retrieves a value from the "done" context by key.
|
||||
* **`osal.done_delete(key string) !`**: Deletes a key from the "done" context.
|
||||
* **`osal.done_get_str(key string) string`**: Retrieves a string value from the "done" context by key (panics on error).
|
||||
* **`osal.done_get_int(key string) int`**: Retrieves an integer value from the "done" context by key (panics on error).
|
||||
* **`osal.done_exists(key string) bool`**: Checks if a key exists in the "done" context.
|
||||
* **`osal.done_print() !`**: Prints all key-value pairs in the "done" context to debug output.
|
||||
* **`osal.done_reset() !`**: Resets (deletes all keys from) the "done" context.
|
||||
* **Parameters**: `pid` (int): Parent Process ID.
|
||||
* **Returns**: `ProcessMap`.
|
||||
* **`osal.done_set(key string, val string) !`**: Sets a key-value pair in the "done" context.
|
||||
* **`osal.done_get(key string) ?string`**: Retrieves a value from the "done" context by key.
|
||||
* **`osal.done_delete(key string) !`**: Deletes a key from the "done" context.
|
||||
* **`osal.done_get_str(key string) string`**: Retrieves a string value from the "done" context by key (panics on error).
|
||||
* **`osal.done_get_int(key string) int`**: Retrieves an integer value from the "done" context by key (panics on error).
|
||||
* **`osal.done_exists(key string) bool`**: Checks if a key exists in the "done" context.
|
||||
* **`osal.done_print() !`**: Prints all key-value pairs in the "done" context to debug output.
|
||||
* **`osal.done_reset() !`**: Resets (deletes all keys from) the "done" context.
|
||||
* **Parameters**: `pid` (int): Parent Process ID.
|
||||
* **Returns**: `ProcessMap`.
|
||||
|
||||
### `osal.processinfo_children(pid int) !ProcessMap`
|
||||
|
||||
Returns all child processes for a given PID.
|
||||
* **Parameters**: `pid` (int): Parent Process ID.
|
||||
* **Returns**: `ProcessMap`.
|
||||
|
||||
* **Parameters**: `pid` (int): Parent Process ID.
|
||||
* **Returns**: `ProcessMap`.
|
||||
|
||||
### `osal.process_kill_recursive(args: ProcessKillArgs) !`
|
||||
|
||||
Kills a process and all its children by name or PID.
|
||||
* **Parameters**:
|
||||
* `args` (`ProcessKillArgs` struct):
|
||||
* `name` (string): Process name.
|
||||
* `pid` (int): Process ID.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`ProcessKillArgs` struct):
|
||||
* `name` (string): Process name.
|
||||
* `pid` (int): Process ID.
|
||||
|
||||
### `osal.process_exists_byname(name string) !bool`
|
||||
|
||||
Checks if a process with a given name exists.
|
||||
* **Parameters**: `name` (string): Process name (substring match).
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Parameters**: `name` (string): Process name (substring match).
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.whoami() !string`
|
||||
|
||||
Returns the current username.
|
||||
* **Returns**: `string`.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
## 2. Network Utilities
|
||||
|
||||
### `osal.ping(args: PingArgs) ! bool`
|
||||
|
||||
Checks host reachability.
|
||||
* **Parameters**:
|
||||
|
||||
* **Parameters**:
|
||||
|
||||
### `osal.ipaddr_pub_get_check() !string`
|
||||
|
||||
Retrieves the public IP address and verifies it is bound to a local interface.
|
||||
* **Returns**: `string`.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.is_ip_on_local_interface(ip string) !bool`
|
||||
|
||||
Checks if a given IP address is bound to a local network interface.
|
||||
* **Parameters**: `ip` (string): IP address to check.
|
||||
* **Returns**: `bool`.
|
||||
* `args` (`PingArgs` struct):
|
||||
* `address` (string, required): IP address or hostname.
|
||||
* `count` (u8, default: 1): Number of pings.
|
||||
* `timeout` (u16, default: 1): Timeout in seconds per ping.
|
||||
* `retry` (u8): Number of retry attempts.
|
||||
* **Returns**: `PingResult` enum (`.ok`, `.timeout`, `.unknownhost`).
|
||||
|
||||
* **Parameters**: `ip` (string): IP address to check.
|
||||
* **Returns**: `bool`.
|
||||
* `args` (`PingArgs` struct):
|
||||
* `address` (string, required): IP address or hostname.
|
||||
* `count` (u8, default: 1): Number of pings.
|
||||
* `timeout` (u16, default: 1): Timeout in seconds per ping.
|
||||
* `retry` (u8): Number of retry attempts.
|
||||
* **Returns**: `PingResult` enum (`.ok`, `.timeout`, `.unknownhost`).
|
||||
|
||||
### `osal.tcp_port_test(args: TcpPortTestArgs) bool`
|
||||
|
||||
Tests if a TCP port is open on a given address.
|
||||
* **Parameters**:
|
||||
* `args` (`TcpPortTestArgs` struct):
|
||||
* `address` (string, required): IP address or hostname.
|
||||
* `port` (int, default: 22): TCP port number.
|
||||
* `timeout` (u16, default: 2000): Total timeout in milliseconds.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`TcpPortTestArgs` struct):
|
||||
* `address` (string, required): IP address or hostname.
|
||||
* `port` (int, default: 22): TCP port number.
|
||||
* `timeout` (u16, default: 2000): Total timeout in milliseconds.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.ipaddr_pub_get() !string`
|
||||
|
||||
Retrieves the public IP address.
|
||||
* **Returns**: `string`.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.is_ip_on_local_interface(ip string) !bool`
|
||||
|
||||
Checks if a given IP address is bound to a local network interface.
|
||||
* **Parameters**: `ip` (string): IP address to check.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Parameters**: `ip` (string): IP address to check.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
## 3. File System Operations
|
||||
|
||||
### `osal.file_write(path string, text string) !`
|
||||
|
||||
Writes text content to a file.
|
||||
* **Parameters**:
|
||||
* `path` (string): File path.
|
||||
* `text` (string): Content to write.
|
||||
|
||||
* **Parameters**:
|
||||
* `path` (string): File path.
|
||||
* `text` (string): Content to write.
|
||||
|
||||
### `osal.file_read(path string) !string`
|
||||
|
||||
Reads content from a file.
|
||||
* **Parameters**: `path` (string): File path.
|
||||
* **Returns**: `string` (file content).
|
||||
|
||||
* **Parameters**: `path` (string): File path.
|
||||
* **Returns**: `string` (file content).
|
||||
|
||||
### `osal.dir_ensure(path string) !`
|
||||
|
||||
Ensures a directory exists, creating it if necessary.
|
||||
* **Parameters**: `path` (string): Directory path.
|
||||
|
||||
* **Parameters**: `path` (string): Directory path.
|
||||
|
||||
### `osal.dir_delete(path string) !`
|
||||
|
||||
Deletes a directory if it exists.
|
||||
* **Parameters**: `path` (string): Directory path.
|
||||
|
||||
* **Parameters**: `path` (string): Directory path.
|
||||
|
||||
### `osal.dir_reset(path string) !`
|
||||
|
||||
Deletes and then recreates a directory.
|
||||
* **Parameters**: `path` (string): Directory path.
|
||||
|
||||
* **Parameters**: `path` (string): Directory path.
|
||||
|
||||
### `osal.rm(todelete string) !`
|
||||
|
||||
Removes files or directories.
|
||||
* **Parameters**: `todelete` (string): Comma or newline separated list of paths (supports `~` for home directory).
|
||||
|
||||
* **Parameters**: `todelete` (string): Comma or newline separated list of paths (supports `~` for home directory).
|
||||
|
||||
### `osal.env_get_all() map[string]string`
|
||||
|
||||
Returns all existing environment variables as a map.
|
||||
* **Returns**: `map[string]string`.
|
||||
|
||||
* **Returns**: `map[string]string`.
|
||||
|
||||
## 4. Environment Variables
|
||||
|
||||
## 4.1. Package Management (`package.v`)
|
||||
|
||||
Functions for managing system packages.
|
||||
|
||||
* **`osal.package_refresh() !`**: Updates the package list for the detected platform.
|
||||
* **`osal.package_install(name_ string) !`**: Installs one or more packages.
|
||||
* **`osal.package_remove(name_ string) !`**: Removes one or more packages.
|
||||
* **`osal.package_refresh() !`**: Updates the package list for the detected platform.
|
||||
* **`osal.package_install(name_ string) !`**: Installs one or more packages.
|
||||
* **`osal.package_remove(name_ string) !`**: Removes one or more packages.
|
||||
|
||||
### `osal.env_set(args: EnvSet)`
|
||||
|
||||
Sets an environment variable.
|
||||
* **Parameters**:
|
||||
* `args` (`EnvSet` struct):
|
||||
* `key` (string, required): Environment variable name.
|
||||
* `value` (string, required): Value to set.
|
||||
* `overwrite` (bool, default: true): Overwrite if exists.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`EnvSet` struct):
|
||||
* `key` (string, required): Environment variable name.
|
||||
* `value` (string, required): Value to set.
|
||||
* `overwrite` (bool, default: true): Overwrite if exists.
|
||||
|
||||
### `osal.env_unset(key string)`
|
||||
|
||||
Unsets a specific environment variable.
|
||||
* **Parameters**: `key` (string): Environment variable name.
|
||||
|
||||
* **Parameters**: `key` (string): Environment variable name.
|
||||
|
||||
### `osal.env_unset_all()`
|
||||
|
||||
Unsets all environment variables.
|
||||
|
||||
### `osal.env_set_all(args: EnvSetAll)`
|
||||
|
||||
Sets multiple environment variables.
|
||||
* **Parameters**:
|
||||
* `args` (`EnvSetAll` struct):
|
||||
* `env` (map[string]string): Map of key-value pairs.
|
||||
* `clear_before_set` (bool): Clear all existing variables before setting.
|
||||
* `overwrite_if_exists` (bool, default: true): Overwrite existing variables.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`EnvSetAll` struct):
|
||||
* `env` (map[string]string): Map of key-value pairs.
|
||||
* `clear_before_set` (bool): Clear all existing variables before setting.
|
||||
* `overwrite_if_exists` (bool, default: true): Overwrite existing variables.
|
||||
|
||||
### `osal.env_get(key string) !string`
|
||||
|
||||
Retrieves the value of a specific environment variable.
|
||||
* **Parameters**: `key` (string): Environment variable name.
|
||||
* **Returns**: `string` (variable value).
|
||||
|
||||
* **Parameters**: `key` (string): Environment variable name.
|
||||
* **Returns**: `string` (variable value).
|
||||
|
||||
### `osal.env_exists(key string) !bool`
|
||||
|
||||
Checks if an environment variable exists.
|
||||
* **Parameters**: `key` (string): Environment variable name.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Parameters**: `key` (string): Environment variable name.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.env_get_default(key string, def string) string`
|
||||
|
||||
Retrieves an environment variable or a default value if not found.
|
||||
* **Parameters**:
|
||||
* `key` (string): Environment variable name.
|
||||
* `def` (string): Default value.
|
||||
* **Returns**: `string`.
|
||||
|
||||
* **Parameters**:
|
||||
* `key` (string): Environment variable name.
|
||||
* `def` (string): Default value.
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.load_env_file(file_path string) !`
|
||||
|
||||
Loads environment variables from a specified file.
|
||||
* **Parameters**: `file_path` (string): Path to the environment file.
|
||||
|
||||
* **Parameters**: `file_path` (string): Path to the environment file.
|
||||
|
||||
## 5. Command & Profile Management
|
||||
|
||||
### `osal.cmd_add(args: CmdAddArgs) !`
|
||||
|
||||
Adds (copies or symlinks) a binary to system paths and updates user profiles.
|
||||
* **Parameters**:
|
||||
* `args` (`CmdAddArgs` struct):
|
||||
* `cmdname` (string): Name of the command (optional, derived from source if empty).
|
||||
* `source` (string, required): Path to the binary.
|
||||
* `symlink` (bool): Create a symlink instead of copying.
|
||||
* `reset` (bool, default: true): Delete existing command if found.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`CmdAddArgs` struct):
|
||||
* `cmdname` (string): Name of the command (optional, derived from source if empty).
|
||||
* `source` (string, required): Path to the binary.
|
||||
* `symlink` (bool): Create a symlink instead of copying.
|
||||
* `reset` (bool, default: true): Delete existing command if found.
|
||||
|
||||
### `osal.profile_path_add_hero() !string`
|
||||
|
||||
Ensures the `~/hero/bin` path is added to the user's profile.
|
||||
* **Returns**: `string` (the `~/hero/bin` path).
|
||||
|
||||
* **Returns**: `string` (the `~/hero/bin` path).
|
||||
|
||||
### `osal.bin_path() !string`
|
||||
|
||||
Returns the preferred binary installation path (`~/hero/bin`).
|
||||
* **Returns**: `string`.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.hero_path() !string`
|
||||
|
||||
Returns the `~/hero` directory path.
|
||||
* **Returns**: `string`.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.usr_local_path() !string`
|
||||
|
||||
Returns `/usr/local` for Linux or `~/hero` for macOS.
|
||||
* **Returns**: `string`.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.cmd_exists_profile(cmd string) bool`
|
||||
|
||||
Checks if a command exists in the system's PATH, considering the user's profile.
|
||||
* **Parameters**: `cmd` (string): The command name.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Parameters**: `cmd` (string): The command name.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.profile_path_source() !string`
|
||||
|
||||
Returns a source statement for the preferred profile file (e.g., `. /home/user/.zprofile`).
|
||||
* **Returns**: `string`.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.profile_path_source_and() !string`
|
||||
|
||||
Returns a source statement followed by `&&` for command chaining, or empty if profile doesn't exist.
|
||||
* **Returns**: `string`.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.profile_path_add_remove(args: ProfilePathAddRemoveArgs) !`
|
||||
|
||||
Adds and/or removes paths from specified or preferred user profiles.
|
||||
* **Parameters**:
|
||||
* `args` (`ProfilePathAddRemoveArgs` struct):
|
||||
* `paths_profile` (string): Comma/newline separated list of profile file paths (optional, uses preferred if empty).
|
||||
* `paths2add` (string): Comma/newline separated list of paths to add.
|
||||
* `paths2delete` (string): Comma/newline separated list of paths to delete.
|
||||
* `allprofiles` (bool): Apply to all known profile files.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`ProfilePathAddRemoveArgs` struct):
|
||||
* `paths_profile` (string): Comma/newline separated list of profile file paths (optional, uses preferred if empty).
|
||||
* `paths2add` (string): Comma/newline separated list of paths to add.
|
||||
* `paths2delete` (string): Comma/newline separated list of paths to delete.
|
||||
* `allprofiles` (bool): Apply to all known profile files.
|
||||
|
||||
### `osal.cmd_path(cmd string) !string`
|
||||
|
||||
Returns the full path of an executable command using `which`.
|
||||
* **Parameters**: `cmd` (string): Command name.
|
||||
* **Returns**: `string` (full path).
|
||||
|
||||
* **Parameters**: `cmd` (string): Command name.
|
||||
* **Returns**: `string` (full path).
|
||||
|
||||
### `osal.cmd_delete(cmd string) !`
|
||||
|
||||
Deletes commands from their found locations.
|
||||
* **Parameters**: `cmd` (string): Command name.
|
||||
|
||||
* **Parameters**: `cmd` (string): Command name.
|
||||
|
||||
### `osal.profile_paths_all() ![]string`
|
||||
|
||||
Lists all possible profile file paths in the OS.
|
||||
* **Returns**: `[]string`.
|
||||
|
||||
* **Returns**: `[]string`.
|
||||
|
||||
### `osal.profile_paths_preferred() ![]string`
|
||||
|
||||
## 5.1. SSH Key Management (`ssh_key.v`)
|
||||
|
||||
Functions and structs for managing SSH keys.
|
||||
|
||||
### `struct SSHKey`
|
||||
|
||||
Represents an SSH key pair.
|
||||
* **Fields**: `name` (string), `directory` (string).
|
||||
* **Methods**:
|
||||
* `public_key_path() !pathlib.Path`: Returns the path to the public key.
|
||||
* `private_key_path() !pathlib.Path`: Returns the path to the private key.
|
||||
* `public_key() !string`: Returns the content of the public key.
|
||||
* `private_key() !string`: Returns the content of the private key.
|
||||
|
||||
* **Fields**: `name` (string), `directory` (string).
|
||||
* **Methods**:
|
||||
* `public_key_path() !pathlib.Path`: Returns the path to the public key.
|
||||
* `private_key_path() !pathlib.Path`: Returns the path to the private key.
|
||||
* `public_key() !string`: Returns the content of the public key.
|
||||
* `private_key() !string`: Returns the content of the private key.
|
||||
|
||||
### `struct SSHConfig`
|
||||
|
||||
Configuration for SSH key operations.
|
||||
* **Fields**: `directory` (string, default: `~/.ssh`).
|
||||
|
||||
* **Fields**: `directory` (string, default: `~/.ssh`).
|
||||
|
||||
### `osal.get_ssh_key(key_name string, config SSHConfig) ?SSHKey`
|
||||
|
||||
Retrieves a specific SSH key by name.
|
||||
* **Parameters**: `key_name` (string), `config` (`SSHConfig` struct).
|
||||
* **Returns**: `?SSHKey` (optional SSHKey struct).
|
||||
|
||||
* **Parameters**: `key_name` (string), `config` (`SSHConfig` struct).
|
||||
* **Returns**: `?SSHKey` (optional SSHKey struct).
|
||||
|
||||
### `osal.list_ssh_keys(config SSHConfig) ![]SSHKey`
|
||||
|
||||
Lists all SSH keys in the specified directory.
|
||||
* **Parameters**: `config` (`SSHConfig` struct).
|
||||
* **Returns**: `[]SSHKey`.
|
||||
|
||||
* **Parameters**: `config` (`SSHConfig` struct).
|
||||
* **Returns**: `[]SSHKey`.
|
||||
|
||||
### `osal.new_ssh_key(key_name string, config SSHConfig) !SSHKey`
|
||||
|
||||
Creates a new SSH key pair.
|
||||
* **Parameters**: `key_name` (string), `config` (`SSHConfig` struct).
|
||||
* **Returns**: `SSHKey`.
|
||||
|
||||
* **Parameters**: `key_name` (string), `config` (`SSHConfig` struct).
|
||||
* **Returns**: `SSHKey`.
|
||||
Lists preferred profile file paths based on the operating system.
|
||||
* **Returns**: `[]string`.
|
||||
* **Returns**: `[]string`.
|
||||
|
||||
### `osal.profile_path() !string`
|
||||
|
||||
Returns the most preferred profile file path.
|
||||
* **Returns**: `string`.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
## 6. System Information & Utilities
|
||||
|
||||
### `osal.platform() !PlatformType`
|
||||
|
||||
Identifies the operating system.
|
||||
* **Returns**: `PlatformType` enum (`.unknown`, `.osx`, `.ubuntu`, `.alpine`, `.arch`, `.suse`).
|
||||
|
||||
* **Returns**: `PlatformType` enum (`.unknown`, `.osx`, `.ubuntu`, `.alpine`, `.arch`, `.suse`).
|
||||
|
||||
### `osal.cputype() !CPUType`
|
||||
|
||||
Identifies the CPU architecture.
|
||||
* **Returns**: `CPUType` enum (`.unknown`, `.intel`, `.arm`, `.intel32`, `.arm32`).
|
||||
|
||||
* **Returns**: `CPUType` enum (`.unknown`, `.intel`, `.arm`, `.intel32`, `.arm32`).
|
||||
|
||||
### `osal.is_linux() !bool`
|
||||
|
||||
Checks if the current OS is Linux.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.is_osx() !bool`
|
||||
|
||||
Checks if the current OS is macOS.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.is_ubuntu() !bool`
|
||||
|
||||
Checks if the current OS is Ubuntu.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.is_osx_arm() !bool`
|
||||
|
||||
Checks if the current OS is macOS ARM.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.is_linux_arm() !bool`
|
||||
|
||||
Checks if the current OS is Linux ARM.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.is_osx_intel() !bool`
|
||||
|
||||
Checks if the current OS is macOS Intel.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.is_linux_intel() !bool`
|
||||
|
||||
Checks if the current OS is Linux Intel.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.hostname() !string`
|
||||
|
||||
Returns the system hostname.
|
||||
* **Returns**: `string`.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.initname() !string`
|
||||
|
||||
Returns the init system name (e.g., `systemd`, `bash`, `zinit`).
|
||||
* **Returns**: `string`.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.sleep(duration int)`
|
||||
|
||||
Pauses execution for a specified duration.
|
||||
* **Parameters**: `duration` (int): Sleep duration in seconds.
|
||||
|
||||
* **Parameters**: `duration` (int): Sleep duration in seconds.
|
||||
|
||||
### `osal.download(args: DownloadArgs) !pathlib.Path`
|
||||
|
||||
Downloads a file from a URL.
|
||||
* **Parameters**:
|
||||
* `args` (`DownloadArgs` struct):
|
||||
* `url` (string, required): URL of the file.
|
||||
* `name` (string): Optional, derived from filename if empty.
|
||||
* `reset` (bool): Force download, remove existing.
|
||||
* `hash` (string): Hash for verification.
|
||||
* `dest` (string): Destination path.
|
||||
* `timeout` (int, default: 180): Download timeout in seconds.
|
||||
* `retry` (int, default: 3): Number of retries.
|
||||
* `minsize_kb` (u32, default: 10): Minimum expected size in KB.
|
||||
* `maxsize_kb` (u32): Maximum expected size in KB.
|
||||
* `expand_dir` (string): Directory to expand archive into.
|
||||
* `expand_file` (string): File to expand archive into.
|
||||
* **Returns**: `pathlib.Path` (path to the downloaded file/directory).
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`DownloadArgs` struct):
|
||||
* `url` (string, required): URL of the file.
|
||||
* `name` (string): Optional, derived from filename if empty.
|
||||
* `reset` (bool): Force download, remove existing.
|
||||
* `hash` (string): Hash for verification.
|
||||
* `dest` (string): Destination path.
|
||||
* `timeout` (int, default: 180): Download timeout in seconds.
|
||||
* `retry` (int, default: 3): Number of retries.
|
||||
* `minsize_kb` (u32, default: 10): Minimum expected size in KB.
|
||||
* `maxsize_kb` (u32): Maximum expected size in KB.
|
||||
* `expand_dir` (string): Directory to expand archive into.
|
||||
* `expand_file` (string): File to expand archive into.
|
||||
* **Returns**: `pathlib.Path` (path to the downloaded file/directory).
|
||||
|
||||
### `osal.user_exists(username string) bool`
|
||||
|
||||
Checks if a user exists on the system.
|
||||
* **Parameters**: `username` (string): Username to check.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
* **Parameters**: `username` (string): Username to check.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.user_id_get(username string) !int`
|
||||
|
||||
Retrieves the user ID for a given username.
|
||||
* **Parameters**: `username` (string): Username.
|
||||
* **Returns**: `int` (User ID).
|
||||
|
||||
* **Parameters**: `username` (string): Username.
|
||||
* **Returns**: `int` (User ID).
|
||||
|
||||
### `osal.user_add(args: UserArgs) !int`
|
||||
|
||||
Adds a new user to the system.
|
||||
* **Parameters**:
|
||||
* `args` (`UserArgs` struct):
|
||||
* `name` (string, required): Username to add.
|
||||
* **Returns**: `int` (User ID of the added user).
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`UserArgs` struct):
|
||||
* `name` (string, required): Username to add.
|
||||
* **Returns**: `int` (User ID of the added user).
|
||||
|
||||
## Enums & Structs
|
||||
|
||||
### `enum PlatformType`
|
||||
|
||||
Represents the detected operating system.
|
||||
* Values: `unknown`, `osx`, `ubuntu`, `alpine`, `arch`, `suse`.
|
||||
|
||||
* Values: `unknown`, `osx`, `ubuntu`, `alpine`, `arch`, `suse`.
|
||||
|
||||
### `enum CPUType`
|
||||
|
||||
Represents the detected CPU architecture.
|
||||
* Values: `unknown`, `intel`, `arm`, `intel32`, `arm32`.
|
||||
|
||||
* Values: `unknown`, `intel`, `arm`, `intel32`, `arm32`.
|
||||
|
||||
### `enum RunTime`
|
||||
|
||||
Specifies the runtime environment for command execution.
|
||||
* Values: `bash`, `python`, `heroscript`, `herocmd`, `v`.
|
||||
|
||||
* Values: `bash`, `python`, `heroscript`, `herocmd`, `v`.
|
||||
|
||||
### `enum JobStatus`
|
||||
|
||||
Status of an executed command job.
|
||||
* Values: `init`, `running`, `error_exec`, `error_timeout`, `error_args`, `done`.
|
||||
|
||||
* Values: `init`, `running`, `error_exec`, `error_timeout`, `error_args`, `done`.
|
||||
|
||||
### `enum ErrorType`
|
||||
|
||||
Types of errors that can occur during job execution.
|
||||
* Values: `exec`, `timeout`, `args`.
|
||||
|
||||
* Values: `exec`, `timeout`, `args`.
|
||||
|
||||
### `enum PingResult`
|
||||
|
||||
Result of a ping operation.
|
||||
* Values: `ok`, `timeout`, `unknownhost`.
|
||||
|
||||
* Values: `ok`, `timeout`, `unknownhost`.
|
||||
|
||||
### `struct Command`
|
||||
|
||||
Configuration for `osal.exec` function. (See `osal.exec` parameters for fields).
|
||||
|
||||
### `struct Job`
|
||||
|
||||
Result object returned by `osal.exec`. (See `osal.exec` returns for fields).
|
||||
|
||||
### `struct JobError`
|
||||
|
||||
Error details for failed jobs.
|
||||
|
||||
### `struct PingArgs`
|
||||
|
||||
Arguments for `osal.ping` function. (See `osal.ping` parameters for fields).
|
||||
|
||||
### `struct TcpPortTestArgs`
|
||||
|
||||
Arguments for `osal.tcp_port_test` function. (See `osal.tcp_port_test` parameters for fields).
|
||||
|
||||
### `struct EnvSet`
|
||||
|
||||
Arguments for `osal.env_set` function. (See `osal.env_set` parameters for fields).
|
||||
|
||||
### `struct EnvSetAll`
|
||||
|
||||
Arguments for `osal.env_set_all` function. (See `osal.env_set_all` parameters for fields).
|
||||
|
||||
### `struct CmdAddArgs`
|
||||
|
||||
Arguments for `osal.cmd_add` function. (See `osal.cmd_add` parameters for fields).
|
||||
|
||||
### `struct ProfilePathAddRemoveArgs`
|
||||
|
||||
Arguments for `osal.profile_path_add_remove` function. (See `osal.profile_path_add_remove` parameters for fields).
|
||||
|
||||
### `struct ProcessMap`
|
||||
|
||||
Contains a list of `ProcessInfo` objects.
|
||||
|
||||
### `struct ProcessInfo`
|
||||
|
||||
Detailed information about a single process. (See `osal.processinfo_get` returns for fields).
|
||||
|
||||
### `struct ProcessKillArgs`
|
||||
|
||||
Arguments for `osal.process_kill_recursive` function. (See `osal.process_kill_recursive` parameters for fields).
|
||||
|
||||
### `struct DownloadArgs`
|
||||
|
||||
Arguments for `osal.download` function. (See `osal.download` parameters for fields).
|
||||
|
||||
### `struct UserArgs`
|
||||
|
||||
Arguments for `osal.user_add` function. (See `osal.user_add` parameters for fields).
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
The `OurTime` module in V provides flexible time handling, supporting relative and absolute time formats, Unix timestamps, and formatting utilities.
|
||||
|
||||
## Key Features
|
||||
|
||||
- Create time objects from strings or current time
|
||||
- Relative time expressions (e.g., `+1h`, `-2d`)
|
||||
- Absolute time formats (e.g., `YYYY-MM-DD HH:mm:ss`)
|
||||
@@ -12,7 +13,7 @@ The `OurTime` module in V provides flexible time handling, supporting relative a
|
||||
## Basic Usage
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.data.ourtime
|
||||
import incubaid.herolib.data.ourtime
|
||||
|
||||
// Current time
|
||||
mut t := ourtime.now()
|
||||
@@ -1,6 +1,6 @@
|
||||
# Herolib Spreadsheet Module for AI Prompt Engineering
|
||||
|
||||
This document provides an overview and usage instructions for the `freeflowuniverse.herolib.biz.spreadsheet` module, which offers a powerful software representation of a spreadsheet. This module is designed for business modeling, data analysis, and can be leveraged in AI prompt engineering scenarios where structured data manipulation and visualization are required.
|
||||
This document provides an overview and usage instructions for the `incubaid.herolib.biz.spreadsheet` module, which offers a powerful software representation of a spreadsheet. This module is designed for business modeling, data analysis, and can be leveraged in AI prompt engineering scenarios where structured data manipulation and visualization are required.
|
||||
|
||||
## 1. Core Concepts
|
||||
|
||||
@@ -10,16 +10,17 @@ The spreadsheet module revolves around three main entities: `Sheet`, `Row`, and
|
||||
|
||||
The `Sheet` is the primary container, representing the entire spreadsheet.
|
||||
|
||||
* **Properties:**
|
||||
* `name` (string): A unique identifier for the sheet.
|
||||
* `rows` (map[string]&Row): A collection of `Row` objects, indexed by their names.
|
||||
* `nrcol` (int): The number of columns in the sheet (e.g., 60 for 5 years of monthly data).
|
||||
* `params` (SheetParams): Configuration parameters, e.g., `visualize_cur` (boolean to display currency symbols).
|
||||
* `currency` (currency.Currency): The default currency for the sheet (e.g., USD), used for automatic conversions.
|
||||
* **Properties:**
|
||||
* `name` (string): A unique identifier for the sheet.
|
||||
* `rows` (map[string]&Row): A collection of `Row` objects, indexed by their names.
|
||||
* `nrcol` (int): The number of columns in the sheet (e.g., 60 for 5 years of monthly data).
|
||||
* `params` (SheetParams): Configuration parameters, e.g., `visualize_cur` (boolean to display currency symbols).
|
||||
* `currency` (currency.Currency): The default currency for the sheet (e.g., USD), used for automatic conversions.
|
||||
|
||||
* **Creation:**
|
||||
|
||||
* **Creation:**
|
||||
```v
|
||||
import freeflowuniverse.herolib.biz.spreadsheet
|
||||
import incubaid.herolib.biz.spreadsheet
|
||||
|
||||
// Create a new sheet named 'my_financial_sheet' with 60 columns (e.g., 60 months)
|
||||
mut my_sheet := spreadsheet.sheet_new(
|
||||
@@ -33,28 +34,29 @@ The `Sheet` is the primary container, representing the entire spreadsheet.
|
||||
mut existing_sheet := spreadsheet.sheet_get('my_financial_sheet')!
|
||||
```
|
||||
|
||||
* **Key Operations:**
|
||||
* `sheet.row_get(name string) !&Row`: Retrieves a row by its name.
|
||||
* `sheet.cell_get(row string, col int) !&Cell`: Retrieves a cell by row name and column index.
|
||||
* `sheet.row_delete(name string)` / `sheet.delete(name string)`: Deletes a row.
|
||||
* `sheet.cells_width(colnr int) !int`: Finds the maximum string length of cells in a given column.
|
||||
* `sheet.rows_names_width_max() int`: Returns the maximum width of row names/aliases.
|
||||
* `sheet.rows_description_width_max() int`: Returns the maximum width of row descriptions.
|
||||
* `sheet.header() ![]string`: Generates column headers (e.g., "M1", "Q1", "Y1") based on `nrcol`.
|
||||
* **Key Operations:**
|
||||
* `sheet.row_get(name string) !&Row`: Retrieves a row by its name.
|
||||
* `sheet.cell_get(row string, col int) !&Cell`: Retrieves a cell by row name and column index.
|
||||
* `sheet.row_delete(name string)` / `sheet.delete(name string)`: Deletes a row.
|
||||
* `sheet.cells_width(colnr int) !int`: Finds the maximum string length of cells in a given column.
|
||||
* `sheet.rows_names_width_max() int`: Returns the maximum width of row names/aliases.
|
||||
* `sheet.rows_description_width_max() int`: Returns the maximum width of row descriptions.
|
||||
* `sheet.header() ![]string`: Generates column headers (e.g., "M1", "Q1", "Y1") based on `nrcol`.
|
||||
|
||||
### 1.2. Row
|
||||
|
||||
A `Row` represents a single horizontal line of data within a `Sheet`.
|
||||
|
||||
* **Properties:**
|
||||
* `name` (string): Unique identifier for the row.
|
||||
* `alias` (string, optional): Alternative name.
|
||||
* `description` (string): Textual description.
|
||||
* `tags` (string): Space-separated tags for categorization (e.g., "department:hr location:belgium").
|
||||
* `cells` ([]Cell): List of `Cell` objects.
|
||||
* `aggregatetype` (RowAggregateType): Defines default aggregation for this row (`.sum`, `.avg`, `.max`, `.min`).
|
||||
* **Properties:**
|
||||
* `name` (string): Unique identifier for the row.
|
||||
* `alias` (string, optional): Alternative name.
|
||||
* `description` (string): Textual description.
|
||||
* `tags` (string): Space-separated tags for categorization (e.g., "department:hr location:belgium").
|
||||
* `cells` ([]Cell): List of `Cell` objects.
|
||||
* `aggregatetype` (RowAggregateType): Defines default aggregation for this row (`.sum`, `.avg`, `.max`, `.min`).
|
||||
|
||||
* **Creation (within a Sheet):**
|
||||
|
||||
* **Creation (within a Sheet):**
|
||||
```v
|
||||
// Assuming 'my_sheet' is an existing Sheet object
|
||||
mut salaries_row := my_sheet.row_new(
|
||||
@@ -65,21 +67,21 @@ A `Row` represents a single horizontal line of data within a `Sheet`.
|
||||
)!
|
||||
```
|
||||
|
||||
* **Key Operations:**
|
||||
* `row.values_get() []f64`: Returns all cell values in the row as a list of floats.
|
||||
* **Key Operations:**
|
||||
* `row.values_get() []f64`: Returns all cell values in the row as a list of floats.
|
||||
|
||||
### 1.3. Cell
|
||||
|
||||
A `Cell` is the fundamental unit of data, storing a numeric value.
|
||||
|
||||
* **Properties:**
|
||||
* `val` (f64): The numeric value.
|
||||
* `empty` (bool): `true` if the cell is empty.
|
||||
* **Properties:**
|
||||
* `val` (f64): The numeric value.
|
||||
* `empty` (bool): `true` if the cell is empty.
|
||||
|
||||
* **Key Operations:**
|
||||
* `cell.set(v string) !`: Sets the cell's value. Handles currency strings (e.g., "100 USD") by converting to the sheet's currency.
|
||||
* `cell.add(v f64)`: Adds a numeric value to the existing cell value.
|
||||
* `cell.repr() string`: Returns a formatted string representation of the value (e.g., "100.00", or "-" if empty).
|
||||
* **Key Operations:**
|
||||
* `cell.set(v string) !`: Sets the cell's value. Handles currency strings (e.g., "100 USD") by converting to the sheet's currency.
|
||||
* `cell.add(v f64)`: Adds a numeric value to the existing cell value.
|
||||
* `cell.repr() string`: Returns a formatted string representation of the value (e.g., "100.00", or "-" if empty).
|
||||
|
||||
## 2. Data Aggregation and Transformation
|
||||
|
||||
@@ -144,10 +146,10 @@ csv_string := my_sheet.export_csv(path: '')!
|
||||
println(csv_string)
|
||||
```
|
||||
|
||||
* **`ExportCSVArgs` Parameters:**
|
||||
* `path` (string, optional): File path. Empty string returns content as string. `~` is expanded to home directory.
|
||||
* `include_empty` (bool, optional, default: `false`): If `true`, empty cells are included.
|
||||
* `separator` (string, optional, default: `'|'`): Delimiter character.
|
||||
* **`ExportCSVArgs` Parameters:**
|
||||
* `path` (string, optional): File path. Empty string returns content as string. `~` is expanded to home directory.
|
||||
* `include_empty` (bool, optional, default: `false`): If `true`, empty cells are included.
|
||||
* `separator` (string, optional, default: `'|'`): Delimiter character.
|
||||
|
||||
## 4. Charting Capabilities
|
||||
|
||||
@@ -157,25 +159,26 @@ Integrates with ECharts for data visualization. Charting functions return an `ec
|
||||
|
||||
Used across line, bar, and pie charts to specify data and presentation.
|
||||
|
||||
* `rowname` (string, optional): Single row name or comma-separated list.
|
||||
* `namefilter` ([]string, optional): List of exact row names to include.
|
||||
* `includefilter` ([]string, optional): List of tags to include.
|
||||
* `excludefilter` ([]string, optional): List of tags to exclude.
|
||||
* `period_type` (PeriodType, optional): X-axis period (`.month`, `.quarter`, `.year`).
|
||||
* `aggregate` (bool, optional, default: `true`): Aggregate multiple matching rows.
|
||||
* `aggregatetype` (RowAggregateType, optional, default: `.sum`): Aggregation type.
|
||||
* `unit` (UnitType, optional): Data unit.
|
||||
* `title`, `title_sub` (string, optional): Chart titles.
|
||||
* `size` (string, optional): For pie charts, defines radius (e.g., "70%").
|
||||
* `rowname_show` (bool, optional, default: `true`): Show row name in legend.
|
||||
* `descr_show` (bool, optional, default: `false`): Show row description (overrides `rowname_show`).
|
||||
* `description` (string, optional): General chart description.
|
||||
* `rowname` (string, optional): Single row name or comma-separated list.
|
||||
* `namefilter` ([]string, optional): List of exact row names to include.
|
||||
* `includefilter` ([]string, optional): List of tags to include.
|
||||
* `excludefilter` ([]string, optional): List of tags to exclude.
|
||||
* `period_type` (PeriodType, optional): X-axis period (`.month`, `.quarter`, `.year`).
|
||||
* `aggregate` (bool, optional, default: `true`): Aggregate multiple matching rows.
|
||||
* `aggregatetype` (RowAggregateType, optional, default: `.sum`): Aggregation type.
|
||||
* `unit` (UnitType, optional): Data unit.
|
||||
* `title`, `title_sub` (string, optional): Chart titles.
|
||||
* `size` (string, optional): For pie charts, defines radius (e.g., "70%").
|
||||
* `rowname_show` (bool, optional, default: `true`): Show row name in legend.
|
||||
* `descr_show` (bool, optional, default: `false`): Show row description (overrides `rowname_show`).
|
||||
* `description` (string, optional): General chart description.
|
||||
|
||||
### 4.2. Chart Types
|
||||
|
||||
* **Line Chart (`line_chart`)**: Visualizes trends over time.
|
||||
* **Line Chart (`line_chart`)**: Visualizes trends over time.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.web.echarts // Required for EChartsOption type
|
||||
import incubaid.herolib.web.echarts // Required for EChartsOption type
|
||||
|
||||
line_chart_option := my_sheet.line_chart(
|
||||
rowname: 'revenue_row,expenses_row',
|
||||
@@ -184,7 +187,8 @@ Used across line, bar, and pie charts to specify data and presentation.
|
||||
)!
|
||||
```
|
||||
|
||||
* **Bar Chart (`bar_chart`)**: Compares discrete categories or values.
|
||||
* **Bar Chart (`bar_chart`)**: Compares discrete categories or values.
|
||||
|
||||
```v
|
||||
bar_chart_option := my_sheet.bar_chart(
|
||||
rowname: 'profit_row',
|
||||
@@ -193,7 +197,8 @@ Used across line, bar, and pie charts to specify data and presentation.
|
||||
)!
|
||||
```
|
||||
|
||||
* **Pie Chart (`pie_chart`)**: Shows proportions of categories.
|
||||
* **Pie Chart (`pie_chart`)**: Shows proportions of categories.
|
||||
|
||||
```v
|
||||
pie_chart_option := my_sheet.pie_chart(
|
||||
rowname: 'budget_allocation_row',
|
||||
|
||||
@@ -8,7 +8,7 @@ Chalk offers functions:- `console.color_fg(text string, color string)` - To chan
|
||||
Example:
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.ui.console
|
||||
import incubaid.herolib.ui.console
|
||||
|
||||
# basic usage
|
||||
println('I am really ' + console.color_fg('happy', 'green'))
|
||||
|
||||
@@ -6,39 +6,39 @@ the following is a good pragmatic way to remember clients, installers as a globa
|
||||
|
||||
module docsite
|
||||
|
||||
import freeflowuniverse.herolib.core.texttools
|
||||
import incubaid.herolib.core.texttools
|
||||
|
||||
__global (
|
||||
siteconfigs map[string]&SiteConfig
|
||||
siteconfigs map[string]&SiteConfig
|
||||
)
|
||||
|
||||
@[params]
|
||||
pub struct FactoryArgs {
|
||||
pub mut:
|
||||
name string = "default"
|
||||
name string = "default"
|
||||
}
|
||||
|
||||
pub fn new(args FactoryArgs) !&SiteConfig {
|
||||
name := texttools.name_fix(args.name)
|
||||
siteconfigs[name] = &SiteConfig{
|
||||
name: name
|
||||
}
|
||||
return get(name:name)!
|
||||
name := texttools.name_fix(args.name)
|
||||
siteconfigs[name] = &SiteConfig{
|
||||
name: name
|
||||
}
|
||||
return get(name:name)!
|
||||
}
|
||||
|
||||
pub fn get(args FactoryArgs) !&SiteConfig {
|
||||
name := texttools.name_fix(args.name)
|
||||
mut sc := siteconfigs[name] or {
|
||||
return error('siteconfig with name "${name}" does not exist')
|
||||
}
|
||||
return sc
|
||||
name := texttools.name_fix(args.name)
|
||||
mut sc := siteconfigs[name] or {
|
||||
return error('siteconfig with name "${name}" does not exist')
|
||||
}
|
||||
return sc
|
||||
}
|
||||
|
||||
pub fn default() !&SiteConfig {
|
||||
if siteconfigs.len == 0 {
|
||||
return new(name:'default')!
|
||||
}
|
||||
return get()!
|
||||
if siteconfigs.len == 0 {
|
||||
return new(name:'default')!
|
||||
}
|
||||
return get()!
|
||||
}
|
||||
|
||||
```
|
||||
@@ -6,49 +6,49 @@ HeroScript is a concise scripting language with the following structure:
|
||||
|
||||
```heroscript
|
||||
!!actor.action_name
|
||||
param1: 'value1'
|
||||
param2: 'value with spaces'
|
||||
multiline_description: '
|
||||
This is a multiline description.
|
||||
It can span multiple lines.
|
||||
'
|
||||
arg1 arg2 // Arguments without keys
|
||||
param1: 'value1'
|
||||
param2: 'value with spaces'
|
||||
multiline_description: '
|
||||
This is a multiline description.
|
||||
It can span multiple lines.
|
||||
'
|
||||
arg1 arg2 // Arguments without keys
|
||||
```
|
||||
|
||||
Key characteristics:
|
||||
- **Actions**: Start with `!!`, followed by `actor.action_name` (e.g., `!!mailclient.configure`).
|
||||
- **Parameters**: Defined as `key:value`. Values can be quoted for spaces.
|
||||
- **Multiline Support**: Parameters like `description` can span multiple lines.
|
||||
- **Arguments**: Values without keys (e.g., `arg1`).
|
||||
|
||||
- **Actions**: Start with `!!`, followed by `actor.action_name` (e.g., `!!mailclient.configure`).
|
||||
- **Parameters**: Defined as `key:value`. Values can be quoted for spaces.
|
||||
- **Multiline Support**: Parameters like `description` can span multiple lines.
|
||||
- **Arguments**: Values without keys (e.g., `arg1`).
|
||||
|
||||
## Processing HeroScript in Vlang
|
||||
|
||||
HeroScript can be parsed into a `playbook.PlayBook` object, allowing structured access to actions and their parameters, this is used in most of the herolib modules, it allows configuration or actions in a structured way.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.playbook { PlayBook }
|
||||
import freeflowuniverse.herolib.ui.console
|
||||
import incubaid.herolib.core.playbook { PlayBook }
|
||||
import incubaid.herolib.ui.console
|
||||
|
||||
pub fn play(mut plbook PlayBook) ! {
|
||||
|
||||
if plbook.exists_once(filter: 'docusaurus.define') {
|
||||
mut action := plbook.get(filter: 'docusaurus.define')!
|
||||
mut p := action.params
|
||||
//example how we get parameters from the action see core_params.md for more details
|
||||
ds = new(
|
||||
path: p.get_default('path_publish', '')!
|
||||
production: p.get_default_false('production')
|
||||
)!
|
||||
}
|
||||
if plbook.exists_once(filter: 'docusaurus.define') {
|
||||
mut action := plbook.get(filter: 'docusaurus.define')!
|
||||
mut p := action.params
|
||||
//example how we get parameters from the action see aiprompts/herolib_core/core_params.md for more details
|
||||
path_build := p.get_default('path_build', '')!
|
||||
path_publish := p.get_default('path_publish', '')!
|
||||
reset := p.get_default_false('reset')
|
||||
use_doctree := p.get_default_false('use_doctree')
|
||||
}
|
||||
|
||||
// Process 'docusaurus.add' actions to configure individual Docusaurus sites
|
||||
actions := plbook.find(filter: 'docusaurus.add')!
|
||||
for action in actions {
|
||||
mut p := action.params
|
||||
//do more processing here
|
||||
}
|
||||
// Process 'docusaurus.add' actions to configure individual Docusaurus sites
|
||||
actions := plbook.find(filter: 'docusaurus.add')!
|
||||
for action in actions {
|
||||
mut p := action.params
|
||||
//do more processing here
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
For detailed information on parameter retrieval methods (e.g., `p.get()`, `p.get_int()`, `p.get_default_true()`), refer to `aiprompts/ai_core/core_params.md`.
|
||||
|
||||
For detailed information on parameter retrieval methods (e.g., `p.get()`, `p.get_int()`, `p.get_default_true()`), refer to `aiprompts/herolib_core/core_params.md`.
|
||||
|
||||
@@ -5,8 +5,8 @@
|
||||
HeroScript can be parsed into a `playbook.PlayBook` object, allowing structured access to actions and their parameters.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.playbook
|
||||
import freeflowuniverse.herolib.core.playcmds
|
||||
import incubaid.herolib.core.playbook
|
||||
import incubaid.herolib.core.playcmds
|
||||
|
||||
// path string
|
||||
// text string
|
||||
@@ -21,5 +21,3 @@ mut plbook := playbook.new(path: "....")!
|
||||
playcmds.run(mut plbook)!
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
The `HTTPConnection` module provides a robust HTTP client for Vlang, supporting JSON, custom headers, retries, and caching.
|
||||
|
||||
## Key Features
|
||||
|
||||
- Type-safe JSON methods
|
||||
- Custom headers
|
||||
- Retry mechanism
|
||||
@@ -12,7 +13,7 @@ The `HTTPConnection` module provides a robust HTTP client for Vlang, supporting
|
||||
## Basic Usage
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.httpconnection
|
||||
import incubaid.herolib.core.httpconnection
|
||||
|
||||
// Create a new HTTP connection
|
||||
mut conn := httpconnection.new(
|
||||
@@ -30,17 +31,17 @@ To integrate `HTTPConnection` into a management class (e.g., `HetznerManager`),
|
||||
```v
|
||||
// Example: HetznerManager
|
||||
pub fn (mut h HetznerManager) connection() !&httpconnection.HTTPConnection {
|
||||
mut c := h.conn or {
|
||||
mut c2 := httpconnection.new(
|
||||
name: 'hetzner_${h.name}'
|
||||
url: h.baseurl
|
||||
cache: true
|
||||
retry: 3
|
||||
)!
|
||||
c2.basic_auth(h.user, h.password)
|
||||
c2
|
||||
}
|
||||
return c
|
||||
mut c := h.conn or {
|
||||
mut c2 := httpconnection.new(
|
||||
name: 'hetzner_${h.name}'
|
||||
url: h.baseurl
|
||||
cache: true
|
||||
retry: 3
|
||||
)!
|
||||
c2.basic_auth(h.user, h.password)
|
||||
c2
|
||||
}
|
||||
return c
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
@@ -1,9 +1,12 @@
|
||||
# OSAL Core Module - Key Capabilities (freeflowuniverse.herolib.osal.core)
|
||||
# OSAL Core Module - Key Capabilities (incubaid.herolib.osal.core)
|
||||
|
||||
> **Note:** Platform detection functions (`platform()` and `cputype()`) have moved to `incubaid.herolib.core`.
|
||||
> Use `import incubaid.herolib.core` and call `core.platform()!` and `core.cputype()!` instead.
|
||||
|
||||
```v
|
||||
//example how to get started
|
||||
|
||||
import freeflowuniverse.herolib.osal.core as osal
|
||||
import incubaid.herolib.osal.core as osal
|
||||
|
||||
job := osal.exec(cmd: 'ls /')!
|
||||
```
|
||||
@@ -12,70 +15,70 @@ This document describes the core functionalities of the Operating System Abstrac
|
||||
|
||||
## 1. Process Execution
|
||||
|
||||
* **`osal.exec(cmd: Command) !Job`**: Execute a shell command.
|
||||
* **Key Parameters**: `cmd` (string), `timeout` (int), `retry` (int), `work_folder` (string), `environment` (map[string]string), `stdout` (bool), `raise_error` (bool).
|
||||
* **Returns**: `Job` (status, output, error, exit code).
|
||||
* **`osal.execute_silent(cmd string) !string`**: Execute silently, return output.
|
||||
* **`osal.execute_debug(cmd string) !string`**: Execute with debug output, return output.
|
||||
* **`osal.execute_stdout(cmd string) !string`**: Execute and print output to stdout, return output.
|
||||
* **`osal.execute_interactive(cmd string) !`**: Execute in an interactive shell.
|
||||
* **`osal.cmd_exists(cmd string) bool`**: Check if a command exists.
|
||||
* **`osal.exec(cmd: Command) !Job`**: Execute a shell command.
|
||||
* **Key Parameters**: `cmd` (string), `timeout` (int), `retry` (int), `work_folder` (string), `environment` (map[string]string), `stdout` (bool), `raise_error` (bool).
|
||||
* **Returns**: `Job` (status, output, error, exit code).
|
||||
* **`osal.execute_silent(cmd string) !string`**: Execute silently, return output.
|
||||
* **`osal.execute_debug(cmd string) !string`**: Execute with debug output, return output.
|
||||
* **`osal.execute_stdout(cmd string) !string`**: Execute and print output to stdout, return output.
|
||||
* **`osal.execute_interactive(cmd string) !`**: Execute in an interactive shell.
|
||||
* **`osal.cmd_exists(cmd string) bool`**: Check if a command exists.
|
||||
|
||||
## 2. Network Utilities
|
||||
|
||||
* **`osal.ping(args: PingArgs) !bool`**: Check host reachability.
|
||||
- address string = "8.8.8.8"
|
||||
- nr_ping u16 = 3 // amount of ping requests we will do
|
||||
- nr_ok u16 = 3 //how many of them need to be ok
|
||||
- retry u8 //how many times fo we retry above sequence, basically we ping ourselves with -c 1
|
||||
* **`osal.ping(args: PingArgs) !bool`**: Check host reachability.
|
||||
- address string = "8.8.8.8"
|
||||
- nr_ping u16 = 3 // amount of ping requests we will do
|
||||
- nr_ok u16 = 3 //how many of them need to be ok
|
||||
- retry u8 //how many times fo we retry above sequence, basically we ping ourselves with -c 1
|
||||
**`osal.ipaddr_pub_get() !string`**: Get public IP address.
|
||||
|
||||
## 3. File System Operations
|
||||
|
||||
* **`osal.file_write(path string, text string) !`**: Write text to a file.
|
||||
* **`osal.file_read(path string) !string`**: Read content from a file.
|
||||
* **`osal.dir_ensure(path string) !`**: Ensure a directory exists.
|
||||
* **`osal.rm(todelete string) !`**: Remove files/directories.
|
||||
* **`osal.file_write(path string, text string) !`**: Write text to a file.
|
||||
* **`osal.file_read(path string) !string`**: Read content from a file.
|
||||
* **`osal.dir_ensure(path string) !`**: Ensure a directory exists.
|
||||
* **`osal.rm(todelete string) !`**: Remove files/directories.
|
||||
|
||||
## 4. Environment Variables
|
||||
|
||||
* **`osal.env_set(args: EnvSet)`**: Set an environment variable.
|
||||
* **Key Parameters**: `key` (string), `value` (string).
|
||||
* **`osal.env_unset(key string)`**: Unset a specific environment variable.
|
||||
* **`osal.env_unset_all()`**: Unset all environment variables.
|
||||
* **`osal.env_set_all(args: EnvSetAll)`**: Set multiple environment variables.
|
||||
* **Key Parameters**: `env` (map[string]string), `clear_before_set` (bool), `overwrite_if_exists` (bool).
|
||||
* **`osal.env_get(key string) !string`**: Get an environment variable's value.
|
||||
* **`osal.env_exists(key string) !bool`**: Check if an environment variable exists.
|
||||
* **`osal.env_get_default(key string, def string) string`**: Get an environment variable or a default value.
|
||||
* **`osal.load_env_file(file_path string) !`**: Load variables from a file.
|
||||
* **`osal.env_set(args: EnvSet)`**: Set an environment variable.
|
||||
* **Key Parameters**: `key` (string), `value` (string).
|
||||
* **`osal.env_unset(key string)`**: Unset a specific environment variable.
|
||||
* **`osal.env_unset_all()`**: Unset all environment variables.
|
||||
* **`osal.env_set_all(args: EnvSetAll)`**: Set multiple environment variables.
|
||||
* **Key Parameters**: `env` (map[string]string), `clear_before_set` (bool), `overwrite_if_exists` (bool).
|
||||
* **`osal.env_get(key string) !string`**: Get an environment variable's value.
|
||||
* **`osal.env_exists(key string) !bool`**: Check if an environment variable exists.
|
||||
* **`osal.env_get_default(key string, def string) string`**: Get an environment variable or a default value.
|
||||
* **`osal.load_env_file(file_path string) !`**: Load variables from a file.
|
||||
|
||||
## 5. Command & Profile Management
|
||||
|
||||
* **`osal.cmd_add(args: CmdAddArgs) !`**: Add a binary to system paths and update profiles.
|
||||
* **Key Parameters**: `source` (string, required), `cmdname` (string).
|
||||
* **`osal.profile_path_add_remove(args: ProfilePathAddRemoveArgs) !`**: Add/remove paths from profiles.
|
||||
* **Key Parameters**: `paths2add` (string), `paths2delete` (string).
|
||||
* **`osal.cmd_add(args: CmdAddArgs) !`**: Add a binary to system paths and update profiles.
|
||||
* **Key Parameters**: `source` (string, required), `cmdname` (string).
|
||||
* **`osal.profile_path_add_remove(args: ProfilePathAddRemoveArgs) !`**: Add/remove paths from profiles.
|
||||
* **Key Parameters**: `paths2add` (string), `paths2delete` (string).
|
||||
|
||||
## 6. System Information & Utilities
|
||||
|
||||
* **`osal.processmap_get() !ProcessMap`**: Get a map of all running processes.
|
||||
* **`osal.processinfo_get(pid int) !ProcessInfo`**: Get detailed information for a specific process.
|
||||
* **`osal.processinfo_get_byname(name string) ![]ProcessInfo`**: Get info for processes matching a name.
|
||||
* **`osal.process_exists(pid int) bool`**: Check if a process exists by PID.
|
||||
* **`osal.processinfo_with_children(pid int) !ProcessMap`**: Get a process and its children.
|
||||
* **`osal.processinfo_children(pid int) !ProcessMap`**: Get children of a process.
|
||||
* **`osal.process_kill_recursive(args: ProcessKillArgs) !`**: Kill a process and its children.
|
||||
* **Key Parameters**: `name` (string), `pid` (int).
|
||||
* **`osal.whoami() !string`**: Return the current username.
|
||||
* **`osal.platform() !PlatformType`**: Identify the operating system.
|
||||
* **`osal.cputype() !CPUType`**: Identify the CPU architecture.
|
||||
* **`osal.hostname() !string`**: Get system hostname.
|
||||
* **`osal.sleep(duration int)`**: Pause execution for a specified duration.
|
||||
* **`osal.download(args: DownloadArgs) !pathlib.Path`**: Download a file from a URL.
|
||||
* `pathlib.Path` is from `freeflowuniverse.herolib.core.pathlib`
|
||||
* **Key Parameters**: `url` (string), `dest` (string), `timeout` (int), `retry` (int).
|
||||
* **`osal.user_exists(username string) bool`**: Check if a user exists.
|
||||
* **`osal.user_id_get(username string) !int`**: Get user ID.
|
||||
* **`osal.user_add(args: UserArgs) !int`**: Add a user.
|
||||
* **Key Parameters**: `name` (string).
|
||||
* **`osal.processmap_get() !ProcessMap`**: Get a map of all running processes.
|
||||
* **`osal.processinfo_get(pid int) !ProcessInfo`**: Get detailed information for a specific process.
|
||||
* **`osal.processinfo_get_byname(name string) ![]ProcessInfo`**: Get info for processes matching a name.
|
||||
* **`osal.process_exists(pid int) bool`**: Check if a process exists by PID.
|
||||
* **`osal.processinfo_with_children(pid int) !ProcessMap`**: Get a process and its children.
|
||||
* **`osal.processinfo_children(pid int) !ProcessMap`**: Get children of a process.
|
||||
* **`osal.process_kill_recursive(args: ProcessKillArgs) !`**: Kill a process and its children.
|
||||
* **Key Parameters**: `name` (string), `pid` (int).
|
||||
* **`osal.whoami() !string`**: Return the current username.
|
||||
* ~~**`osal.platform() !PlatformType`**: Identify the operating system.~~ → **Moved to `incubaid.herolib.core`**
|
||||
* ~~**`osal.cputype() !CPUType`**: Identify the CPU architecture.~~ → **Moved to `incubaid.herolib.core`**
|
||||
* **`osal.hostname() !string`**: Get system hostname.
|
||||
* **`osal.sleep(duration int)`**: Pause execution for a specified duration.
|
||||
* **`osal.download(args: DownloadArgs) !pathlib.Path`**: Download a file from a URL.
|
||||
* `pathlib.Path` is from `incubaid.herolib.core.pathlib`
|
||||
* **Key Parameters**: `url` (string), `dest` (string), `timeout` (int), `retry` (int).
|
||||
* **`osal.user_exists(username string) bool`**: Check if a user exists.
|
||||
* **`osal.user_id_get(username string) !int`**: Get user ID.
|
||||
* **`osal.user_add(args: UserArgs) !int`**: Add a user.
|
||||
* **Key Parameters**: `name` (string).
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
The `OurTime` module in V provides flexible time handling, supporting relative and absolute time formats, Unix timestamps, and formatting utilities.
|
||||
|
||||
## Key Features
|
||||
|
||||
- Create time objects from strings or current time
|
||||
- Relative time expressions (e.g., `+1h`, `-2d`)
|
||||
- Absolute time formats (e.g., `YYYY-MM-DD HH:mm:ss`)
|
||||
@@ -12,7 +13,7 @@ The `OurTime` module in V provides flexible time handling, supporting relative a
|
||||
## Basic Usage
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.data.ourtime
|
||||
import incubaid.herolib.data.ourtime
|
||||
|
||||
// Current time
|
||||
mut t := ourtime.now()
|
||||
|
||||
@@ -5,7 +5,7 @@ This document details the `paramsparser` module, essential for handling paramete
|
||||
## Obtaining a `paramsparser` Instance
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.data.paramsparser
|
||||
import incubaid.herolib.data.paramsparser
|
||||
|
||||
// Create new params from a string
|
||||
params := paramsparser.new("color:red size:'large' priority:1 enable:true")!
|
||||
@@ -19,12 +19,13 @@ params.set("color", "red")
|
||||
|
||||
The parser supports various input formats:
|
||||
|
||||
1. **Key-value pairs**: `key:value`
|
||||
2. **Quoted values**: `key:'value with spaces'` (single or double quotes)
|
||||
3. **Arguments without keys**: `arg1 arg2` (accessed by index)
|
||||
4. **Comments**: `// this is a comment` (ignored during parsing)
|
||||
1. **Key-value pairs**: `key:value`
|
||||
2. **Quoted values**: `key:'value with spaces'` (single or double quotes)
|
||||
3. **Arguments without keys**: `arg1 arg2` (accessed by index)
|
||||
4. **Comments**: `// this is a comment` (ignored during parsing)
|
||||
|
||||
Example:
|
||||
|
||||
```v
|
||||
text := "name:'John Doe' age:30 active:true // user details"
|
||||
params := paramsparser.new(text)!
|
||||
@@ -36,74 +37,74 @@ The `paramsparser` module provides a comprehensive set of methods for retrieving
|
||||
|
||||
### Basic Retrieval
|
||||
|
||||
- `get(key string) !string`: Retrieves a string value by key. Returns an error if the key does not exist.
|
||||
- `get_default(key string, defval string) !string`: Retrieves a string value by key, or returns `defval` if the key is not found.
|
||||
- `exists(key string) bool`: Checks if a keyword argument (`key:value`) exists.
|
||||
- `exists_arg(key string) bool`: Checks if an argument (value without a key) exists.
|
||||
- `get(key string) !string`: Retrieves a string value by key. Returns an error if the key does not exist.
|
||||
- `get_default(key string, defval string) !string`: Retrieves a string value by key, or returns `defval` if the key is not found.
|
||||
- `exists(key string) bool`: Checks if a keyword argument (`key:value`) exists.
|
||||
- `exists_arg(key string) bool`: Checks if an argument (value without a key) exists.
|
||||
|
||||
### Argument Retrieval (Positional)
|
||||
|
||||
- `get_arg(nr int) !string`: Retrieves an argument by its 0-based index. Returns an error if the index is out of bounds.
|
||||
- `get_arg_default(nr int, defval string) !string`: Retrieves an argument by index, or returns `defval` if the index is out of bounds.
|
||||
- `get_arg(nr int) !string`: Retrieves an argument by its 0-based index. Returns an error if the index is out of bounds.
|
||||
- `get_arg_default(nr int, defval string) !string`: Retrieves an argument by index, or returns `defval` if the index is out of bounds.
|
||||
|
||||
### Type-Specific Retrieval
|
||||
|
||||
- `get_int(key string) !int`: Converts and retrieves an integer (int32).
|
||||
- `get_int_default(key string, defval int) !int`: Retrieves an integer with a default.
|
||||
- `get_u32(key string) !u32`: Converts and retrieves an unsigned 32-bit integer.
|
||||
- `get_u32_default(key string, defval u32) !u32`: Retrieves a u32 with a default.
|
||||
- `get_u64(key string) !u64`: Converts and retrieves an unsigned 64-bit integer.
|
||||
- `get_u64_default(key string, defval u64) !u64`: Retrieves a u64 with a default.
|
||||
- `get_u8(key string) !u8`: Converts and retrieves an unsigned 8-bit integer.
|
||||
- `get_u8_default(key string, defval u8) !u8`: Retrieves a u8 with a default.
|
||||
- `get_float(key string) !f64`: Converts and retrieves a 64-bit float.
|
||||
- `get_float_default(key string, defval f64) !f64`: Retrieves a float with a default.
|
||||
- `get_percentage(key string) !f64`: Converts a percentage string (e.g., "80%") to a float (0.8).
|
||||
- `get_percentage_default(key string, defval string) !f64`: Retrieves a percentage with a default.
|
||||
- `get_int(key string) !int`: Converts and retrieves an integer (int32).
|
||||
- `get_int_default(key string, defval int) !int`: Retrieves an integer with a default.
|
||||
- `get_u32(key string) !u32`: Converts and retrieves an unsigned 32-bit integer.
|
||||
- `get_u32_default(key string, defval u32) !u32`: Retrieves a u32 with a default.
|
||||
- `get_u64(key string) !u64`: Converts and retrieves an unsigned 64-bit integer.
|
||||
- `get_u64_default(key string, defval u64) !u64`: Retrieves a u64 with a default.
|
||||
- `get_u8(key string) !u8`: Converts and retrieves an unsigned 8-bit integer.
|
||||
- `get_u8_default(key string, defval u8) !u8`: Retrieves a u8 with a default.
|
||||
- `get_float(key string) !f64`: Converts and retrieves a 64-bit float.
|
||||
- `get_float_default(key string, defval f64) !f64`: Retrieves a float with a default.
|
||||
- `get_percentage(key string) !f64`: Converts a percentage string (e.g., "80%") to a float (0.8).
|
||||
- `get_percentage_default(key string, defval string) !f64`: Retrieves a percentage with a default.
|
||||
|
||||
### Boolean Retrieval
|
||||
|
||||
- `get_default_true(key string) bool`: Returns `true` if the value is empty, "1", "true", "y", or "yes". Otherwise `false`.
|
||||
- `get_default_false(key string) bool`: Returns `false` if the value is empty, "0", "false", "n", or "no". Otherwise `true`.
|
||||
- `get_default_true(key string) bool`: Returns `true` if the value is empty, "1", "true", "y", or "yes". Otherwise `false`.
|
||||
- `get_default_false(key string) bool`: Returns `false` if the value is empty, "0", "false", "n", or "no". Otherwise `true`.
|
||||
|
||||
### List Retrieval
|
||||
|
||||
Lists are typically comma-separated strings (e.g., `users: "john,jane,bob"`).
|
||||
|
||||
- `get_list(key string) ![]string`: Retrieves a list of strings.
|
||||
- `get_list_default(key string, def []string) ![]string`: Retrieves a list of strings with a default.
|
||||
- `get_list_int(key string) ![]int`: Retrieves a list of integers.
|
||||
- `get_list_int_default(key string, def []int) []int`: Retrieves a list of integers with a default.
|
||||
- `get_list_f32(key string) ![]f32`: Retrieves a list of 32-bit floats.
|
||||
- `get_list_f32_default(key string, def []f32) []f32`: Retrieves a list of f32 with a default.
|
||||
- `get_list_f64(key string) ![]f64`: Retrieves a list of 64-bit floats.
|
||||
- `get_list_f64_default(key string, def []f64) []f64`: Retrieves a list of f64 with a default.
|
||||
- `get_list_i8(key string) ![]i8`: Retrieves a list of 8-bit signed integers.
|
||||
- `get_list_i8_default(key string, def []i8) []i8`: Retrieves a list of i8 with a default.
|
||||
- `get_list_i16(key string) ![]i16`: Retrieves a list of 16-bit signed integers.
|
||||
- `get_list_i16_default(key string, def []i16) []i16`: Retrieves a list of i16 with a default.
|
||||
- `get_list_i64(key string) ![]i64`: Retrieves a list of 64-bit signed integers.
|
||||
- `get_list_i64_default(key string, def []i64) []i64`: Retrieves a list of i64 with a default.
|
||||
- `get_list_u16(key string) ![]u16`: Retrieves a list of 16-bit unsigned integers.
|
||||
- `get_list_u16_default(key string, def []u16) []u16`: Retrieves a list of u16 with a default.
|
||||
- `get_list_u32(key string) ![]u32`: Retrieves a list of 32-bit unsigned integers.
|
||||
- `get_list_u32_default(key string, def []u32) []u32`: Retrieves a list of u32 with a default.
|
||||
- `get_list_u64(key string) ![]u64`: Retrieves a list of 64-bit unsigned integers.
|
||||
- `get_list_u64_default(key string, def []u64) []u64`: Retrieves a list of u64 with a default.
|
||||
- `get_list_namefix(key string) ![]string`: Retrieves a list of strings, normalizing each item (e.g., "My Name" -> "my_name").
|
||||
- `get_list_namefix_default(key string, def []string) ![]string`: Retrieves a list of name-fixed strings with a default.
|
||||
- `get_list(key string) ![]string`: Retrieves a list of strings.
|
||||
- `get_list_default(key string, def []string) ![]string`: Retrieves a list of strings with a default.
|
||||
- `get_list_int(key string) ![]int`: Retrieves a list of integers.
|
||||
- `get_list_int_default(key string, def []int) []int`: Retrieves a list of integers with a default.
|
||||
- `get_list_f32(key string) ![]f32`: Retrieves a list of 32-bit floats.
|
||||
- `get_list_f32_default(key string, def []f32) []f32`: Retrieves a list of f32 with a default.
|
||||
- `get_list_f64(key string) ![]f64`: Retrieves a list of 64-bit floats.
|
||||
- `get_list_f64_default(key string, def []f64) []f64`: Retrieves a list of f64 with a default.
|
||||
- `get_list_i8(key string) ![]i8`: Retrieves a list of 8-bit signed integers.
|
||||
- `get_list_i8_default(key string, def []i8) []i8`: Retrieves a list of i8 with a default.
|
||||
- `get_list_i16(key string) ![]i16`: Retrieves a list of 16-bit signed integers.
|
||||
- `get_list_i16_default(key string, def []i16) []i16`: Retrieves a list of i16 with a default.
|
||||
- `get_list_i64(key string) ![]i64`: Retrieves a list of 64-bit signed integers.
|
||||
- `get_list_i64_default(key string, def []i64) []i64`: Retrieves a list of i64 with a default.
|
||||
- `get_list_u16(key string) ![]u16`: Retrieves a list of 16-bit unsigned integers.
|
||||
- `get_list_u16_default(key string, def []u16) []u16`: Retrieves a list of u16 with a default.
|
||||
- `get_list_u32(key string) ![]u32`: Retrieves a list of 32-bit unsigned integers.
|
||||
- `get_list_u32_default(key string, def []u32) []u32`: Retrieves a list of u32 with a default.
|
||||
- `get_list_u64(key string) ![]u64`: Retrieves a list of 64-bit unsigned integers.
|
||||
- `get_list_u64_default(key string, def []u64) []u64`: Retrieves a list of u64 with a default.
|
||||
- `get_list_namefix(key string) ![]string`: Retrieves a list of strings, normalizing each item (e.g., "My Name" -> "my_name").
|
||||
- `get_list_namefix_default(key string, def []string) ![]string`: Retrieves a list of name-fixed strings with a default.
|
||||
|
||||
### Specialized Retrieval
|
||||
|
||||
- `get_map() map[string]string`: Returns all parameters as a map.
|
||||
- `get_path(key string) !string`: Retrieves a path string.
|
||||
- `get_path_create(key string) !string`: Retrieves a path string, creating the directory if it doesn't exist.
|
||||
- `get_from_hashmap(key string, defval string, hashmap map[string]string) !string`: Retrieves a value from a provided hashmap based on the parameter's value.
|
||||
- `get_storagecapacity_in_bytes(key string) !u64`: Converts storage capacity strings (e.g., "10 GB", "500 MB") to bytes (u64).
|
||||
- `get_storagecapacity_in_bytes_default(key string, defval u64) !u64`: Retrieves storage capacity in bytes with a default.
|
||||
- `get_storagecapacity_in_gigabytes(key string) !u64`: Converts storage capacity strings to gigabytes (u64).
|
||||
- `get_time(key string) !ourtime.OurTime`: Parses a time string (relative or absolute) into an `ourtime.OurTime` object.
|
||||
- `get_time_default(key string, defval ourtime.OurTime) !ourtime.OurTime`: Retrieves time with a default.
|
||||
- `get_time_interval(key string) !Duration`: Parses a time interval string into a `Duration` object.
|
||||
- `get_timestamp(key string) !Duration`: Parses a timestamp string into a `Duration` object.
|
||||
- `get_timestamp_default(key string, defval Duration) !Duration`: Retrieves a timestamp with a default.
|
||||
- `get_map() map[string]string`: Returns all parameters as a map.
|
||||
- `get_path(key string) !string`: Retrieves a path string.
|
||||
- `get_path_create(key string) !string`: Retrieves a path string, creating the directory if it doesn't exist.
|
||||
- `get_from_hashmap(key string, defval string, hashmap map[string]string) !string`: Retrieves a value from a provided hashmap based on the parameter's value.
|
||||
- `get_storagecapacity_in_bytes(key string) !u64`: Converts storage capacity strings (e.g., "10 GB", "500 MB") to bytes (u64).
|
||||
- `get_storagecapacity_in_bytes_default(key string, defval u64) !u64`: Retrieves storage capacity in bytes with a default.
|
||||
- `get_storagecapacity_in_gigabytes(key string) !u64`: Converts storage capacity strings to gigabytes (u64).
|
||||
- `get_time(key string) !ourtime.OurTime`: Parses a time string (relative or absolute) into an `ourtime.OurTime` object.
|
||||
- `get_time_default(key string, defval ourtime.OurTime) !ourtime.OurTime`: Retrieves time with a default.
|
||||
- `get_time_interval(key string) !Duration`: Parses a time interval string into a `Duration` object.
|
||||
- `get_timestamp(key string) !Duration`: Parses a timestamp string into a `Duration` object.
|
||||
- `get_timestamp_default(key string, defval Duration) !Duration`: Retrieves a timestamp with a default.
|
||||
|
||||
@@ -14,8 +14,9 @@ The pathlib module provides a comprehensive interface for handling file system o
|
||||
## Basic Usage
|
||||
|
||||
### Importing pathlib
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.pathlib
|
||||
import incubaid.herolib.core.pathlib
|
||||
```
|
||||
|
||||
### Creating Path Objects
|
||||
@@ -33,6 +34,7 @@ mut dir_path := pathlib.get("path/to/directory")
|
||||
if you know in advance if you expect a dir or file its better to use `pathlib.get_dir(path:...,create:true)` or `pathlib.get_file(path:...,create:true)`.
|
||||
|
||||
### Basic Path Operations
|
||||
|
||||
```v
|
||||
// Get absolute path
|
||||
abs_path := file_path.absolute()
|
||||
@@ -49,6 +51,7 @@ if file_path.exists() {
|
||||
## Path Properties and Methods
|
||||
|
||||
### Path Types
|
||||
|
||||
```v
|
||||
// Check if path is a file
|
||||
if file_path.is_file() {
|
||||
@@ -67,6 +70,7 @@ if file_path.is_link() {
|
||||
```
|
||||
|
||||
### Path Normalization
|
||||
|
||||
```v
|
||||
// Normalize path (remove extra slashes, resolve . and ..)
|
||||
normalized_path := file_path.path_normalize()
|
||||
@@ -81,6 +85,7 @@ name_no_ext := file_path.name_no_ext()
|
||||
## File and Directory Operations
|
||||
|
||||
### File Operations
|
||||
|
||||
```v
|
||||
// Write to file
|
||||
file_path.write("Content to write")!
|
||||
@@ -93,6 +98,7 @@ file_path.delete()!
|
||||
```
|
||||
|
||||
### Directory Operations
|
||||
|
||||
```v
|
||||
// Create directory
|
||||
mut dir := pathlib.get_dir(
|
||||
@@ -108,6 +114,7 @@ dir.delete()!
|
||||
```
|
||||
|
||||
### Symlink Operations
|
||||
|
||||
```v
|
||||
// Create symlink
|
||||
file_path.link("path/to/symlink", delete_exists: true)!
|
||||
@@ -119,12 +126,14 @@ real_path := file_path.realpath()
|
||||
## Advanced Operations
|
||||
|
||||
### Path Copying
|
||||
|
||||
```v
|
||||
// Copy file to destination
|
||||
file_path.copy(dest: "path/to/destination")!
|
||||
```
|
||||
|
||||
### Recursive Operations
|
||||
|
||||
```v
|
||||
// List directory recursively
|
||||
mut recursive_list := dir.list(recursive: true)!
|
||||
@@ -134,6 +143,7 @@ dir.delete()!
|
||||
```
|
||||
|
||||
### Path Filtering
|
||||
|
||||
```v
|
||||
// List files matching pattern
|
||||
mut filtered_list := dir.list(
|
||||
@@ -145,6 +155,7 @@ mut filtered_list := dir.list(
|
||||
## Best Practices
|
||||
|
||||
### Error Handling
|
||||
|
||||
```v
|
||||
if file_path.exists() {
|
||||
// Safe to operate
|
||||
@@ -152,4 +163,3 @@ if file_path.exists() {
|
||||
// Handle missing file
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
@@ -4,17 +4,17 @@ The `redisclient` module in Herolib provides a comprehensive client for interact
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Direct Redis Commands**: Access to a wide range of Redis commands (strings, hashes, lists, keys, etc.).
|
||||
- **Caching**: Built-in caching mechanism with namespace support and expiration.
|
||||
- **Queues**: Simple queue implementation using Redis lists.
|
||||
- **RPC**: Remote Procedure Call (RPC) functionality over Redis queues for inter-service communication.
|
||||
- **Direct Redis Commands**: Access to a wide range of Redis commands (strings, hashes, lists, keys, etc.).
|
||||
- **Caching**: Built-in caching mechanism with namespace support and expiration.
|
||||
- **Queues**: Simple queue implementation using Redis lists.
|
||||
- **RPC**: Remote Procedure Call (RPC) functionality over Redis queues for inter-service communication.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
To get a Redis client instance, use `redisclient.core_get()`. By default, it connects to `127.0.0.1:6379`. You can specify a different address and port using the `RedisURL` struct.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.redisclient
|
||||
import incubaid.herolib.core.redisclient
|
||||
|
||||
// Connect to default Redis instance (127.0.0.1:6379)
|
||||
mut redis := redisclient.core_get()!
|
||||
@@ -42,13 +42,13 @@ The `Redis` object provides methods for most standard Redis commands. Here are s
|
||||
|
||||
### String Commands
|
||||
|
||||
- `set(key string, value string) !`: Sets the string value of a key.
|
||||
- `get(key string) !string`: Gets the string value of a key.
|
||||
- `set_ex(key string, value string, ex string) !`: Sets a key with an expiration time in seconds.
|
||||
- `incr(key string) !int`: Increments the integer value of a key by one.
|
||||
- `decr(key string) !int`: Decrements the integer value of a key by one.
|
||||
- `append(key string, value string) !int`: Appends a value to a key.
|
||||
- `strlen(key string) !int`: Gets the length of the value stored in a key.
|
||||
- `set(key string, value string) !`: Sets the string value of a key.
|
||||
- `get(key string) !string`: Gets the string value of a key.
|
||||
- `set_ex(key string, value string, ex string) !`: Sets a key with an expiration time in seconds.
|
||||
- `incr(key string) !int`: Increments the integer value of a key by one.
|
||||
- `decr(key string) !int`: Decrements the integer value of a key by one.
|
||||
- `append(key string, value string) !int`: Appends a value to a key.
|
||||
- `strlen(key string) !int`: Gets the length of the value stored in a key.
|
||||
|
||||
```v
|
||||
redis.set('counter', '10')!
|
||||
@@ -58,11 +58,11 @@ val := redis.get('counter')! // "11"
|
||||
|
||||
### Hash Commands
|
||||
|
||||
- `hset(key string, skey string, value string) !`: Sets the string value of a hash field.
|
||||
- `hget(key string, skey string) !string`: Gets the value of a hash field.
|
||||
- `hgetall(key string) !map[string]string`: Gets all fields and values in a hash.
|
||||
- `hexists(key string, skey string) !bool`: Checks if a hash field exists.
|
||||
- `hdel(key string, skey string) !int`: Deletes one or more hash fields.
|
||||
- `hset(key string, skey string, value string) !`: Sets the string value of a hash field.
|
||||
- `hget(key string, skey string) !string`: Gets the value of a hash field.
|
||||
- `hgetall(key string) !map[string]string`: Gets all fields and values in a hash.
|
||||
- `hexists(key string, skey string) !bool`: Checks if a hash field exists.
|
||||
- `hdel(key string, skey string) !int`: Deletes one or more hash fields.
|
||||
|
||||
```v
|
||||
redis.hset('user:1', 'name', 'John Doe')!
|
||||
@@ -73,12 +73,12 @@ user_data := redis.hgetall('user:1')! // map['name':'John Doe', 'email':'john@ex
|
||||
|
||||
### List Commands
|
||||
|
||||
- `lpush(key string, element string) !int`: Inserts all specified values at the head of the list stored at key.
|
||||
- `rpush(key string, element string) !int`: Inserts all specified values at the tail of the list stored at key.
|
||||
- `lpop(key string) !string`: Removes and returns the first element of the list stored at key.
|
||||
- `rpop(key string) !string`: Removes and returns the last element of the list stored at key.
|
||||
- `llen(key string) !int`: Gets the length of a list.
|
||||
- `lrange(key string, start int, end int) ![]resp.RValue`: Gets a range of elements from a list.
|
||||
- `lpush(key string, element string) !int`: Inserts all specified values at the head of the list stored at key.
|
||||
- `rpush(key string, element string) !int`: Inserts all specified values at the tail of the list stored at key.
|
||||
- `lpop(key string) !string`: Removes and returns the first element of the list stored at key.
|
||||
- `rpop(key string) !string`: Removes and returns the last element of the list stored at key.
|
||||
- `llen(key string) !int`: Gets the length of a list.
|
||||
- `lrange(key string, start int, end int) ![]resp.RValue`: Gets a range of elements from a list.
|
||||
|
||||
```v
|
||||
redis.lpush('mylist', 'item1')!
|
||||
@@ -88,8 +88,8 @@ first_item := redis.lpop('mylist')! // "item1"
|
||||
|
||||
### Set Commands
|
||||
|
||||
- `sadd(key string, members []string) !int`: Adds the specified members to the set stored at key.
|
||||
- `smismember(key string, members []string) ![]int`: Returns if member is a member of the set stored at key.
|
||||
- `sadd(key string, members []string) !int`: Adds the specified members to the set stored at key.
|
||||
- `smismember(key string, members []string) ![]int`: Returns if member is a member of the set stored at key.
|
||||
|
||||
```v
|
||||
redis.sadd('myset', ['member1', 'member2'])!
|
||||
@@ -98,13 +98,13 @@ is_member := redis.smismember('myset', ['member1', 'member3'])! // [1, 0]
|
||||
|
||||
### Key Management
|
||||
|
||||
- `keys(pattern string) ![]string`: Finds all keys matching the given pattern.
|
||||
- `del(key string) !int`: Deletes a key.
|
||||
- `expire(key string, seconds int) !int`: Sets a key's time to live in seconds.
|
||||
- `ttl(key string) !int`: Gets the time to live for a key in seconds.
|
||||
- `flushall() !`: Deletes all the keys of all the existing databases.
|
||||
- `flushdb() !`: Deletes all the keys of the currently selected database.
|
||||
- `selectdb(database int) !`: Changes the selected database.
|
||||
- `keys(pattern string) ![]string`: Finds all keys matching the given pattern.
|
||||
- `del(key string) !int`: Deletes a key.
|
||||
- `expire(key string, seconds int) !int`: Sets a key's time to live in seconds.
|
||||
- `ttl(key string) !int`: Gets the time to live for a key in seconds.
|
||||
- `flushall() !`: Deletes all the keys of all the existing databases.
|
||||
- `flushdb() !`: Deletes all the keys of the currently selected database.
|
||||
- `selectdb(database int) !`: Changes the selected database.
|
||||
|
||||
```v
|
||||
redis.set('temp_key', 'value')!
|
||||
@@ -116,7 +116,7 @@ redis.expire('temp_key', 60)! // Expires in 60 seconds
|
||||
The `RedisCache` struct provides a convenient way to implement caching using Redis.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.redisclient
|
||||
import incubaid.herolib.core.redisclient
|
||||
|
||||
mut redis := redisclient.core_get()!
|
||||
mut cache := redis.cache('my_app_cache')
|
||||
@@ -145,7 +145,7 @@ cache.reset()!
|
||||
The `RedisQueue` struct provides a simple queue mechanism using Redis lists.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.redisclient
|
||||
import incubaid.herolib.core.redisclient
|
||||
import time
|
||||
|
||||
mut redis := redisclient.core_get()!
|
||||
@@ -169,7 +169,7 @@ task2 := my_queue.pop()!
|
||||
The `RedisRpc` struct enables Remote Procedure Call (RPC) over Redis, allowing services to communicate by sending messages to queues and waiting for responses.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.redisclient
|
||||
import incubaid.herolib.core.redisclient
|
||||
import json
|
||||
import time
|
||||
|
||||
|
||||
@@ -2,96 +2,124 @@
|
||||
|
||||
The `texttools` module provides a comprehensive set of utilities for text manipulation and processing.
|
||||
|
||||
## Functions and Examples:
|
||||
## Functions and Examples
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.texttools
|
||||
import incubaid.herolib.core.texttools
|
||||
|
||||
assert hello_world == texttools.name_fix("Hello World!")
|
||||
|
||||
```
|
||||
|
||||
### Name/Path Processing
|
||||
* `name_fix(name string) string`: Normalizes filenames and paths.
|
||||
* `name_fix_keepspace(name string) !string`: Like name_fix but preserves spaces.
|
||||
* `name_fix_no_ext(name_ string) string`: Removes file extension.
|
||||
* `name_fix_snake_to_pascal(name string) string`: Converts snake_case to PascalCase.
|
||||
|
||||
* `name_fix(name string) string`: Normalizes filenames and paths.
|
||||
* `name_fix_keepspace(name string) !string`: Like name_fix but preserves spaces.
|
||||
* `name_fix_no_ext(name_ string) string`: Removes file extension.
|
||||
* `name_fix_snake_to_pascal(name string) string`: Converts snake_case to PascalCase.
|
||||
|
||||
```v
|
||||
name := texttools.name_fix_snake_to_pascal("hello_world") // Result: "HelloWorld"
|
||||
```
|
||||
* `snake_case(name string) string`: Converts PascalCase to snake_case.
|
||||
|
||||
* `snake_case(name string) string`: Converts PascalCase to snake_case.
|
||||
|
||||
```v
|
||||
name := texttools.snake_case("HelloWorld") // Result: "hello_world"
|
||||
```
|
||||
* `name_split(name string) !(string, string)`: Splits name into site and page components.
|
||||
|
||||
* `name_split(name string) !(string, string)`: Splits name into site and page components.
|
||||
|
||||
### Text Cleaning
|
||||
* `name_clean(r string) string`: Normalizes names by removing special characters.
|
||||
|
||||
* `name_clean(r string) string`: Normalizes names by removing special characters.
|
||||
|
||||
```v
|
||||
name := texttools.name_clean("Hello@World!") // Result: "HelloWorld"
|
||||
```
|
||||
* `ascii_clean(r string) string`: Removes all non-ASCII characters.
|
||||
* `remove_empty_lines(text string) string`: Removes empty lines from text.
|
||||
|
||||
* `ascii_clean(r string) string`: Removes all non-ASCII characters.
|
||||
* `remove_empty_lines(text string) string`: Removes empty lines from text.
|
||||
|
||||
```v
|
||||
text := texttools.remove_empty_lines("line1\n\nline2\n\n\nline3") // Result: "line1\nline2\nline3"
|
||||
```
|
||||
* `remove_double_lines(text string) string`: Removes consecutive empty lines.
|
||||
* `remove_empty_js_blocks(text string) string`: Removes empty code blocks (```...```).
|
||||
|
||||
* `remove_double_lines(text string) string`: Removes consecutive empty lines.
|
||||
* `remove_empty_js_blocks(text string) string`: Removes empty code blocks (```...```).
|
||||
|
||||
### Command Line Parsing
|
||||
* `cmd_line_args_parser(text string) ![]string`: Parses command line arguments with support for quotes and escaping.
|
||||
|
||||
* `cmd_line_args_parser(text string) ![]string`: Parses command line arguments with support for quotes and escaping.
|
||||
|
||||
```v
|
||||
args := texttools.cmd_line_args_parser("'arg with spaces' --flag=value") // Result: ['arg with spaces', '--flag=value']
|
||||
```
|
||||
* `text_remove_quotes(text string) string`: Removes quoted sections from text.
|
||||
* `check_exists_outside_quotes(text string, items []string) bool`: Checks if items exist in text outside of quotes.
|
||||
|
||||
* `text_remove_quotes(text string) string`: Removes quoted sections from text.
|
||||
* `check_exists_outside_quotes(text string, items []string) bool`: Checks if items exist in text outside of quotes.
|
||||
|
||||
### Text Expansion
|
||||
* `expand(txt_ string, l int, expand_with string) string`: Expands text to a specified length with a given character.
|
||||
|
||||
* `expand(txt_ string, l int, expand_with string) string`: Expands text to a specified length with a given character.
|
||||
|
||||
### Indentation
|
||||
* `indent(text string, prefix string) string`: Adds indentation prefix to each line.
|
||||
|
||||
* `indent(text string, prefix string) string`: Adds indentation prefix to each line.
|
||||
|
||||
```v
|
||||
text := texttools.indent("line1\nline2", " ") // Result: " line1\n line2\n"
|
||||
```
|
||||
* `dedent(text string) string`: Removes common leading whitespace from every line.
|
||||
|
||||
* `dedent(text string) string`: Removes common leading whitespace from every line.
|
||||
|
||||
```v
|
||||
text := texttools.dedent(" line1\n line2") // Result: "line1\nline2"
|
||||
```
|
||||
|
||||
### String Validation
|
||||
* `is_int(text string) bool`: Checks if text contains only digits.
|
||||
* `is_upper_text(text string) bool`: Checks if text contains only uppercase letters.
|
||||
|
||||
* `is_int(text string) bool`: Checks if text contains only digits.
|
||||
* `is_upper_text(text string) bool`: Checks if text contains only uppercase letters.
|
||||
|
||||
### Multiline Processing
|
||||
* `multiline_to_single(text string) !string`: Converts multiline text to a single line with proper escaping.
|
||||
|
||||
* `multiline_to_single(text string) !string`: Converts multiline text to a single line with proper escaping.
|
||||
|
||||
### Text Splitting
|
||||
* `split_smart(t string, delimiter_ string) []string`: Intelligent string splitting that respects quotes.
|
||||
|
||||
* `split_smart(t string, delimiter_ string) []string`: Intelligent string splitting that respects quotes.
|
||||
|
||||
### Tokenization
|
||||
* `tokenize(text_ string) TokenizerResult`: Tokenizes text into meaningful parts.
|
||||
* `text_token_replace(text string, tofind string, replacewith string) !string`: Replaces tokens in text.
|
||||
|
||||
* `tokenize(text_ string) TokenizerResult`: Tokenizes text into meaningful parts.
|
||||
* `text_token_replace(text string, tofind string, replacewith string) !string`: Replaces tokens in text.
|
||||
|
||||
### Version Parsing
|
||||
* `version(text_ string) int`: Converts version strings to comparable integers.
|
||||
|
||||
* `version(text_ string) int`: Converts version strings to comparable integers.
|
||||
|
||||
```v
|
||||
ver := texttools.version("v0.4.36") // Result: 4036
|
||||
ver = texttools.version("v1.4.36") // Result: 1004036
|
||||
```
|
||||
|
||||
### Formatting
|
||||
* `format_rfc1123(t time.Time) string`: Formats a time.Time object into RFC 1123 format.
|
||||
|
||||
* `format_rfc1123(t time.Time) string`: Formats a time.Time object into RFC 1123 format.
|
||||
|
||||
### Array Operations
|
||||
* `to_array(r string) []string`: Converts a comma or newline separated list to an array of strings.
|
||||
|
||||
* `to_array(r string) []string`: Converts a comma or newline separated list to an array of strings.
|
||||
|
||||
```v
|
||||
text := "item1,item2,item3"
|
||||
array := texttools.to_array(text) // Result: ['item1', 'item2', 'item3']
|
||||
```
|
||||
* `to_array_int(r string) []int`: Converts a text list to an array of integers.
|
||||
* `to_map(mapstring string, line string, delimiter_ string) map[string]string`: Intelligent mapping of a line to a map based on a template.
|
||||
|
||||
* `to_array_int(r string) []int`: Converts a text list to an array of integers.
|
||||
* `to_map(mapstring string, line string, delimiter_ string) map[string]string`: Intelligent mapping of a line to a map based on a template.
|
||||
|
||||
```v
|
||||
r := texttools.to_map("name,-,-,-,-,pid,-,-,-,-,path",
|
||||
"root 304 0.0 0.0 408185328 1360 ?? S 16Dec23 0:34.06 /usr/sbin/distnoted")
|
||||
|
||||
@@ -5,7 +5,7 @@ has mechanisms to print better to console, see the methods below
|
||||
import as
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.ui.console
|
||||
import incubaid.herolib.ui.console
|
||||
|
||||
```
|
||||
|
||||
@@ -24,23 +24,23 @@ fn color_fg(c ForegroundColor) string
|
||||
|
||||
struct PrintArgs {
|
||||
pub mut:
|
||||
foreground ForegroundColor
|
||||
background BackgroundColor
|
||||
text string
|
||||
style Style
|
||||
reset_before bool = true
|
||||
reset_after bool = true
|
||||
foreground ForegroundColor
|
||||
background BackgroundColor
|
||||
text string
|
||||
style Style
|
||||
reset_before bool = true
|
||||
reset_after bool = true
|
||||
}
|
||||
|
||||
fn cprint(args PrintArgs)
|
||||
// print with colors, reset...
|
||||
// ```
|
||||
// foreground ForegroundColor
|
||||
// background BackgroundColor
|
||||
// text string
|
||||
// style Style
|
||||
// reset_before bool = true
|
||||
// reset_after bool = true
|
||||
// foreground ForegroundColor
|
||||
// background BackgroundColor
|
||||
// text string
|
||||
// style Style
|
||||
// reset_before bool = true
|
||||
// reset_after bool = true
|
||||
// ```
|
||||
|
||||
fn cprintln(args_ PrintArgs)
|
||||
@@ -95,11 +95,11 @@ Is used to ask feedback to users
|
||||
|
||||
struct UIConsole {
|
||||
pub mut:
|
||||
x_max int = 80
|
||||
y_max int = 60
|
||||
prev_lf bool
|
||||
prev_title bool
|
||||
prev_item bool
|
||||
x_max int = 80
|
||||
y_max int = 60
|
||||
prev_lf bool
|
||||
prev_title bool
|
||||
prev_item bool
|
||||
}
|
||||
|
||||
//DropDownArgs:
|
||||
@@ -150,51 +150,51 @@ fn (mut c UIConsole) status() string
|
||||
|
||||
```v
|
||||
enum BackgroundColor {
|
||||
default_color = 49 // 'default' is a reserved keyword in V
|
||||
black = 40
|
||||
red = 41
|
||||
green = 42
|
||||
yellow = 43
|
||||
blue = 44
|
||||
magenta = 45
|
||||
cyan = 46
|
||||
light_gray = 47
|
||||
dark_gray = 100
|
||||
light_red = 101
|
||||
light_green = 102
|
||||
light_yellow = 103
|
||||
light_blue = 104
|
||||
light_magenta = 105
|
||||
light_cyan = 106
|
||||
white = 107
|
||||
default_color = 49 // 'default' is a reserved keyword in V
|
||||
black = 40
|
||||
red = 41
|
||||
green = 42
|
||||
yellow = 43
|
||||
blue = 44
|
||||
magenta = 45
|
||||
cyan = 46
|
||||
light_gray = 47
|
||||
dark_gray = 100
|
||||
light_red = 101
|
||||
light_green = 102
|
||||
light_yellow = 103
|
||||
light_blue = 104
|
||||
light_magenta = 105
|
||||
light_cyan = 106
|
||||
white = 107
|
||||
}
|
||||
enum ForegroundColor {
|
||||
default_color = 39 // 'default' is a reserved keyword in V
|
||||
white = 97
|
||||
black = 30
|
||||
red = 31
|
||||
green = 32
|
||||
yellow = 33
|
||||
blue = 34
|
||||
magenta = 35
|
||||
cyan = 36
|
||||
light_gray = 37
|
||||
dark_gray = 90
|
||||
light_red = 91
|
||||
light_green = 92
|
||||
light_yellow = 93
|
||||
light_blue = 94
|
||||
light_magenta = 95
|
||||
light_cyan = 96
|
||||
default_color = 39 // 'default' is a reserved keyword in V
|
||||
white = 97
|
||||
black = 30
|
||||
red = 31
|
||||
green = 32
|
||||
yellow = 33
|
||||
blue = 34
|
||||
magenta = 35
|
||||
cyan = 36
|
||||
light_gray = 37
|
||||
dark_gray = 90
|
||||
light_red = 91
|
||||
light_green = 92
|
||||
light_yellow = 93
|
||||
light_blue = 94
|
||||
light_magenta = 95
|
||||
light_cyan = 96
|
||||
}
|
||||
enum Style {
|
||||
normal = 99
|
||||
bold = 1
|
||||
dim = 2
|
||||
underline = 4
|
||||
blink = 5
|
||||
reverse = 7
|
||||
hidden = 8
|
||||
normal = 99
|
||||
bold = 1
|
||||
dim = 2
|
||||
underline = 4
|
||||
blink = 5
|
||||
reverse = 7
|
||||
hidden = 8
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
@@ -5,7 +5,7 @@ this is how we want example scripts to be, see the first line
|
||||
```v
|
||||
#!/usr/bin/env -S v -cg -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib...
|
||||
import incubaid.herolib...
|
||||
|
||||
```
|
||||
|
||||
|
||||
819
aiprompts/heromodel_instruct.md
Normal file
819
aiprompts/heromodel_instruct.md
Normal file
@@ -0,0 +1,819 @@
|
||||
# HeroModels Implementation Guide
|
||||
|
||||
This guide provides comprehensive instructions for creating new models in the HeroModels system, including best practices for model structure, serialization/deserialization, testing, and integration with the HeroModels factory.
|
||||
|
||||
## Table of Contents
|
||||
1. [Model Structure Overview](#model-structure-overview)
|
||||
2. [Creating a New Model](#creating-a-new-model)
|
||||
3. [Serialization and Deserialization](#serialization-and-deserialization)
|
||||
4. [Database Operations](#database-operations)
|
||||
5. [API Handler Implementation](#api-handler-implementation)
|
||||
6. [Testing Models](#testing-models)
|
||||
7. [Integration with Factory](#integration-with-factory)
|
||||
8. [Advanced Features](#advanced-features)
|
||||
9. [Best Practices](#best-practices)
|
||||
10. [Example Implementation](#example-implementation)
|
||||
|
||||
## Model Structure Overview
|
||||
|
||||
Each model in the HeroModels system consists of several components:
|
||||
|
||||
1. **Model Struct**: The core data structure inheriting from `db.Base`
|
||||
2. **DB Wrapper Struct**: Provides database operations for the model
|
||||
3. **Argument Struct**: Used for creating and updating model instances
|
||||
4. **API Handler Function**: Handles RPC calls for the model
|
||||
5. **List Arguments Struct**: Used for filtering when listing instances
|
||||
|
||||
### Directory Structure
|
||||
|
||||
```
|
||||
lib/hero/heromodels/
|
||||
├── model_name.v # Main model file
|
||||
├── model_name_test.v # Tests for the model
|
||||
└── factory.v # Factory integration
|
||||
```
|
||||
|
||||
## Creating a New Model
|
||||
|
||||
### 1. Define the Model Struct
|
||||
|
||||
Create a new file `model_name.v` in the `lib/hero/heromodels` directory.
|
||||
|
||||
```v
|
||||
module heromodels
|
||||
|
||||
import incubaid.herolib.core.db
|
||||
import incubaid.herolib.core.encoder
|
||||
import incubaid.herolib.core.ourtime
|
||||
import incubaid.herolib.core.jsonrpc { Response }
|
||||
import json
|
||||
|
||||
// Model struct - inherits from db.Base
|
||||
pub struct ModelName {
|
||||
pub mut:
|
||||
db.Base // Inherit from db.Base
|
||||
name string
|
||||
description string
|
||||
created_at u64
|
||||
updated_at u64
|
||||
// Add additional fields as needed
|
||||
}
|
||||
|
||||
// TypeName returns the type name used for serialization
|
||||
pub fn (self ModelName) type_name() string {
|
||||
return 'heromodels.ModelName'
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Define the Argument Struct for Model Creation/Updates
|
||||
|
||||
```v
|
||||
// Argument struct for creating/updating models with params attribute
|
||||
@[params]
|
||||
pub struct ModelNameArg {
|
||||
pub mut:
|
||||
id u32 // Optional for updates, ignored for creation
|
||||
name string @[required] // Required field
|
||||
description string
|
||||
// Add additional fields as needed
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Define the List Arguments Struct for Filtering
|
||||
|
||||
```v
|
||||
// Arguments for filtering when listing models
|
||||
@[params]
|
||||
pub struct ModelNameListArg {
|
||||
pub mut:
|
||||
// Add filter fields (e.g., status, type, etc.)
|
||||
limit int = 100 // Default limit
|
||||
}
|
||||
```
|
||||
|
||||
### 4. Create the DB Wrapper Struct
|
||||
|
||||
```v
|
||||
// DB Wrapper struct for database operations
|
||||
pub struct DBModelName {
|
||||
pub mut:
|
||||
db &db.DB
|
||||
}
|
||||
```
|
||||
|
||||
## Serialization and Deserialization
|
||||
|
||||
Implement the `dump` and `load` methods for serialization/deserialization.
|
||||
|
||||
### Dump Method (Serialization)
|
||||
|
||||
```v
|
||||
// Dump serializes the model to the encoder
|
||||
pub fn (self ModelName) dump(mut e encoder.Encoder) ! {
|
||||
// Always dump the Base first
|
||||
self.Base.dump(mut e)!
|
||||
|
||||
// Dump model-specific fields in the same order they will be loaded
|
||||
e.add_string(self.name)!
|
||||
e.add_string(self.description)!
|
||||
e.add_u64(self.created_at)!
|
||||
e.add_u64(self.updated_at)!
|
||||
// Add more fields in the exact order they should be loaded
|
||||
}
|
||||
```
|
||||
|
||||
### Load Method (Deserialization)
|
||||
|
||||
```v
|
||||
// Load deserializes the model from the decoder
|
||||
pub fn (mut self DBModelName) load(mut obj ModelName, mut d encoder.Decoder) ! {
|
||||
// Always load the Base first
|
||||
obj.Base.load(mut d)!
|
||||
|
||||
// Load model-specific fields in the same order they were dumped
|
||||
obj.name = d.get_string()!
|
||||
obj.description = d.get_string()!
|
||||
obj.created_at = d.get_u64()!
|
||||
obj.updated_at = d.get_u64()!
|
||||
// Add more fields in the exact order they were dumped
|
||||
}
|
||||
```
|
||||
|
||||
## Database Operations
|
||||
|
||||
Implement the standard CRUD operations and additional methods.
|
||||
|
||||
### New Instance Creation
|
||||
|
||||
```v
|
||||
// Create a new model instance from arguments
|
||||
pub fn (mut self DBModelName) new(args ModelNameArg) !ModelName {
|
||||
mut o := ModelName{
|
||||
name: args.name
|
||||
description: args.description
|
||||
// Initialize other fields
|
||||
created_at: ourtime.now().unix()
|
||||
updated_at: ourtime.now().unix()
|
||||
}
|
||||
|
||||
// Additional initialization logic
|
||||
|
||||
return o
|
||||
}
|
||||
```
|
||||
|
||||
### Set (Create or Update)
|
||||
|
||||
```v
|
||||
// Save or update a model instance
|
||||
pub fn (mut self DBModelName) set(o ModelName) !ModelName {
|
||||
return self.db.set[ModelName](o)!
|
||||
}
|
||||
```
|
||||
|
||||
### Get
|
||||
|
||||
```v
|
||||
// Retrieve a model instance by ID
|
||||
pub fn (mut self DBModelName) get(id u32) !ModelName {
|
||||
mut o, data := self.db.get_data[ModelName](id)!
|
||||
mut e_decoder := encoder.decoder_new(data)
|
||||
self.load(mut o, mut e_decoder)!
|
||||
return o
|
||||
}
|
||||
```
|
||||
|
||||
### Delete
|
||||
|
||||
```v
|
||||
// Delete a model instance by ID
|
||||
pub fn (mut self DBModelName) delete(id u32) !bool {
|
||||
// Check if the item exists before trying to delete
|
||||
if !self.db.exists[ModelName](id)! {
|
||||
return false
|
||||
}
|
||||
self.db.delete[ModelName](id)!
|
||||
return true
|
||||
}
|
||||
```
|
||||
|
||||
### Exist
|
||||
|
||||
```v
|
||||
// Check if a model instance exists by ID
|
||||
pub fn (mut self DBModelName) exist(id u32) !bool {
|
||||
return self.db.exists[ModelName](id)!
|
||||
}
|
||||
```
|
||||
|
||||
### List with Filtering
|
||||
|
||||
```v
|
||||
// List model instances with optional filtering
|
||||
pub fn (mut self DBModelName) list(args ModelNameListArg) ![]ModelName {
|
||||
// Get all instances
|
||||
all_items := self.db.list[ModelName]()!.map(self.get(it)!)
|
||||
|
||||
// Apply filters
|
||||
mut filtered_items := []ModelName{}
|
||||
for item in all_items {
|
||||
// Apply your filter conditions here
|
||||
// Example:
|
||||
// if args.some_filter && item.some_property != args.filter_value {
|
||||
// continue
|
||||
// }
|
||||
|
||||
filtered_items << item
|
||||
}
|
||||
|
||||
// Apply limit
|
||||
mut limit := args.limit
|
||||
if limit > 100 {
|
||||
limit = 100
|
||||
}
|
||||
if filtered_items.len > limit {
|
||||
return filtered_items[..limit]
|
||||
}
|
||||
|
||||
return filtered_items
|
||||
}
|
||||
```
|
||||
|
||||
## API Handler Implementation
|
||||
|
||||
Create the handler function for RPC requests.
|
||||
|
||||
```v
|
||||
// Handler for RPC calls to this model
|
||||
pub fn model_name_handle(mut f ModelsFactory, rpcid int, servercontext map[string]string, userref UserRef, method string, params string) !Response {
|
||||
match method {
|
||||
'get' {
|
||||
id := db.decode_u32(params)!
|
||||
res := f.model_name.get(id)!
|
||||
return new_response(rpcid, json.encode_pretty(res))
|
||||
}
|
||||
'set' {
|
||||
mut args := db.decode_generic[ModelNameArg](params)!
|
||||
mut o := f.model_name.new(args)!
|
||||
if args.id != 0 {
|
||||
o.id = args.id
|
||||
}
|
||||
o = f.model_name.set(o)!
|
||||
return new_response_int(rpcid, int(o.id))
|
||||
}
|
||||
'delete' {
|
||||
id := db.decode_u32(params)!
|
||||
deleted := f.model_name.delete(id)!
|
||||
if deleted {
|
||||
return new_response_true(rpcid)
|
||||
} else {
|
||||
return new_error(rpcid,
|
||||
code: 404
|
||||
message: 'ModelName with ID ${id} not found'
|
||||
)
|
||||
}
|
||||
}
|
||||
'exist' {
|
||||
id := db.decode_u32(params)!
|
||||
if f.model_name.exist(id)! {
|
||||
return new_response_true(rpcid)
|
||||
} else {
|
||||
return new_response_false(rpcid)
|
||||
}
|
||||
}
|
||||
'list' {
|
||||
args := db.decode_generic[ModelNameListArg](params)!
|
||||
res := f.model_name.list(args)!
|
||||
return new_response(rpcid, json.encode_pretty(res))
|
||||
}
|
||||
else {
|
||||
return new_error(rpcid,
|
||||
code: 32601
|
||||
message: 'Method ${method} not found on model_name'
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Testing Models
|
||||
|
||||
Create a `model_name_test.v` file to test your model.
|
||||
|
||||
```v
|
||||
module heromodels
|
||||
|
||||
fn test_model_name_crud() ! {
|
||||
// Initialize DB for testing
|
||||
mut mydb := db.new_test()!
|
||||
mut db_model := DBModelName{
|
||||
db: &mydb
|
||||
}
|
||||
|
||||
// Create
|
||||
mut args := ModelNameArg{
|
||||
name: 'Test Model'
|
||||
description: 'A test model'
|
||||
}
|
||||
|
||||
mut model := db_model.new(args)!
|
||||
model = db_model.set(model)!
|
||||
model_id := model.id
|
||||
|
||||
// Verify ID assignment
|
||||
assert model_id > 0
|
||||
|
||||
// Read
|
||||
retrieved_model := db_model.get(model_id)!
|
||||
assert retrieved_model.name == 'Test Model'
|
||||
assert retrieved_model.description == 'A test model'
|
||||
|
||||
// Update
|
||||
retrieved_model.description = 'Updated description'
|
||||
updated_model := db_model.set(retrieved_model)!
|
||||
assert updated_model.description == 'Updated description'
|
||||
|
||||
// Delete
|
||||
deleted := db_model.delete(model_id)!
|
||||
assert deleted == true
|
||||
|
||||
// Verify deletion
|
||||
exists := db_model.exist(model_id)!
|
||||
assert exists == false
|
||||
}
|
||||
|
||||
fn test_model_name_type_name() ! {
|
||||
// Initialize DB for testing
|
||||
mut mydb := db.new_test()!
|
||||
mut db_model := DBModelName{
|
||||
db: &mydb
|
||||
}
|
||||
|
||||
// Create a model
|
||||
mut model := db_model.new(
|
||||
name: 'Type Test'
|
||||
description: 'Testing type_name'
|
||||
)!
|
||||
|
||||
// Test type_name method
|
||||
assert model.type_name() == 'heromodels.ModelName'
|
||||
}
|
||||
|
||||
fn test_model_name_description() ! {
|
||||
// Initialize DB for testing
|
||||
mut mydb := db.new_test()!
|
||||
mut db_model := DBModelName{
|
||||
db: &mydb
|
||||
}
|
||||
|
||||
// Create a model
|
||||
mut model := db_model.new(
|
||||
name: 'Description Test'
|
||||
description: 'Testing description method'
|
||||
)!
|
||||
|
||||
// Test description method for each methodname
|
||||
assert model.description('set') == 'Create or update a model. Returns the ID of the model.'
|
||||
assert model.description('get') == 'Retrieve a model by ID. Returns the model object.'
|
||||
assert model.description('delete') == 'Delete a model by ID. Returns true if successful.'
|
||||
assert model.description('exist') == 'Check if a model exists by ID. Returns true or false.'
|
||||
assert model.description('list') == 'List all models. Returns an array of model objects.'
|
||||
}
|
||||
|
||||
fn test_model_name_example() ! {
|
||||
// Initialize DB for testing
|
||||
mut mydb := db.new_test()!
|
||||
mut db_model := DBModelName{
|
||||
db: &mydb
|
||||
}
|
||||
|
||||
// Create a model
|
||||
mut model := db_model.new(
|
||||
name: 'Example Test'
|
||||
description: 'Testing example method'
|
||||
)!
|
||||
|
||||
// Test example method for each methodname
|
||||
set_call, set_result := model.example('set')
|
||||
// Assert expected call and result format
|
||||
|
||||
get_call, get_result := model.example('get')
|
||||
// Assert expected call and result format
|
||||
|
||||
delete_call, delete_result := model.example('delete')
|
||||
// Assert expected call and result format
|
||||
|
||||
exist_call, exist_result := model.example('exist')
|
||||
// Assert expected call and result format
|
||||
|
||||
list_call, list_result := model.example('list')
|
||||
// Assert expected call and result format
|
||||
}
|
||||
|
||||
fn test_model_name_encoding_decoding() ! {
|
||||
// Initialize DB for testing
|
||||
mut mydb := db.new_test()!
|
||||
mut db_model := DBModelName{
|
||||
db: &mydb
|
||||
}
|
||||
|
||||
// Create a model with all fields populated
|
||||
mut args := ModelNameArg{
|
||||
name: 'Encoding Test'
|
||||
description: 'Testing encoding/decoding'
|
||||
// Set other fields
|
||||
}
|
||||
|
||||
mut model := db_model.new(args)!
|
||||
|
||||
// Save the model
|
||||
model = db_model.set(model)!
|
||||
model_id := model.id
|
||||
|
||||
// Retrieve and verify all fields were properly encoded/decoded
|
||||
retrieved_model := db_model.get(model_id)!
|
||||
|
||||
// Verify all fields match the original
|
||||
assert retrieved_model.name == 'Encoding Test'
|
||||
assert retrieved_model.description == 'Testing encoding/decoding'
|
||||
// Check other fields
|
||||
}
|
||||
```
|
||||
|
||||
## Integration with Factory
|
||||
|
||||
Update the `factory.v` file to include your new model.
|
||||
|
||||
### 1. Add the Model to the Factory Struct
|
||||
|
||||
```v
|
||||
// In factory.v
|
||||
pub struct ModelsFactory {
|
||||
pub mut:
|
||||
db &db.DB
|
||||
user DBUser
|
||||
group DBGroup
|
||||
// Add your new model
|
||||
model_name DBModelName
|
||||
// Other models...
|
||||
rpc_handler &jsonrpc.Handler
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Initialize the Model in the Factory New Method
|
||||
|
||||
```v
|
||||
// In factory.v, in the new() function
|
||||
pub fn new(args ModelsFactoryArgs) !&ModelsFactory {
|
||||
// Existing code...
|
||||
|
||||
mut f := ModelsFactory{
|
||||
db: &mydb
|
||||
user: DBUser{
|
||||
db: &mydb
|
||||
}
|
||||
// Add your new model
|
||||
model_name: DBModelName{
|
||||
db: &mydb
|
||||
}
|
||||
// Other models...
|
||||
rpc_handler: &h
|
||||
}
|
||||
|
||||
// Existing code...
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Add Handler Registration to the Factory API Handler
|
||||
|
||||
```v
|
||||
// In factory.v, in the group_api_handler function
|
||||
pub fn group_api_handler(rpcid int, servercontext map[string]string, actorname string, methodname string, params string) !jsonrpc.Response {
|
||||
// Existing code...
|
||||
|
||||
match actorname {
|
||||
// Existing cases...
|
||||
|
||||
'model_name' {
|
||||
return model_name_handle(mut f, rpcid, servercontext, userref, methodname, params)!
|
||||
}
|
||||
|
||||
// Existing cases...
|
||||
|
||||
else {
|
||||
// Error handling
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Custom Methods
|
||||
|
||||
You can add custom methods to your model for specific business logic:
|
||||
|
||||
```v
|
||||
// Add a custom method to the model
|
||||
pub fn (mut self ModelName) custom_operation(param string) !string {
|
||||
// Custom business logic
|
||||
self.updated_at = ourtime.now().unix()
|
||||
return 'Performed ${param} operation'
|
||||
}
|
||||
```
|
||||
|
||||
### Enhanced RPC Handling
|
||||
|
||||
Extend the RPC handler to support your custom methods:
|
||||
|
||||
```v
|
||||
// In the model_name_handle function
|
||||
match method {
|
||||
// Standard CRUD methods...
|
||||
|
||||
'custom_operation' {
|
||||
id := db.decode_u32(params)!
|
||||
mut model := f.model_name.get(id)!
|
||||
|
||||
// Extract parameter from JSON
|
||||
param_struct := json.decode(struct { param string }, params) or {
|
||||
return new_error(rpcid,
|
||||
code: 32602
|
||||
message: 'Invalid parameters for custom_operation'
|
||||
)
|
||||
}
|
||||
|
||||
result := model.custom_operation(param_struct.param)!
|
||||
model = f.model_name.set(model)! // Save changes
|
||||
return new_response(rpcid, json.encode(result))
|
||||
}
|
||||
|
||||
else {
|
||||
// Error handling
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Field Order**: Keep field ordering consistent between `dump` and `load` methods
|
||||
2. **Error Handling**: Use the `!` operator consistently for error propagation
|
||||
3. **Timestamp Management**: Initialize timestamps using `ourtime.now().unix()`
|
||||
4. **Required Fields**: Mark mandatory fields with `@[required]` attribute
|
||||
5. **Limits**: Enforce list limits (default 100)
|
||||
6. **ID Handling**: Always check existence before operations like delete
|
||||
7. **Validation**: Add validation in the `new` and `set` methods
|
||||
8. **API Methods**: Implement the standard CRUD operations (get, set, delete, exist, list)
|
||||
9. **Comments**: Document all fields and methods
|
||||
10. **Testing**: Create comprehensive tests covering all methods
|
||||
|
||||
## Example Implementation
|
||||
|
||||
Here is a complete example of a simple "Project" model:
|
||||
|
||||
```v
|
||||
module heromodels
|
||||
|
||||
import incubaid.herolib.core.db
|
||||
import incubaid.herolib.core.encoder
|
||||
import incubaid.herolib.core.ourtime
|
||||
import incubaid.herolib.core.jsonrpc { Response }
|
||||
import json
|
||||
|
||||
// Project model
|
||||
pub struct Project {
|
||||
pub mut:
|
||||
db.Base // Inherit from db.Base
|
||||
name string
|
||||
description string
|
||||
status ProjectStatus
|
||||
owner_id u32
|
||||
members []u32
|
||||
created_at u64
|
||||
updated_at u64
|
||||
}
|
||||
|
||||
// Project status enum
|
||||
pub enum ProjectStatus {
|
||||
active
|
||||
completed
|
||||
archived
|
||||
}
|
||||
|
||||
// TypeName for serialization
|
||||
pub fn (self Project) type_name() string {
|
||||
return 'heromodels.Project'
|
||||
}
|
||||
|
||||
// Dump serializes the model
|
||||
pub fn (self Project) dump(mut e encoder.Encoder) ! {
|
||||
self.Base.dump(mut e)!
|
||||
e.add_string(self.name)!
|
||||
e.add_string(self.description)!
|
||||
e.add_u8(u8(self.status))!
|
||||
e.add_u32(self.owner_id)!
|
||||
e.add_array_u32(self.members)!
|
||||
e.add_u64(self.created_at)!
|
||||
e.add_u64(self.updated_at)!
|
||||
}
|
||||
|
||||
// Project argument struct
|
||||
@[params]
|
||||
pub struct ProjectArg {
|
||||
pub mut:
|
||||
id u32
|
||||
name string @[required]
|
||||
description string
|
||||
status ProjectStatus = .active
|
||||
owner_id u32 @[required]
|
||||
members []u32
|
||||
}
|
||||
|
||||
// Project list argument struct
|
||||
@[params]
|
||||
pub struct ProjectListArg {
|
||||
pub mut:
|
||||
status ProjectStatus
|
||||
owner_id u32
|
||||
limit int = 100
|
||||
}
|
||||
|
||||
// DB wrapper struct
|
||||
pub struct DBProject {
|
||||
pub mut:
|
||||
db &db.DB
|
||||
}
|
||||
|
||||
// Load deserializes the model
|
||||
pub fn (mut self DBProject) load(mut obj Project, mut d encoder.Decoder) ! {
|
||||
obj.Base.load(mut d)!
|
||||
obj.name = d.get_string()!
|
||||
obj.description = d.get_string()!
|
||||
obj.status = unsafe { ProjectStatus(d.get_u8()!) }
|
||||
obj.owner_id = d.get_u32()!
|
||||
obj.members = d.get_array_u32()!
|
||||
obj.created_at = d.get_u64()!
|
||||
obj.updated_at = d.get_u64()!
|
||||
}
|
||||
|
||||
// Create a new Project
|
||||
pub fn (mut self DBProject) new(args ProjectArg) !Project {
|
||||
mut o := Project{
|
||||
name: args.name
|
||||
description: args.description
|
||||
status: args.status
|
||||
owner_id: args.owner_id
|
||||
members: args.members
|
||||
created_at: ourtime.now().unix()
|
||||
updated_at: ourtime.now().unix()
|
||||
}
|
||||
|
||||
return o
|
||||
}
|
||||
|
||||
// Save or update a Project
|
||||
pub fn (mut self DBProject) set(o Project) !Project {
|
||||
return self.db.set[Project](o)!
|
||||
}
|
||||
|
||||
// Get a Project by ID
|
||||
pub fn (mut self DBProject) get(id u32) !Project {
|
||||
mut o, data := self.db.get_data[Project](id)!
|
||||
mut e_decoder := encoder.decoder_new(data)
|
||||
self.load(mut o, mut e_decoder)!
|
||||
return o
|
||||
}
|
||||
|
||||
// Delete a Project by ID
|
||||
pub fn (mut self DBProject) delete(id u32) !bool {
|
||||
if !self.db.exists[Project](id)! {
|
||||
return false
|
||||
}
|
||||
self.db.delete[Project](id)!
|
||||
return true
|
||||
}
|
||||
|
||||
// Check if a Project exists
|
||||
pub fn (mut self DBProject) exist(id u32) !bool {
|
||||
return self.db.exists[Project](id)!
|
||||
}
|
||||
|
||||
// List Projects with filtering
|
||||
pub fn (mut self DBProject) list(args ProjectListArg) ![]Project {
|
||||
all_projects := self.db.list[Project]()!.map(self.get(it)!)
|
||||
|
||||
mut filtered_projects := []Project{}
|
||||
for project in all_projects {
|
||||
// Filter by status if provided
|
||||
if args.status != .active && project.status != args.status {
|
||||
continue
|
||||
}
|
||||
|
||||
// Filter by owner_id if provided
|
||||
if args.owner_id != 0 && project.owner_id != args.owner_id {
|
||||
continue
|
||||
}
|
||||
|
||||
filtered_projects << project
|
||||
}
|
||||
|
||||
mut limit := args.limit
|
||||
if limit > 100 {
|
||||
limit = 100
|
||||
}
|
||||
if filtered_projects.len > limit {
|
||||
return filtered_projects[..limit]
|
||||
}
|
||||
|
||||
return filtered_projects
|
||||
}
|
||||
|
||||
// API description method
|
||||
pub fn (self Project) description(methodname string) string {
|
||||
match methodname {
|
||||
'set' { return 'Create or update a project. Returns the ID of the project.' }
|
||||
'get' { return 'Retrieve a project by ID. Returns the project object.' }
|
||||
'delete' { return 'Delete a project by ID. Returns true if successful.' }
|
||||
'exist' { return 'Check if a project exists by ID. Returns true or false.' }
|
||||
'list' { return 'List all projects. Returns an array of project objects.' }
|
||||
else { return 'This is generic method for the root object, TODO fill in, ...' }
|
||||
}
|
||||
}
|
||||
|
||||
// API example method
|
||||
pub fn (self Project) example(methodname string) (string, string) {
|
||||
match methodname {
|
||||
'set' {
|
||||
return '{"project": {"name": "Website Redesign", "description": "Redesign company website", "status": "active", "owner_id": 1, "members": [2, 3]}}', '1'
|
||||
}
|
||||
'get' {
|
||||
return '{"id": 1}', '{"name": "Website Redesign", "description": "Redesign company website", "status": "active", "owner_id": 1, "members": [2, 3]}'
|
||||
}
|
||||
'delete' {
|
||||
return '{"id": 1}', 'true'
|
||||
}
|
||||
'exist' {
|
||||
return '{"id": 1}', 'true'
|
||||
}
|
||||
'list' {
|
||||
return '{}', '[{"name": "Website Redesign", "description": "Redesign company website", "status": "active", "owner_id": 1, "members": [2, 3]}]'
|
||||
}
|
||||
else {
|
||||
return '{}', '{}'
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// API handler function
|
||||
pub fn project_handle(mut f ModelsFactory, rpcid int, servercontext map[string]string, userref UserRef, method string, params string) !Response {
|
||||
match method {
|
||||
'get' {
|
||||
id := db.decode_u32(params)!
|
||||
res := f.project.get(id)!
|
||||
return new_response(rpcid, json.encode_pretty(res))
|
||||
}
|
||||
'set' {
|
||||
mut args := db.decode_generic[ProjectArg](params)!
|
||||
mut o := f.project.new(args)!
|
||||
if args.id != 0 {
|
||||
o.id = args.id
|
||||
}
|
||||
o = f.project.set(o)!
|
||||
return new_response_int(rpcid, int(o.id))
|
||||
}
|
||||
'delete' {
|
||||
id := db.decode_u32(params)!
|
||||
deleted := f.project.delete(id)!
|
||||
if deleted {
|
||||
return new_response_true(rpcid)
|
||||
} else {
|
||||
return new_error(rpcid,
|
||||
code: 404
|
||||
message: 'Project with ID ${id} not found'
|
||||
)
|
||||
}
|
||||
}
|
||||
'exist' {
|
||||
id := db.decode_u32(params)!
|
||||
if f.project.exist(id)! {
|
||||
return new_response_true(rpcid)
|
||||
} else {
|
||||
return new_response_false(rpcid)
|
||||
}
|
||||
}
|
||||
'list' {
|
||||
args := db.decode_generic[ProjectListArg](params)!
|
||||
res := f.project.list(args)!
|
||||
return new_response(rpcid, json.encode_pretty(res))
|
||||
}
|
||||
else {
|
||||
return new_error(rpcid,
|
||||
code: 32601
|
||||
message: 'Method ${method} not found on project'
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This complete guide should provide all the necessary information to create and maintain models in the HeroModels system following the established patterns and best practices.
|
||||
@@ -1,3 +1,5 @@
|
||||
> NOTE: This document is an example snapshot of a developer's filesystem layout for HeroDB/HeroModels. Paths under `/Users/despiegk/...` are illustrative only. For the current, authoritative structure always use the live repository tree (this checkout) and the modules under `lib/hero/heromodels` and `lib/hero/db`.
|
||||
|
||||
<file_map>
|
||||
/Users/despiegk/code/github/incubaid/herolib
|
||||
├── .github
|
||||
@@ -674,6 +676,7 @@
|
||||
|
||||
<file_contents>
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/lib/hero/db/ai_instructions.md
|
||||
|
||||
```md
|
||||
# HeroDB Model Creation Instructions for AI
|
||||
|
||||
@@ -701,14 +704,14 @@ Define your model struct with the following pattern:
|
||||
```v
|
||||
@[heap]
|
||||
pub struct Calendar {
|
||||
db.Base // Inherit from Base struct
|
||||
db.Base // Inherit from Base struct
|
||||
pub mut:
|
||||
// Add your specific fields here
|
||||
title string
|
||||
start_time i64
|
||||
end_time i64
|
||||
location string
|
||||
attendees []string
|
||||
// Add your specific fields here
|
||||
title string
|
||||
start_time i64
|
||||
end_time i64
|
||||
location string
|
||||
attendees []string
|
||||
}
|
||||
```
|
||||
|
||||
@@ -718,7 +721,7 @@ Implement a method to return the model's type name:
|
||||
|
||||
```v
|
||||
pub fn (self Calendar) type_name() string {
|
||||
return 'calendar'
|
||||
return 'calendar'
|
||||
}
|
||||
```
|
||||
|
||||
@@ -728,11 +731,11 @@ Implement the `dump` method to serialize your struct's fields using the encoder:
|
||||
|
||||
```v
|
||||
pub fn (self Calendar) dump(mut e &encoder.Encoder) ! {
|
||||
e.add_string(self.title)
|
||||
e.add_i64(self.start_time)
|
||||
e.add_i64(self.end_time)
|
||||
e.add_string(self.location)
|
||||
e.add_list_string(self.attendees)
|
||||
e.add_string(self.title)
|
||||
e.add_i64(self.start_time)
|
||||
e.add_i64(self.end_time)
|
||||
e.add_string(self.location)
|
||||
e.add_list_string(self.attendees)
|
||||
}
|
||||
```
|
||||
|
||||
@@ -742,11 +745,11 @@ Implement the `load` method to deserialize your struct's fields:
|
||||
|
||||
```v
|
||||
fn (mut self DBCalendar) load(mut o Calendar, mut e &encoder.Decoder) ! {
|
||||
o.title = e.get_string()!
|
||||
o.start_time = e.get_i64()!
|
||||
o.end_time = e.get_i64()!
|
||||
o.location = e.get_string()!
|
||||
o.attendees = e.get_list_string()!
|
||||
o.title = e.get_string()!
|
||||
o.start_time = e.get_i64()!
|
||||
o.end_time = e.get_i64()!
|
||||
o.location = e.get_string()!
|
||||
o.attendees = e.get_list_string()!
|
||||
}
|
||||
```
|
||||
|
||||
@@ -758,11 +761,11 @@ Define a struct for creating new instances of your model:
|
||||
@[params]
|
||||
pub struct CalendarArg {
|
||||
pub mut:
|
||||
title string @[required]
|
||||
start_time i64
|
||||
end_time i64
|
||||
location string
|
||||
attendees []string
|
||||
title string @[required]
|
||||
start_time i64
|
||||
end_time i64
|
||||
location string
|
||||
attendees []string
|
||||
}
|
||||
```
|
||||
|
||||
@@ -773,7 +776,7 @@ Create a database wrapper struct for your model:
|
||||
```v
|
||||
pub struct DBCalendar {
|
||||
pub mut:
|
||||
db &db.DB @[skip; str: skip]
|
||||
db &db.DB @[skip; str: skip]
|
||||
}
|
||||
```
|
||||
|
||||
@@ -784,8 +787,8 @@ Add your model to the ModelsFactory struct in `factory.v`:
|
||||
```v
|
||||
pub struct ModelsFactory {
|
||||
pub mut:
|
||||
comments DBCalendar
|
||||
// ... other models
|
||||
comments DBCalendar
|
||||
// ... other models
|
||||
}
|
||||
```
|
||||
|
||||
@@ -793,13 +796,13 @@ And initialize it in the `new()` function:
|
||||
|
||||
```v
|
||||
pub fn new() !ModelsFactory {
|
||||
mut mydb := db.new()!
|
||||
return ModelsFactory{
|
||||
comments: DBCalendar{
|
||||
db: &mydb
|
||||
}
|
||||
// ... initialize other models
|
||||
}
|
||||
mut mydb := db.new()!
|
||||
return ModelsFactory{
|
||||
comments: DBCalendar{
|
||||
db: &mydb
|
||||
}
|
||||
// ... initialize other models
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -808,6 +811,7 @@ pub fn new() !ModelsFactory {
|
||||
Use these methods for serialization/deserialization:
|
||||
|
||||
### Encoder (Serialization)
|
||||
|
||||
- `e.add_bool(val bool)`
|
||||
- `e.add_u8(val u8)`
|
||||
- `e.add_u16(val u16)`
|
||||
@@ -834,6 +838,7 @@ Use these methods for serialization/deserialization:
|
||||
- `e.add_list_string(val []string)`
|
||||
|
||||
### Decoder (Deserialization)
|
||||
|
||||
- `e.get_bool()!`
|
||||
- `e.get_u8()!`
|
||||
- `e.get_u16()!`
|
||||
@@ -862,55 +867,61 @@ Use these methods for serialization/deserialization:
|
||||
## CRUD Methods Implementation
|
||||
|
||||
### Create New Instance
|
||||
|
||||
```v
|
||||
pub fn (mut self DBCalendar) new(args CalendarArg) !Calendar {
|
||||
mut o := Calendar{
|
||||
title: args.title
|
||||
start_time: args.start_time
|
||||
end_time: args.end_time
|
||||
location: args.location
|
||||
attendees: args.attendees
|
||||
updated_at: ourtime.now().unix()
|
||||
}
|
||||
return o
|
||||
mut o := Calendar{
|
||||
title: args.title
|
||||
start_time: args.start_time
|
||||
end_time: args.end_time
|
||||
location: args.location
|
||||
attendees: args.attendees
|
||||
updated_at: ourtime.now().unix()
|
||||
}
|
||||
return o
|
||||
}
|
||||
```
|
||||
|
||||
### Save to Database
|
||||
|
||||
```v
|
||||
pub fn (mut self DBCalendar) set(o Calendar) !u32 {
|
||||
return self.db.set[Calendar](o)!
|
||||
return self.db.set[Calendar](o)!
|
||||
}
|
||||
```
|
||||
|
||||
### Retrieve from Database
|
||||
|
||||
```v
|
||||
pub fn (mut self DBCalendar) get(id u32) !Calendar {
|
||||
mut o, data := self.db.get_data[Calendar](id)!
|
||||
mut e_decoder := encoder.decoder_new(data)
|
||||
self.load(mut o, mut e_decoder)!
|
||||
return o
|
||||
mut o, data := self.db.get_data[Calendar](id)!
|
||||
mut e_decoder := encoder.decoder_new(data)
|
||||
self.load(mut o, mut e_decoder)!
|
||||
return o
|
||||
}
|
||||
```
|
||||
|
||||
### Delete from Database
|
||||
|
||||
```v
|
||||
pub fn (mut self DBCalendar) delete(id u32) ! {
|
||||
self.db.delete[Calendar](id)!
|
||||
self.db.delete[Calendar](id)!
|
||||
}
|
||||
```
|
||||
|
||||
### Check Existence
|
||||
|
||||
```v
|
||||
pub fn (mut self DBCalendar) exist(id u32) !bool {
|
||||
return self.db.exists[Calendar](id)!
|
||||
return self.db.exists[Calendar](id)!
|
||||
}
|
||||
```
|
||||
|
||||
### List All Objects
|
||||
|
||||
```v
|
||||
pub fn (mut self DBCalendar) list() ![]Calendar {
|
||||
return self.db.list[Calendar]()!.map(self.get(it)!)
|
||||
return self.db.list[Calendar]()!.map(self.get(it)!)
|
||||
}
|
||||
```
|
||||
|
||||
@@ -921,18 +932,18 @@ Create a `.vsh` script in `examples/hero/heromodels/` to demonstrate usage:
|
||||
```v
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.core.redisclient
|
||||
import freeflowuniverse.herolib.hero.heromodels
|
||||
import incubaid.herolib.core.redisclient
|
||||
import incubaid.herolib.hero.heromodels
|
||||
|
||||
mut mydb := heromodels.new()!
|
||||
|
||||
// Create a new object
|
||||
mut o := mydb.calendar.new(
|
||||
title: 'Meeting'
|
||||
start_time: 1672531200
|
||||
end_time: 1672534800
|
||||
location: 'Conference Room'
|
||||
attendees: ['john@example.com', 'jane@example.com']
|
||||
title: 'Meeting'
|
||||
start_time: 1672531200
|
||||
end_time: 1672534800
|
||||
location: 'Conference Room'
|
||||
attendees: ['john@example.com', 'jane@example.com']
|
||||
)!
|
||||
|
||||
// Save to database
|
||||
@@ -971,160 +982,163 @@ println('All objects: ${objects}')
|
||||
8. Implement CRUD methods
|
||||
9. Create example usage script
|
||||
10. Test the implementation with the example script
|
||||
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/lib/hero/db/core_methods.v
|
||||
```v
|
||||
module db
|
||||
|
||||
import freeflowuniverse.herolib.data.ourtime
|
||||
import freeflowuniverse.herolib.data.encoder
|
||||
import incubaid.herolib.data.ourtime
|
||||
import incubaid.herolib.data.encoder
|
||||
|
||||
pub fn (mut self DB) set[T](obj_ T) !u32 {
|
||||
// Get the next ID
|
||||
mut obj := obj_
|
||||
if obj.id == 0 {
|
||||
obj.id = self.new_id()!
|
||||
}
|
||||
mut t := ourtime.now().unix()
|
||||
if obj.created_at == 0 {
|
||||
obj.created_at = t
|
||||
}
|
||||
obj.updated_at = t
|
||||
// Get the next ID
|
||||
mut obj := obj_
|
||||
if obj.id == 0 {
|
||||
obj.id = self.new_id()!
|
||||
}
|
||||
mut t := ourtime.now().unix()
|
||||
if obj.created_at == 0 {
|
||||
obj.created_at = t
|
||||
}
|
||||
obj.updated_at = t
|
||||
|
||||
// id u32
|
||||
// name string
|
||||
// description string
|
||||
// created_at i64
|
||||
// updated_at i64
|
||||
// securitypolicy u32
|
||||
// tags u32 // when we set/get we always do as []string but this can then be sorted and md5ed this gies the unique id of tags
|
||||
// comments []u32
|
||||
mut e := encoder.new()
|
||||
e.add_u8(1)
|
||||
e.add_u32(obj.id)
|
||||
e.add_string(obj.name)
|
||||
e.add_string(obj.description)
|
||||
e.add_i64(obj.created_at)
|
||||
e.add_i64(obj.updated_at)
|
||||
e.add_u32(obj.securitypolicy)
|
||||
e.add_u32(obj.tags)
|
||||
e.add_u16(u16(obj.comments.len))
|
||||
for comment in obj.comments {
|
||||
e.add_u32(comment)
|
||||
}
|
||||
// println('set: before dump, e.data.len: ${e.data.len}')
|
||||
obj.dump(mut e)!
|
||||
// println('set: after dump, e.data.len: ${e.data.len}')
|
||||
self.redis.hset(self.db_name[T](), obj.id.str(), e.data.bytestr())!
|
||||
return obj.id
|
||||
// id u32
|
||||
// name string
|
||||
// description string
|
||||
// created_at i64
|
||||
// updated_at i64
|
||||
// securitypolicy u32
|
||||
// tags u32 // when we set/get we always do as []string but this can then be sorted and md5ed this gies the unique id of tags
|
||||
// comments []u32
|
||||
mut e := encoder.new()
|
||||
e.add_u8(1)
|
||||
e.add_u32(obj.id)
|
||||
e.add_string(obj.name)
|
||||
e.add_string(obj.description)
|
||||
e.add_i64(obj.created_at)
|
||||
e.add_i64(obj.updated_at)
|
||||
e.add_u32(obj.securitypolicy)
|
||||
e.add_u32(obj.tags)
|
||||
e.add_u16(u16(obj.comments.len))
|
||||
for comment in obj.comments {
|
||||
e.add_u32(comment)
|
||||
}
|
||||
// println('set: before dump, e.data.len: ${e.data.len}')
|
||||
obj.dump(mut e)!
|
||||
// println('set: after dump, e.data.len: ${e.data.len}')
|
||||
self.redis.hset(self.db_name[T](), obj.id.str(), e.data.bytestr())!
|
||||
return obj.id
|
||||
}
|
||||
|
||||
// return the data, cannot return the object as we do not know the type
|
||||
pub fn (mut self DB) get_data[T](id u32) !(T, []u8) {
|
||||
data := self.redis.hget(self.db_name[T](), id.str())!
|
||||
data := self.redis.hget(self.db_name[T](), id.str())!
|
||||
|
||||
if data.len == 0 {
|
||||
return error('herodb:${self.db_name[T]()} not found for ${id}')
|
||||
}
|
||||
if data.len == 0 {
|
||||
return error('herodb:${self.db_name[T]()} not found for ${id}')
|
||||
}
|
||||
|
||||
// println('get_data: data.len: ${data.len}')
|
||||
mut e := encoder.decoder_new(data.bytes())
|
||||
version := e.get_u8()!
|
||||
if version != 1 {
|
||||
panic('wrong version in base load')
|
||||
}
|
||||
mut base := T{}
|
||||
base.id = e.get_u32()!
|
||||
base.name = e.get_string()!
|
||||
base.description = e.get_string()!
|
||||
base.created_at = e.get_i64()!
|
||||
base.updated_at = e.get_i64()!
|
||||
base.securitypolicy = e.get_u32()!
|
||||
base.tags = e.get_u32()!
|
||||
for _ in 0 .. e.get_u16()! {
|
||||
base.comments << e.get_u32()!
|
||||
}
|
||||
return base, e.data
|
||||
// println('get_data: data.len: ${data.len}')
|
||||
mut e := encoder.decoder_new(data.bytes())
|
||||
version := e.get_u8()!
|
||||
if version != 1 {
|
||||
panic('wrong version in base load')
|
||||
}
|
||||
mut base := T{}
|
||||
base.id = e.get_u32()!
|
||||
base.name = e.get_string()!
|
||||
base.description = e.get_string()!
|
||||
base.created_at = e.get_i64()!
|
||||
base.updated_at = e.get_i64()!
|
||||
base.securitypolicy = e.get_u32()!
|
||||
base.tags = e.get_u32()!
|
||||
for _ in 0 .. e.get_u16()! {
|
||||
base.comments << e.get_u32()!
|
||||
}
|
||||
return base, e.data
|
||||
}
|
||||
|
||||
pub fn (mut self DB) exists[T](id u32) !bool {
|
||||
return self.redis.hexists(self.db_name[T](), id.str())!
|
||||
return self.redis.hexists(self.db_name[T](), id.str())!
|
||||
}
|
||||
|
||||
pub fn (mut self DB) delete[T](id u32) ! {
|
||||
self.redis.hdel(self.db_name[T](), id.str())!
|
||||
self.redis.hdel(self.db_name[T](), id.str())!
|
||||
}
|
||||
|
||||
pub fn (mut self DB) list[T]() ![]u32 {
|
||||
ids := self.redis.hkeys(self.db_name[T]())!
|
||||
return ids.map(it.u32())
|
||||
ids := self.redis.hkeys(self.db_name[T]())!
|
||||
return ids.map(it.u32())
|
||||
}
|
||||
|
||||
// make it easy to get a base object
|
||||
pub fn (mut self DB) new_from_base[T](args BaseArgs) !Base {
|
||||
return T{
|
||||
Base: new_base(args)!
|
||||
}
|
||||
return T{
|
||||
Base: new_base(args)!
|
||||
}
|
||||
}
|
||||
|
||||
fn (mut self DB) db_name[T]() string {
|
||||
// get the name of the type T
|
||||
mut name := T.name.to_lower_ascii().split('.').last()
|
||||
// println("db_name rediskey: '${name}'")
|
||||
return 'db:${name}'
|
||||
// get the name of the type T
|
||||
mut name := T.name.to_lower_ascii().split('.').last()
|
||||
// println("db_name rediskey: '${name}'")
|
||||
return 'db:${name}'
|
||||
}
|
||||
|
||||
pub fn (mut self DB) new_id() !u32 {
|
||||
return u32(self.redis.incr('db:id')!)
|
||||
return u32(self.redis.incr('db:id')!)
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/lib/hero/db/core_models.v
|
||||
|
||||
```v
|
||||
module db
|
||||
|
||||
import crypto.md5
|
||||
import freeflowuniverse.herolib.core.redisclient
|
||||
import freeflowuniverse.herolib.data.ourtime
|
||||
import incubaid.herolib.core.redisclient
|
||||
import incubaid.herolib.data.ourtime
|
||||
|
||||
// Group represents a collection of users with roles and permissions
|
||||
@[heap]
|
||||
pub struct Base {
|
||||
pub mut:
|
||||
id u32
|
||||
name string
|
||||
description string
|
||||
created_at i64
|
||||
updated_at i64
|
||||
securitypolicy u32
|
||||
tags u32 // when we set/get we always do as []string but this can then be sorted and md5ed this gies the unique id of tags
|
||||
comments []u32
|
||||
id u32
|
||||
name string
|
||||
description string
|
||||
created_at i64
|
||||
updated_at i64
|
||||
securitypolicy u32
|
||||
tags u32 // when we set/get we always do as []string but this can then be sorted and md5ed this gies the unique id of tags
|
||||
comments []u32
|
||||
}
|
||||
|
||||
@[heap]
|
||||
pub struct SecurityPolicy {
|
||||
pub mut:
|
||||
id u32
|
||||
read []u32 // links to users & groups
|
||||
write []u32 // links to users & groups
|
||||
delete []u32 // links to users & groups
|
||||
public bool
|
||||
md5 string // this sorts read, write and delete u32 + hash, then do md5 hash, this allows to go from a random read/write/delete/public config to a hash
|
||||
id u32
|
||||
read []u32 // links to users & groups
|
||||
write []u32 // links to users & groups
|
||||
delete []u32 // links to users & groups
|
||||
public bool
|
||||
md5 string // this sorts read, write and delete u32 + hash, then do md5 hash, this allows to go from a random read/write/delete/public config to a hash
|
||||
}
|
||||
|
||||
@[heap]
|
||||
pub struct Tags {
|
||||
pub mut:
|
||||
id u32
|
||||
names []string // unique per id
|
||||
md5 string // of sorted names, to make easy to find unique id, each name lowercased and made ascii
|
||||
id u32
|
||||
names []string // unique per id
|
||||
md5 string // of sorted names, to make easy to find unique id, each name lowercased and made ascii
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/lib/hero/db/helpers_comments.v
|
||||
|
||||
```v
|
||||
module db
|
||||
|
||||
@@ -1134,298 +1148,301 @@ import crypto.md5
|
||||
@[params]
|
||||
pub struct CommentArg {
|
||||
pub mut:
|
||||
comment string
|
||||
parent u32
|
||||
author u32
|
||||
comment string
|
||||
parent u32
|
||||
author u32
|
||||
}
|
||||
|
||||
pub fn (mut self DB) comments_get(args []CommentArg) ![]u32 {
|
||||
return args.map(self.comment_get(it.comment)!)
|
||||
return args.map(self.comment_get(it.comment)!)
|
||||
}
|
||||
|
||||
pub fn (mut self DB) comment_get(comment string) !u32 {
|
||||
comment_fixed := comment.to_lower_ascii().trim_space()
|
||||
return if comment_fixed.len > 0 {
|
||||
hash := md5.hexhash(comment_fixed)
|
||||
comment_found := self.redis.hget('db:comments', hash)!
|
||||
if comment_found == '' {
|
||||
id := self.new_id()!
|
||||
self.redis.hset('db:comments', hash, id.str())!
|
||||
self.redis.hset('db:comments', id.str(), comment_fixed)!
|
||||
id
|
||||
} else {
|
||||
comment_found.u32()
|
||||
}
|
||||
} else {
|
||||
0
|
||||
}
|
||||
comment_fixed := comment.to_lower_ascii().trim_space()
|
||||
return if comment_fixed.len > 0 {
|
||||
hash := md5.hexhash(comment_fixed)
|
||||
comment_found := self.redis.hget('db:comments', hash)!
|
||||
if comment_found == '' {
|
||||
id := self.new_id()!
|
||||
self.redis.hset('db:comments', hash, id.str())!
|
||||
self.redis.hset('db:comments', id.str(), comment_fixed)!
|
||||
id
|
||||
} else {
|
||||
comment_found.u32()
|
||||
}
|
||||
} else {
|
||||
0
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/lib/hero/db/helpers_tags.v
|
||||
|
||||
```v
|
||||
module db
|
||||
|
||||
import crypto.md5
|
||||
|
||||
pub fn (mut self DB) tags_get(tags []string) !u32 {
|
||||
return if tags.len > 0 {
|
||||
mut tags_fixed := tags.map(it.to_lower_ascii().trim_space()).filter(it != '')
|
||||
tags_fixed.sort_ignore_case()
|
||||
hash := md5.hexhash(tags_fixed.join(','))
|
||||
tags_found := self.redis.hget('db:tags', hash)!
|
||||
return if tags_found == '' {
|
||||
println('tags_get: new tags: ${tags_fixed.join(",")}')
|
||||
id := self.new_id()!
|
||||
self.redis.hset('db:tags', hash, id.str())!
|
||||
self.redis.hset('db:tags', id.str(), tags_fixed.join(','))!
|
||||
id
|
||||
} else {
|
||||
tags_found.u32()
|
||||
}
|
||||
} else {
|
||||
0
|
||||
}
|
||||
return if tags.len > 0 {
|
||||
mut tags_fixed := tags.map(it.to_lower_ascii().trim_space()).filter(it != '')
|
||||
tags_fixed.sort_ignore_case()
|
||||
hash := md5.hexhash(tags_fixed.join(','))
|
||||
tags_found := self.redis.hget('db:tags', hash)!
|
||||
return if tags_found == '' {
|
||||
println('tags_get: new tags: ${tags_fixed.join(",")}')
|
||||
id := self.new_id()!
|
||||
self.redis.hset('db:tags', hash, id.str())!
|
||||
self.redis.hset('db:tags', id.str(), tags_fixed.join(','))!
|
||||
id
|
||||
} else {
|
||||
tags_found.u32()
|
||||
}
|
||||
} else {
|
||||
0
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/lib/hero/heromodels/calendar_event.v
|
||||
|
||||
```v
|
||||
|
||||
module heromodels
|
||||
|
||||
import freeflowuniverse.herolib.data.encoder
|
||||
import freeflowuniverse.herolib.data.ourtime
|
||||
import freeflowuniverse.herolib.hero.db
|
||||
import incubaid.herolib.data.encoder
|
||||
import incubaid.herolib.data.ourtime
|
||||
import incubaid.herolib.hero.db
|
||||
|
||||
// CalendarEvent represents a single event in a calendar
|
||||
@[heap]
|
||||
pub struct CalendarEvent {
|
||||
db.Base
|
||||
db.Base
|
||||
pub mut:
|
||||
title string
|
||||
start_time i64 // Unix timestamp
|
||||
end_time i64 // Unix timestamp
|
||||
location string
|
||||
attendees []u32 // IDs of user groups
|
||||
fs_items []u32 // IDs of linked files or dirs
|
||||
calendar_id u32 // Associated calendar
|
||||
status EventStatus
|
||||
is_all_day bool
|
||||
is_recurring bool
|
||||
recurrence []RecurrenceRule // normally empty
|
||||
reminder_mins []int // Minutes before event for reminders
|
||||
color string // Hex color code
|
||||
timezone string
|
||||
title string
|
||||
start_time i64 // Unix timestamp
|
||||
end_time i64 // Unix timestamp
|
||||
location string
|
||||
attendees []u32 // IDs of user groups
|
||||
fs_items []u32 // IDs of linked files or dirs
|
||||
calendar_id u32 // Associated calendar
|
||||
status EventStatus
|
||||
is_all_day bool
|
||||
is_recurring bool
|
||||
recurrence []RecurrenceRule // normally empty
|
||||
reminder_mins []int // Minutes before event for reminders
|
||||
color string // Hex color code
|
||||
timezone string
|
||||
}
|
||||
|
||||
pub struct Attendee {
|
||||
pub mut:
|
||||
user_id u32
|
||||
status AttendanceStatus
|
||||
role AttendeeRole
|
||||
user_id u32
|
||||
status AttendanceStatus
|
||||
role AttendeeRole
|
||||
}
|
||||
|
||||
pub enum AttendanceStatus {
|
||||
no_response
|
||||
accepted
|
||||
declined
|
||||
tentative
|
||||
no_response
|
||||
accepted
|
||||
declined
|
||||
tentative
|
||||
}
|
||||
|
||||
pub enum AttendeeRole {
|
||||
required
|
||||
optional
|
||||
organizer
|
||||
required
|
||||
optional
|
||||
organizer
|
||||
}
|
||||
|
||||
pub enum EventStatus {
|
||||
draft
|
||||
published
|
||||
cancelled
|
||||
completed
|
||||
draft
|
||||
published
|
||||
cancelled
|
||||
completed
|
||||
}
|
||||
|
||||
pub struct RecurrenceRule {
|
||||
pub mut:
|
||||
frequency RecurrenceFreq
|
||||
interval int // Every N frequencies
|
||||
until i64 // End date (Unix timestamp)
|
||||
count int // Number of occurrences
|
||||
by_weekday []int // Days of week (0=Sunday)
|
||||
by_monthday []int // Days of month
|
||||
frequency RecurrenceFreq
|
||||
interval int // Every N frequencies
|
||||
until i64 // End date (Unix timestamp)
|
||||
count int // Number of occurrences
|
||||
by_weekday []int // Days of week (0=Sunday)
|
||||
by_monthday []int // Days of month
|
||||
}
|
||||
|
||||
pub enum RecurrenceFreq {
|
||||
none
|
||||
daily
|
||||
weekly
|
||||
monthly
|
||||
yearly
|
||||
none
|
||||
daily
|
||||
weekly
|
||||
monthly
|
||||
yearly
|
||||
}
|
||||
|
||||
pub struct DBCalendarEvent {
|
||||
pub mut:
|
||||
db &db.DB @[skip; str: skip]
|
||||
db &db.DB @[skip; str: skip]
|
||||
}
|
||||
|
||||
pub fn (self CalendarEvent) type_name() string {
|
||||
return 'calendar_event'
|
||||
return 'calendar_event'
|
||||
}
|
||||
|
||||
pub fn (self CalendarEvent) dump(mut e &encoder.Encoder) ! {
|
||||
e.add_string(self.title)
|
||||
e.add_i64(self.start_time)
|
||||
e.add_i64(self.end_time)
|
||||
e.add_string(self.location)
|
||||
e.add_list_u32(self.attendees)
|
||||
e.add_list_u32(self.fs_items)
|
||||
e.add_u32(self.calendar_id)
|
||||
e.add_u8(u8(self.status))
|
||||
e.add_bool(self.is_all_day)
|
||||
e.add_bool(self.is_recurring)
|
||||
e.add_string(self.title)
|
||||
e.add_i64(self.start_time)
|
||||
e.add_i64(self.end_time)
|
||||
e.add_string(self.location)
|
||||
e.add_list_u32(self.attendees)
|
||||
e.add_list_u32(self.fs_items)
|
||||
e.add_u32(self.calendar_id)
|
||||
e.add_u8(u8(self.status))
|
||||
e.add_bool(self.is_all_day)
|
||||
e.add_bool(self.is_recurring)
|
||||
|
||||
// Encode recurrence array
|
||||
e.add_u16(u16(self.recurrence.len))
|
||||
for rule in self.recurrence {
|
||||
e.add_u8(u8(rule.frequency))
|
||||
e.add_int(rule.interval)
|
||||
e.add_i64(rule.until)
|
||||
e.add_int(rule.count)
|
||||
e.add_list_int(rule.by_weekday)
|
||||
e.add_list_int(rule.by_monthday)
|
||||
}
|
||||
// Encode recurrence array
|
||||
e.add_u16(u16(self.recurrence.len))
|
||||
for rule in self.recurrence {
|
||||
e.add_u8(u8(rule.frequency))
|
||||
e.add_int(rule.interval)
|
||||
e.add_i64(rule.until)
|
||||
e.add_int(rule.count)
|
||||
e.add_list_int(rule.by_weekday)
|
||||
e.add_list_int(rule.by_monthday)
|
||||
}
|
||||
|
||||
e.add_list_int(self.reminder_mins)
|
||||
e.add_string(self.color)
|
||||
e.add_string(self.timezone)
|
||||
e.add_list_int(self.reminder_mins)
|
||||
e.add_string(self.color)
|
||||
e.add_string(self.timezone)
|
||||
}
|
||||
|
||||
fn (mut self DBCalendarEvent) load(mut o CalendarEvent, mut e &encoder.Decoder) ! {
|
||||
o.title = e.get_string()!
|
||||
o.start_time = e.get_i64()!
|
||||
o.end_time = e.get_i64()!
|
||||
o.location = e.get_string()!
|
||||
o.attendees = e.get_list_u32()!
|
||||
o.fs_items = e.get_list_u32()!
|
||||
o.calendar_id = e.get_u32()!
|
||||
o.status = unsafe { EventStatus(e.get_u8()!) } //TODO: is there no better way?
|
||||
o.is_all_day = e.get_bool()!
|
||||
o.is_recurring = e.get_bool()!
|
||||
o.title = e.get_string()!
|
||||
o.start_time = e.get_i64()!
|
||||
o.end_time = e.get_i64()!
|
||||
o.location = e.get_string()!
|
||||
o.attendees = e.get_list_u32()!
|
||||
o.fs_items = e.get_list_u32()!
|
||||
o.calendar_id = e.get_u32()!
|
||||
o.status = unsafe { EventStatus(e.get_u8()!) } //TODO: is there no better way?
|
||||
o.is_all_day = e.get_bool()!
|
||||
o.is_recurring = e.get_bool()!
|
||||
|
||||
// Decode recurrence array
|
||||
recurrence_len := e.get_u16()!
|
||||
mut recurrence := []RecurrenceRule{}
|
||||
for _ in 0 .. recurrence_len {
|
||||
frequency := unsafe { RecurrenceFreq(e.get_u8()!) }
|
||||
interval := e.get_int()!
|
||||
until := e.get_i64()!
|
||||
count := e.get_int()!
|
||||
by_weekday := e.get_list_int()!
|
||||
by_monthday := e.get_list_int()!
|
||||
// Decode recurrence array
|
||||
recurrence_len := e.get_u16()!
|
||||
mut recurrence := []RecurrenceRule{}
|
||||
for _ in 0 .. recurrence_len {
|
||||
frequency := unsafe { RecurrenceFreq(e.get_u8()!) }
|
||||
interval := e.get_int()!
|
||||
until := e.get_i64()!
|
||||
count := e.get_int()!
|
||||
by_weekday := e.get_list_int()!
|
||||
by_monthday := e.get_list_int()!
|
||||
|
||||
recurrence << RecurrenceRule{
|
||||
frequency: frequency
|
||||
interval: interval
|
||||
until: until
|
||||
count: count
|
||||
by_weekday: by_weekday
|
||||
by_monthday: by_monthday
|
||||
}
|
||||
}
|
||||
o.recurrence = recurrence
|
||||
recurrence << RecurrenceRule{
|
||||
frequency: frequency
|
||||
interval: interval
|
||||
until: until
|
||||
count: count
|
||||
by_weekday: by_weekday
|
||||
by_monthday: by_monthday
|
||||
}
|
||||
}
|
||||
o.recurrence = recurrence
|
||||
|
||||
o.reminder_mins = e.get_list_int()!
|
||||
o.color = e.get_string()!
|
||||
o.timezone = e.get_string()!
|
||||
o.reminder_mins = e.get_list_int()!
|
||||
o.color = e.get_string()!
|
||||
o.timezone = e.get_string()!
|
||||
}
|
||||
|
||||
@[params]
|
||||
pub struct CalendarEventArg {
|
||||
pub mut:
|
||||
name string
|
||||
description string
|
||||
title string
|
||||
start_time string // use ourtime module to go from string to epoch
|
||||
end_time string // use ourtime module to go from string to epoch
|
||||
location string
|
||||
attendees []u32 // IDs of user groups
|
||||
fs_items []u32 // IDs of linked files or dirs
|
||||
calendar_id u32 // Associated calendar
|
||||
status EventStatus
|
||||
is_all_day bool
|
||||
is_recurring bool
|
||||
recurrence []RecurrenceRule
|
||||
reminder_mins []int // Minutes before event for reminders
|
||||
color string // Hex color code
|
||||
timezone string
|
||||
securitypolicy u32
|
||||
tags []string
|
||||
comments []db.CommentArg
|
||||
name string
|
||||
description string
|
||||
title string
|
||||
start_time string // use ourtime module to go from string to epoch
|
||||
end_time string // use ourtime module to go from string to epoch
|
||||
location string
|
||||
attendees []u32 // IDs of user groups
|
||||
fs_items []u32 // IDs of linked files or dirs
|
||||
calendar_id u32 // Associated calendar
|
||||
status EventStatus
|
||||
is_all_day bool
|
||||
is_recurring bool
|
||||
recurrence []RecurrenceRule
|
||||
reminder_mins []int // Minutes before event for reminders
|
||||
color string // Hex color code
|
||||
timezone string
|
||||
securitypolicy u32
|
||||
tags []string
|
||||
comments []db.CommentArg
|
||||
}
|
||||
|
||||
// get new calendar event, not from the DB
|
||||
pub fn (mut self DBCalendarEvent) new(args CalendarEventArg) !CalendarEvent {
|
||||
mut o := CalendarEvent{
|
||||
title: args.title
|
||||
location: args.location
|
||||
attendees: args.attendees
|
||||
fs_items: args.fs_items
|
||||
calendar_id: args.calendar_id
|
||||
status: args.status
|
||||
is_all_day: args.is_all_day
|
||||
is_recurring: args.is_recurring
|
||||
recurrence: args.recurrence
|
||||
reminder_mins: args.reminder_mins
|
||||
color: args.color
|
||||
timezone: args.timezone
|
||||
}
|
||||
mut o := CalendarEvent{
|
||||
title: args.title
|
||||
location: args.location
|
||||
attendees: args.attendees
|
||||
fs_items: args.fs_items
|
||||
calendar_id: args.calendar_id
|
||||
status: args.status
|
||||
is_all_day: args.is_all_day
|
||||
is_recurring: args.is_recurring
|
||||
recurrence: args.recurrence
|
||||
reminder_mins: args.reminder_mins
|
||||
color: args.color
|
||||
timezone: args.timezone
|
||||
}
|
||||
|
||||
// Set base fields
|
||||
o.name = args.name
|
||||
o.description = args.description
|
||||
o.securitypolicy = args.securitypolicy
|
||||
o.tags = self.db.tags_get(args.tags)!
|
||||
o.comments = self.db.comments_get(args.comments)!
|
||||
o.updated_at = ourtime.now().unix()
|
||||
// Set base fields
|
||||
o.name = args.name
|
||||
o.description = args.description
|
||||
o.securitypolicy = args.securitypolicy
|
||||
o.tags = self.db.tags_get(args.tags)!
|
||||
o.comments = self.db.comments_get(args.comments)!
|
||||
o.updated_at = ourtime.now().unix()
|
||||
|
||||
// Convert string times to Unix timestamps
|
||||
mut start_time_obj := ourtime.new(args.start_time)!
|
||||
o.start_time = start_time_obj.unix()
|
||||
// Convert string times to Unix timestamps
|
||||
mut start_time_obj := ourtime.new(args.start_time)!
|
||||
o.start_time = start_time_obj.unix()
|
||||
|
||||
mut end_time_obj := ourtime.new(args.end_time)!
|
||||
o.end_time = end_time_obj.unix()
|
||||
mut end_time_obj := ourtime.new(args.end_time)!
|
||||
o.end_time = end_time_obj.unix()
|
||||
|
||||
return o
|
||||
return o
|
||||
}
|
||||
|
||||
pub fn (mut self DBCalendarEvent) set(o CalendarEvent) !u32 {
|
||||
// Use db set function which now returns the ID
|
||||
return self.db.set[CalendarEvent](o)!
|
||||
// Use db set function which now returns the ID
|
||||
return self.db.set[CalendarEvent](o)!
|
||||
}
|
||||
|
||||
pub fn (mut self DBCalendarEvent) delete(id u32) ! {
|
||||
self.db.delete[CalendarEvent](id)!
|
||||
self.db.delete[CalendarEvent](id)!
|
||||
}
|
||||
|
||||
pub fn (mut self DBCalendarEvent) exist(id u32) !bool {
|
||||
return self.db.exists[CalendarEvent](id)!
|
||||
return self.db.exists[CalendarEvent](id)!
|
||||
}
|
||||
|
||||
pub fn (mut self DBCalendarEvent) get(id u32) !CalendarEvent {
|
||||
mut o, data := self.db.get_data[CalendarEvent](id)!
|
||||
mut e_decoder := encoder.decoder_new(data)
|
||||
self.load(mut o, mut e_decoder)!
|
||||
return o
|
||||
mut o, data := self.db.get_data[CalendarEvent](id)!
|
||||
mut e_decoder := encoder.decoder_new(data)
|
||||
self.load(mut o, mut e_decoder)!
|
||||
return o
|
||||
}
|
||||
|
||||
pub fn (mut self DBCalendarEvent) list() ![]CalendarEvent {
|
||||
return self.db.list[CalendarEvent]()!.map(self.get(it)!)
|
||||
return self.db.list[CalendarEvent]()!.map(self.get(it)!)
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
</file_contents>
|
||||
<user_instructions>
|
||||
make the crud and example for all files in lib/hero/herofs
|
||||
@@ -1436,5 +1453,4 @@ check the implementation
|
||||
|
||||
do the implementation
|
||||
|
||||
|
||||
</user_instructions>
|
||||
|
||||
15
aiprompts/instructions_archive/README.md
Normal file
15
aiprompts/instructions_archive/README.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Instructions Archive (Legacy Prompts)
|
||||
|
||||
This directory contains **archived / legacy AI prompt material** for `herolib`.
|
||||
|
||||
- Files here may describe **older workflows** (e.g. previous documentation generation or model pipelines).
|
||||
- They are kept for **historical reference** and to help understand how things evolved.
|
||||
- They are **not** guaranteed to match the current `herolib` implementation.
|
||||
|
||||
## Usage Guidelines
|
||||
|
||||
- Do **not** use these files as the primary source for new features or refactors.
|
||||
- When generating code or documentation, prefer:
|
||||
1. Code and module docs under `lib/` (e.g. `lib/web/site/ai_instructions.md`, `lib/web/docusaurus/README.md`).
|
||||
2. Up-to-date AI instructions under `aiprompts/` (outside of `instructions_archive/`).
|
||||
- Only consult this directory when you explicitly need to understand **historical behavior** or migrate old flows.
|
||||
@@ -18,8 +18,8 @@ the template is as follows
|
||||
## factory
|
||||
|
||||
is there factory, which one and quick example how to call, don’t say in which file not relevant
|
||||
show how to import the module is as follows: import freeflowuniverse.herolib.
|
||||
and then starting from lib e.g. lib/clients/mycelium would result in import freeflowuniverse.herolib. clients.mycelium
|
||||
show how to import the module is as follows: import incubaid.herolib.
|
||||
and then starting from lib e.g. lib/clients/mycelium would result in import incubaid.herolib. clients.mycelium
|
||||
|
||||
## overview
|
||||
|
||||
|
||||
@@ -10,13 +10,11 @@ start of output file is:
|
||||
## factory
|
||||
|
||||
is there factory, which one and quick example how to call, don’t say in which file not relevant
|
||||
show how to import the module is as follows: import freeflowuniverse.herolib.
|
||||
and then starting from lib e.g. lib/clients/mycelium would result in import freeflowuniverse.herolib. clients.mycelium
|
||||
show how to import the module is as follows: import incubaid.herolib.
|
||||
and then starting from lib e.g. lib/clients/mycelium would result in import incubaid.herolib. clients.mycelium
|
||||
|
||||
## structs and methods
|
||||
|
||||
quick overview as list with identations, of the structs and its methods
|
||||
|
||||
|
||||
ONLY OUTPUT THE MARKDOWN FILE, NOTHING ELSE
|
||||
|
||||
|
||||
@@ -468,6 +468,7 @@
|
||||
|
||||
<file_contents>
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/aiprompts/herolib_core/core_curdir_example.md
|
||||
|
||||
```md
|
||||
# Getting the Current Script's Path in Herolib/V Shell
|
||||
|
||||
@@ -493,42 +494,43 @@ the following is a good pragmatic way to remember clients, installers as a globa
|
||||
|
||||
module docsite
|
||||
|
||||
import freeflowuniverse.herolib.core.texttools
|
||||
import incubaid.herolib.core.texttools
|
||||
|
||||
__global (
|
||||
siteconfigs map[string]&SiteConfig
|
||||
siteconfigs map[string]&SiteConfig
|
||||
)
|
||||
|
||||
@[params]
|
||||
pub struct FactoryArgs {
|
||||
pub mut:
|
||||
name string = "default"
|
||||
name string = "default"
|
||||
}
|
||||
|
||||
pub fn new(args FactoryArgs) !&SiteConfig {
|
||||
name := texttools.name_fix(args.name)
|
||||
siteconfigs[name] = &SiteConfig{
|
||||
name: name
|
||||
}
|
||||
return get(name:name)!
|
||||
name := texttools.name_fix(args.name)
|
||||
siteconfigs[name] = &SiteConfig{
|
||||
name: name
|
||||
}
|
||||
return get(name:name)!
|
||||
}
|
||||
|
||||
pub fn get(args FactoryArgs) !&SiteConfig {
|
||||
name := texttools.name_fix(args.name)
|
||||
mut sc := siteconfigs[name] or {
|
||||
return error('siteconfig with name "${name}" does not exist')
|
||||
}
|
||||
return sc
|
||||
name := texttools.name_fix(args.name)
|
||||
mut sc := siteconfigs[name] or {
|
||||
return error('siteconfig with name "${name}" does not exist')
|
||||
}
|
||||
return sc
|
||||
}
|
||||
|
||||
pub fn default() !&SiteConfig {
|
||||
if siteconfigs.len == 0 {
|
||||
return new(name:'default')!
|
||||
}
|
||||
return get()!
|
||||
if siteconfigs.len == 0 {
|
||||
return new(name:'default')!
|
||||
}
|
||||
return get()!
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/aiprompts/herolib_core/core_heroscript_basics.md
|
||||
@@ -541,53 +543,53 @@ HeroScript is a concise scripting language with the following structure:
|
||||
|
||||
```heroscript
|
||||
!!actor.action_name
|
||||
param1: 'value1'
|
||||
param2: 'value with spaces'
|
||||
multiline_description: '
|
||||
This is a multiline description.
|
||||
It can span multiple lines.
|
||||
'
|
||||
arg1 arg2 // Arguments without keys
|
||||
param1: 'value1'
|
||||
param2: 'value with spaces'
|
||||
multiline_description: '
|
||||
This is a multiline description.
|
||||
It can span multiple lines.
|
||||
'
|
||||
arg1 arg2 // Arguments without keys
|
||||
```
|
||||
|
||||
Key characteristics:
|
||||
- **Actions**: Start with `!!`, followed by `actor.action_name` (e.g., `!!mailclient.configure`).
|
||||
- **Parameters**: Defined as `key:value`. Values can be quoted for spaces.
|
||||
- **Multiline Support**: Parameters like `description` can span multiple lines.
|
||||
- **Arguments**: Values without keys (e.g., `arg1`).
|
||||
|
||||
- __Actions__: Start with `!!`, followed by `actor.action_name` (e.g., `!!mailclient.configure`).
|
||||
- __Parameters__: Defined as `key:value`. Values can be quoted for spaces.
|
||||
- __Multiline Support__: Parameters like `description` can span multiple lines.
|
||||
- __Arguments__: Values without keys (e.g., `arg1`).
|
||||
|
||||
## Processing HeroScript in Vlang
|
||||
|
||||
HeroScript can be parsed into a `playbook.PlayBook` object, allowing structured access to actions and their parameters, this is used in most of the herolib modules, it allows configuration or actions in a structured way.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.playbook { PlayBook }
|
||||
import freeflowuniverse.herolib.ui.console
|
||||
import incubaid.herolib.core.playbook { PlayBook }
|
||||
import incubaid.herolib.ui.console
|
||||
|
||||
pub fn play(mut plbook PlayBook) ! {
|
||||
|
||||
if plbook.exists_once(filter: 'docusaurus.define') {
|
||||
mut action := plbook.get(filter: 'docusaurus.define')!
|
||||
mut p := action.params
|
||||
//example how we get parameters from the action see core_params.md for more details
|
||||
ds = new(
|
||||
path: p.get_default('path_publish', '')!
|
||||
production: p.get_default_false('production')
|
||||
)!
|
||||
}
|
||||
if plbook.exists_once(filter: 'docusaurus.define') {
|
||||
mut action := plbook.get(filter: 'docusaurus.define')!
|
||||
mut p := action.params
|
||||
//example how we get parameters from the action see core_params.md for more details
|
||||
ds = new(
|
||||
path: p.get_default('path_publish', '')!
|
||||
production: p.get_default_false('production')
|
||||
)!
|
||||
}
|
||||
|
||||
// Process 'docusaurus.add' actions to configure individual Docusaurus sites
|
||||
actions := plbook.find(filter: 'docusaurus.add')!
|
||||
for action in actions {
|
||||
mut p := action.params
|
||||
//do more processing here
|
||||
}
|
||||
// Process 'docusaurus.add' actions to configure individual Docusaurus sites
|
||||
actions := plbook.find(filter: 'docusaurus.add')!
|
||||
for action in actions {
|
||||
mut p := action.params
|
||||
//do more processing here
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
For detailed information on parameter retrieval methods (e.g., `p.get()`, `p.get_int()`, `p.get_default_true()`), refer to `aiprompts/ai_core/core_params.md`.
|
||||
|
||||
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/aiprompts/herolib_core/core_heroscript_playbook.md
|
||||
@@ -599,8 +601,8 @@ File: /Users/despiegk/code/github/incubaid/herolib/aiprompts/herolib_core/core_h
|
||||
HeroScript can be parsed into a `playbook.PlayBook` object, allowing structured access to actions and their parameters.
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.playbook
|
||||
import freeflowuniverse.herolib.core.playcmds
|
||||
import incubaid.herolib.core.playbook
|
||||
import incubaid.herolib.core.playcmds
|
||||
|
||||
// path string
|
||||
// text string
|
||||
@@ -616,8 +618,6 @@ playcmds.run(mut plbook)!
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/aiprompts/herolib_core/core_http_client.md
|
||||
@@ -636,7 +636,7 @@ The `HTTPConnection` module provides a robust HTTP client for Vlang, supporting
|
||||
## Basic Usage
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.httpconnection
|
||||
import incubaid.herolib.core.httpconnection
|
||||
|
||||
// Create a new HTTP connection
|
||||
mut conn := httpconnection.new(
|
||||
@@ -654,17 +654,17 @@ To integrate `HTTPConnection` into a management class (e.g., `HetznerManager`),
|
||||
```v
|
||||
// Example: HetznerManager
|
||||
pub fn (mut h HetznerManager) connection() !&httpconnection.HTTPConnection {
|
||||
mut c := h.conn or {
|
||||
mut c2 := httpconnection.new(
|
||||
name: 'hetzner_${h.name}'
|
||||
url: h.baseurl
|
||||
cache: true
|
||||
retry: 3
|
||||
)!
|
||||
c2.basic_auth(h.user, h.password)
|
||||
c2
|
||||
}
|
||||
return c
|
||||
mut c := h.conn or {
|
||||
mut c2 := httpconnection.new(
|
||||
name: 'hetzner_${h.name}'
|
||||
url: h.baseurl
|
||||
cache: true
|
||||
retry: 3
|
||||
)!
|
||||
c2.basic_auth(h.user, h.password)
|
||||
c2
|
||||
}
|
||||
return c
|
||||
}
|
||||
```
|
||||
|
||||
@@ -733,14 +733,15 @@ user := conn.get_json_generic[User](
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/aiprompts/herolib_core/core_osal.md
|
||||
|
||||
```md
|
||||
# OSAL Core Module - Key Capabilities (freeflowuniverse.herolib.osal.core)
|
||||
# OSAL Core Module - Key Capabilities (incubaid.herolib.osal.core)
|
||||
|
||||
|
||||
```v
|
||||
//example how to get started
|
||||
|
||||
import freeflowuniverse.herolib.osal.core as osal
|
||||
import incubaid.herolib.osal.core as osal
|
||||
|
||||
osal.exec(cmd:"ls /")!
|
||||
|
||||
@@ -752,50 +753,49 @@ this document has info about the most core functions, more detailed info can be
|
||||
|
||||
### 1. Process Execution
|
||||
|
||||
* **`osal.exec(cmd: Command) !Job`**: Execute a shell command.
|
||||
* **Key Parameters**: `cmd` (string), `timeout` (int), `retry` (int), `work_folder` (string), `environment` (map[string]string), `stdout` (bool), `raise_error` (bool).
|
||||
* **Returns**: `Job` (status, output, error, exit code).
|
||||
* **`osal.execute_silent(cmd string) !string`**: Execute silently, return output.
|
||||
* **`osal.cmd_exists(cmd string) bool`**: Check if a command exists.
|
||||
* **`osal.process_kill_recursive(args: ProcessKillArgs) !`**: Kill a process and its children.
|
||||
- __`osal.exec(cmd: Command) !Job`__: Execute a shell command.
|
||||
- __Key Parameters__: `cmd` (string), `timeout` (int), `retry` (int), `work_folder` (string), `environment` (map[string]string), `stdout` (bool), `raise_error` (bool).
|
||||
- __Returns__: `Job` (status, output, error, exit code).
|
||||
- __`osal.execute_silent(cmd string) !string`__: Execute silently, return output.
|
||||
- __`osal.cmd_exists(cmd string) bool`__: Check if a command exists.
|
||||
- __`osal.process_kill_recursive(args: ProcessKillArgs) !`__: Kill a process and its children.
|
||||
|
||||
### 2. Network Utilities
|
||||
|
||||
* **`osal.ping(args: PingArgs) !bool`**: Check host reachability.
|
||||
* **`osal.tcp_port_test(args: TcpPortTestArgs) bool`**: Test if a TCP port is open.
|
||||
* **Key Parameters**: `address` (string), `port` (int).
|
||||
* **`osal.ipaddr_pub_get() !string`**: Get public IP address.
|
||||
- __`osal.ping(args: PingArgs) !bool`__: Check host reachability.
|
||||
- __`osal.tcp_port_test(args: TcpPortTestArgs) bool`__: Test if a TCP port is open.
|
||||
- __Key Parameters__: `address` (string), `port` (int).
|
||||
- __`osal.ipaddr_pub_get() !string`__: Get public IP address.
|
||||
|
||||
### 3. File System Operations
|
||||
|
||||
* **`osal.file_write(path string, text string) !`**: Write text to a file.
|
||||
* **`osal.file_read(path string) !string`**: Read content from a file.
|
||||
* **`osal.dir_ensure(path string) !`**: Ensure a directory exists.
|
||||
* **`osal.rm(todelete string) !`**: Remove files/directories.
|
||||
- __`osal.file_write(path string, text string) !`__: Write text to a file.
|
||||
- __`osal.file_read(path string) !string`__: Read content from a file.
|
||||
- __`osal.dir_ensure(path string) !`__: Ensure a directory exists.
|
||||
- __`osal.rm(todelete string) !`__: Remove files/directories.
|
||||
|
||||
### 4. Environment Variables
|
||||
|
||||
* **`osal.env_set(args: EnvSet)`**: Set an environment variable.
|
||||
* **Key Parameters**: `key` (string), `value` (string).
|
||||
* **`osal.env_get(key string) !string`**: Get an environment variable's value.
|
||||
* **`osal.load_env_file(file_path string) !`**: Load variables from a file.
|
||||
- __`osal.env_set(args: EnvSet)`__: Set an environment variable.
|
||||
- __Key Parameters__: `key` (string), `value` (string).
|
||||
- __`osal.env_get(key string) !string`__: Get an environment variable's value.
|
||||
- __`osal.load_env_file(file_path string) !`__: Load variables from a file.
|
||||
|
||||
### 5. Command & Profile Management
|
||||
|
||||
* **`osal.cmd_add(args: CmdAddArgs) !`**: Add a binary to system paths and update profiles.
|
||||
* **Key Parameters**: `source` (string, required), `cmdname` (string).
|
||||
* **`osal.profile_path_add_remove(args: ProfilePathAddRemoveArgs) !`**: Add/remove paths from profiles.
|
||||
* **Key Parameters**: `paths2add` (string), `paths2delete` (string).
|
||||
- __`osal.cmd_add(args: CmdAddArgs) !`__: Add a binary to system paths and update profiles.
|
||||
- __Key Parameters__: `source` (string, required), `cmdname` (string).
|
||||
- __`osal.profile_path_add_remove(args: ProfilePathAddRemoveArgs) !`__: Add/remove paths from profiles.
|
||||
- __Key Parameters__: `paths2add` (string), `paths2delete` (string).
|
||||
|
||||
### 6. System Information
|
||||
|
||||
* **`osal.platform() !PlatformType`**: Identify the operating system.
|
||||
* **`osal.cputype() !CPUType`**: Identify the CPU architecture.
|
||||
* **`osal.hostname() !string`**: Get system hostname.
|
||||
- __`osal.platform() !PlatformType`__: Identify the operating system.
|
||||
- __`osal.cputype() !CPUType`__: Identify the CPU architecture.
|
||||
- __`osal.hostname() !string`__: Get system hostname.
|
||||
|
||||
---
|
||||
|
||||
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/aiprompts/herolib_core/core_ourtime.md
|
||||
@@ -814,7 +814,7 @@ The `OurTime` module in V provides flexible time handling, supporting relative a
|
||||
## Basic Usage
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.data.ourtime
|
||||
import incubaid.herolib.data.ourtime
|
||||
|
||||
// Current time
|
||||
mut t := ourtime.now()
|
||||
@@ -896,6 +896,7 @@ t_invalid := ourtime.new('bad-date') or {
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/aiprompts/herolib_core/core_params.md
|
||||
|
||||
```md
|
||||
# Parameter Parsing in Vlang
|
||||
|
||||
@@ -904,7 +905,7 @@ This document details the `paramsparser` module, essential for handling paramete
|
||||
## Obtaining a `paramsparser` Instance
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.data.paramsparser
|
||||
import incubaid.herolib.data.paramsparser
|
||||
|
||||
// Create new params from a string
|
||||
params := paramsparser.new("color:red size:'large' priority:1 enable:true")!
|
||||
@@ -918,12 +919,13 @@ params.set("color", "red")
|
||||
|
||||
The parser supports various input formats:
|
||||
|
||||
1. **Key-value pairs**: `key:value`
|
||||
2. **Quoted values**: `key:'value with spaces'` (single or double quotes)
|
||||
3. **Arguments without keys**: `arg1 arg2` (accessed by index)
|
||||
4. **Comments**: `// this is a comment` (ignored during parsing)
|
||||
1. __Key-value pairs__: `key:value`
|
||||
2. __Quoted values__: `key:'value with spaces'` (single or double quotes)
|
||||
3. __Arguments without keys__: `arg1 arg2` (accessed by index)
|
||||
4. __Comments__: `// this is a comment` (ignored during parsing)
|
||||
|
||||
Example:
|
||||
|
||||
```v
|
||||
text := "name:'John Doe' age:30 active:true // user details"
|
||||
params := paramsparser.new(text)!
|
||||
@@ -935,77 +937,77 @@ The `paramsparser` module provides a comprehensive set of methods for retrieving
|
||||
|
||||
### Basic Retrieval
|
||||
|
||||
- `get(key string) !string`: Retrieves a string value by key. Returns an error if the key does not exist.
|
||||
- `get_default(key string, defval string) !string`: Retrieves a string value by key, or returns `defval` if the key is not found.
|
||||
- `exists(key string) bool`: Checks if a keyword argument (`key:value`) exists.
|
||||
- `exists_arg(key string) bool`: Checks if an argument (value without a key) exists.
|
||||
- `get(key string) !string`: Retrieves a string value by key. Returns an error if the key does not exist.
|
||||
- `get_default(key string, defval string) !string`: Retrieves a string value by key, or returns `defval` if the key is not found.
|
||||
- `exists(key string) bool`: Checks if a keyword argument (`key:value`) exists.
|
||||
- `exists_arg(key string) bool`: Checks if an argument (value without a key) exists.
|
||||
|
||||
### Argument Retrieval (Positional)
|
||||
|
||||
- `get_arg(nr int) !string`: Retrieves an argument by its 0-based index. Returns an error if the index is out of bounds.
|
||||
- `get_arg_default(nr int, defval string) !string`: Retrieves an argument by index, or returns `defval` if the index is out of bounds.
|
||||
- `get_arg(nr int) !string`: Retrieves an argument by its 0-based index. Returns an error if the index is out of bounds.
|
||||
- `get_arg_default(nr int, defval string) !string`: Retrieves an argument by index, or returns `defval` if the index is out of bounds.
|
||||
|
||||
### Type-Specific Retrieval
|
||||
|
||||
- `get_int(key string) !int`: Converts and retrieves an integer (int32).
|
||||
- `get_int_default(key string, defval int) !int`: Retrieves an integer with a default.
|
||||
- `get_u32(key string) !u32`: Converts and retrieves an unsigned 32-bit integer.
|
||||
- `get_u32_default(key string, defval u32) !u32`: Retrieves a u32 with a default.
|
||||
- `get_u64(key string) !u64`: Converts and retrieves an unsigned 64-bit integer.
|
||||
- `get_u64_default(key string, defval u64) !u64`: Retrieves a u64 with a default.
|
||||
- `get_u8(key string) !u8`: Converts and retrieves an unsigned 8-bit integer.
|
||||
- `get_u8_default(key string, defval u8) !u8`: Retrieves a u8 with a default.
|
||||
- `get_float(key string) !f64`: Converts and retrieves a 64-bit float.
|
||||
- `get_float_default(key string, defval f64) !f64`: Retrieves a float with a default.
|
||||
- `get_percentage(key string) !f64`: Converts a percentage string (e.g., "80%") to a float (0.8).
|
||||
- `get_percentage_default(key string, defval string) !f64`: Retrieves a percentage with a default.
|
||||
- `get_int(key string) !int`: Converts and retrieves an integer (int32).
|
||||
- `get_int_default(key string, defval int) !int`: Retrieves an integer with a default.
|
||||
- `get_u32(key string) !u32`: Converts and retrieves an unsigned 32-bit integer.
|
||||
- `get_u32_default(key string, defval u32) !u32`: Retrieves a u32 with a default.
|
||||
- `get_u64(key string) !u64`: Converts and retrieves an unsigned 64-bit integer.
|
||||
- `get_u64_default(key string, defval u64) !u64`: Retrieves a u64 with a default.
|
||||
- `get_u8(key string) !u8`: Converts and retrieves an unsigned 8-bit integer.
|
||||
- `get_u8_default(key string, defval u8) !u8`: Retrieves a u8 with a default.
|
||||
- `get_float(key string) !f64`: Converts and retrieves a 64-bit float.
|
||||
- `get_float_default(key string, defval f64) !f64`: Retrieves a float with a default.
|
||||
- `get_percentage(key string) !f64`: Converts a percentage string (e.g., "80%") to a float (0.8).
|
||||
- `get_percentage_default(key string, defval string) !f64`: Retrieves a percentage with a default.
|
||||
|
||||
### Boolean Retrieval
|
||||
|
||||
- `get_default_true(key string) bool`: Returns `true` if the value is empty, "1", "true", "y", or "yes". Otherwise `false`.
|
||||
- `get_default_false(key string) bool`: Returns `false` if the value is empty, "0", "false", "n", or "no". Otherwise `true`.
|
||||
- `get_default_true(key string) bool`: Returns `true` if the value is empty, "1", "true", "y", or "yes". Otherwise `false`.
|
||||
- `get_default_false(key string) bool`: Returns `false` if the value is empty, "0", "false", "n", or "no". Otherwise `true`.
|
||||
|
||||
### List Retrieval
|
||||
|
||||
Lists are typically comma-separated strings (e.g., `users: "john,jane,bob"`).
|
||||
|
||||
- `get_list(key string) ![]string`: Retrieves a list of strings.
|
||||
- `get_list_default(key string, def []string) ![]string`: Retrieves a list of strings with a default.
|
||||
- `get_list_int(key string) ![]int`: Retrieves a list of integers.
|
||||
- `get_list_int_default(key string, def []int) []int`: Retrieves a list of integers with a default.
|
||||
- `get_list_f32(key string) ![]f32`: Retrieves a list of 32-bit floats.
|
||||
- `get_list_f32_default(key string, def []f32) []f32`: Retrieves a list of f32 with a default.
|
||||
- `get_list_f64(key string) ![]f64`: Retrieves a list of 64-bit floats.
|
||||
- `get_list_f64_default(key string, def []f64) []f64`: Retrieves a list of f64 with a default.
|
||||
- `get_list_i8(key string) ![]i8`: Retrieves a list of 8-bit signed integers.
|
||||
- `get_list_i8_default(key string, def []i8) []i8`: Retrieves a list of i8 with a default.
|
||||
- `get_list_i16(key string) ![]i16`: Retrieves a list of 16-bit signed integers.
|
||||
- `get_list_i16_default(key string, def []i16) []i16`: Retrieves a list of i16 with a default.
|
||||
- `get_list_i64(key string) ![]i64`: Retrieves a list of 64-bit signed integers.
|
||||
- `get_list_i64_default(key string, def []i64) []i64`: Retrieves a list of i64 with a default.
|
||||
- `get_list_u16(key string) ![]u16`: Retrieves a list of 16-bit unsigned integers.
|
||||
- `get_list_u16_default(key string, def []u16) []u16`: Retrieves a list of u16 with a default.
|
||||
- `get_list_u32(key string) ![]u32`: Retrieves a list of 32-bit unsigned integers.
|
||||
- `get_list_u32_default(key string, def []u32) []u32`: Retrieves a list of u32 with a default.
|
||||
- `get_list_u64(key string) ![]u64`: Retrieves a list of 64-bit unsigned integers.
|
||||
- `get_list_u64_default(key string, def []u64) []u64`: Retrieves a list of u64 with a default.
|
||||
- `get_list_namefix(key string) ![]string`: Retrieves a list of strings, normalizing each item (e.g., "My Name" -> "my_name").
|
||||
- `get_list_namefix_default(key string, def []string) ![]string`: Retrieves a list of name-fixed strings with a default.
|
||||
- `get_list(key string) ![]string`: Retrieves a list of strings.
|
||||
- `get_list_default(key string, def []string) ![]string`: Retrieves a list of strings with a default.
|
||||
- `get_list_int(key string) ![]int`: Retrieves a list of integers.
|
||||
- `get_list_int_default(key string, def []int) []int`: Retrieves a list of integers with a default.
|
||||
- `get_list_f32(key string) ![]f32`: Retrieves a list of 32-bit floats.
|
||||
- `get_list_f32_default(key string, def []f32) []f32`: Retrieves a list of f32 with a default.
|
||||
- `get_list_f64(key string) ![]f64`: Retrieves a list of 64-bit floats.
|
||||
- `get_list_f64_default(key string, def []f64) []f64`: Retrieves a list of f64 with a default.
|
||||
- `get_list_i8(key string) ![]i8`: Retrieves a list of 8-bit signed integers.
|
||||
- `get_list_i8_default(key string, def []i8) []i8`: Retrieves a list of i8 with a default.
|
||||
- `get_list_i16(key string) ![]i16`: Retrieves a list of 16-bit signed integers.
|
||||
- `get_list_i16_default(key string, def []i16) []i16`: Retrieves a list of i16 with a default.
|
||||
- `get_list_i64(key string) ![]i64`: Retrieves a list of 64-bit signed integers.
|
||||
- `get_list_i64_default(key string, def []i64) []i64`: Retrieves a list of i64 with a default.
|
||||
- `get_list_u16(key string) ![]u16`: Retrieves a list of 16-bit unsigned integers.
|
||||
- `get_list_u16_default(key string, def []u16) []u16`: Retrieves a list of u16 with a default.
|
||||
- `get_list_u32(key string) ![]u32`: Retrieves a list of 32-bit unsigned integers.
|
||||
- `get_list_u32_default(key string, def []u32) []u32`: Retrieves a list of u32 with a default.
|
||||
- `get_list_u64(key string) ![]u64`: Retrieves a list of 64-bit unsigned integers.
|
||||
- `get_list_u64_default(key string, def []u64) []u64`: Retrieves a list of u64 with a default.
|
||||
- `get_list_namefix(key string) ![]string`: Retrieves a list of strings, normalizing each item (e.g., "My Name" -> "my_name").
|
||||
- `get_list_namefix_default(key string, def []string) ![]string`: Retrieves a list of name-fixed strings with a default.
|
||||
|
||||
### Specialized Retrieval
|
||||
|
||||
- `get_map() map[string]string`: Returns all parameters as a map.
|
||||
- `get_path(key string) !string`: Retrieves a path string.
|
||||
- `get_path_create(key string) !string`: Retrieves a path string, creating the directory if it doesn't exist.
|
||||
- `get_from_hashmap(key string, defval string, hashmap map[string]string) !string`: Retrieves a value from a provided hashmap based on the parameter's value.
|
||||
- `get_storagecapacity_in_bytes(key string) !u64`: Converts storage capacity strings (e.g., "10 GB", "500 MB") to bytes (u64).
|
||||
- `get_storagecapacity_in_bytes_default(key string, defval u64) !u64`: Retrieves storage capacity in bytes with a default.
|
||||
- `get_storagecapacity_in_gigabytes(key string) !u64`: Converts storage capacity strings to gigabytes (u64).
|
||||
- `get_time(key string) !ourtime.OurTime`: Parses a time string (relative or absolute) into an `ourtime.OurTime` object.
|
||||
- `get_time_default(key string, defval ourtime.OurTime) !ourtime.OurTime`: Retrieves time with a default.
|
||||
- `get_time_interval(key string) !Duration`: Parses a time interval string into a `Duration` object.
|
||||
- `get_timestamp(key string) !Duration`: Parses a timestamp string into a `Duration` object.
|
||||
- `get_timestamp_default(key string, defval Duration) !Duration`: Retrieves a timestamp with a default.
|
||||
- `get_map() map[string]string`: Returns all parameters as a map.
|
||||
- `get_path(key string) !string`: Retrieves a path string.
|
||||
- `get_path_create(key string) !string`: Retrieves a path string, creating the directory if it doesn't exist.
|
||||
- `get_from_hashmap(key string, defval string, hashmap map[string]string) !string`: Retrieves a value from a provided hashmap based on the parameter's value.
|
||||
- `get_storagecapacity_in_bytes(key string) !u64`: Converts storage capacity strings (e.g., "10 GB", "500 MB") to bytes (u64).
|
||||
- `get_storagecapacity_in_bytes_default(key string, defval u64) !u64`: Retrieves storage capacity in bytes with a default.
|
||||
- `get_storagecapacity_in_gigabytes(key string) !u64`: Converts storage capacity strings to gigabytes (u64).
|
||||
- `get_time(key string) !ourtime.OurTime`: Parses a time string (relative or absolute) into an `ourtime.OurTime` object.
|
||||
- `get_time_default(key string, defval ourtime.OurTime) !ourtime.OurTime`: Retrieves time with a default.
|
||||
- `get_time_interval(key string) !Duration`: Parses a time interval string into a `Duration` object.
|
||||
- `get_timestamp(key string) !Duration`: Parses a timestamp string into a `Duration` object.
|
||||
- `get_timestamp_default(key string, defval Duration) !Duration`: Retrieves a timestamp with a default.
|
||||
|
||||
```
|
||||
|
||||
@@ -1028,10 +1030,11 @@ The pathlib module provides a comprehensive interface for handling file system o
|
||||
|
||||
### Importing pathlib
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.pathlib
|
||||
import incubaid.herolib.core.pathlib
|
||||
```
|
||||
|
||||
### Creating Path Objects
|
||||
|
||||
```v
|
||||
// Create a Path object for a file
|
||||
mut file_path := pathlib.get("path/to/file.txt")
|
||||
@@ -1041,6 +1044,7 @@ mut dir_path := pathlib.get("path/to/directory")
|
||||
```
|
||||
|
||||
### Basic Path Operations
|
||||
|
||||
```v
|
||||
// Get absolute path
|
||||
abs_path := file_path.absolute()
|
||||
@@ -1057,6 +1061,7 @@ if file_path.exists() {
|
||||
## Path Properties and Methods
|
||||
|
||||
### Path Types
|
||||
|
||||
```v
|
||||
// Check if path is a file
|
||||
if file_path.is_file() {
|
||||
@@ -1075,6 +1080,7 @@ if file_path.is_link() {
|
||||
```
|
||||
|
||||
### Path Normalization
|
||||
|
||||
```v
|
||||
// Normalize path (remove extra slashes, resolve . and ..)
|
||||
normalized_path := file_path.path_normalize()
|
||||
@@ -1089,6 +1095,7 @@ name_no_ext := file_path.name_no_ext()
|
||||
## File and Directory Operations
|
||||
|
||||
### File Operations
|
||||
|
||||
```v
|
||||
// Write to file
|
||||
file_path.write("Content to write")!
|
||||
@@ -1101,6 +1108,7 @@ file_path.delete()!
|
||||
```
|
||||
|
||||
### Directory Operations
|
||||
|
||||
```v
|
||||
// Create directory
|
||||
mut dir := pathlib.get_dir(
|
||||
@@ -1116,6 +1124,7 @@ dir.delete()!
|
||||
```
|
||||
|
||||
### Symlink Operations
|
||||
|
||||
```v
|
||||
// Create symlink
|
||||
file_path.link("path/to/symlink", delete_exists: true)!
|
||||
@@ -1127,12 +1136,14 @@ real_path := file_path.realpath()
|
||||
## Advanced Operations
|
||||
|
||||
### Path Copying
|
||||
|
||||
```v
|
||||
// Copy file to destination
|
||||
file_path.copy(dest: "path/to/destination")!
|
||||
```
|
||||
|
||||
### Recursive Operations
|
||||
|
||||
```v
|
||||
// List directory recursively
|
||||
mut recursive_list := dir.list(recursive: true)!
|
||||
@@ -1142,6 +1153,7 @@ dir.delete()!
|
||||
```
|
||||
|
||||
### Path Filtering
|
||||
|
||||
```v
|
||||
// List files matching pattern
|
||||
mut filtered_list := dir.list(
|
||||
@@ -1153,6 +1165,7 @@ mut filtered_list := dir.list(
|
||||
## Best Practices
|
||||
|
||||
### Error Handling
|
||||
|
||||
```v
|
||||
if file_path.exists() {
|
||||
// Safe to operate
|
||||
@@ -1161,7 +1174,6 @@ if file_path.exists() {
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/github/incubaid/herolib/aiprompts/herolib_core/core_text.md
|
||||
@@ -1173,93 +1185,121 @@ The `texttools` module provides a comprehensive set of utilities for text manipu
|
||||
## Functions and Examples:
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.core.texttools
|
||||
import incubaid.herolib.core.texttools
|
||||
|
||||
assert hello_world == texttools.name_fix("Hello World!")
|
||||
|
||||
```
|
||||
|
||||
### Name/Path Processing
|
||||
* `name_fix(name string) string`: Normalizes filenames and paths.
|
||||
* `name_fix_keepspace(name string) !string`: Like name_fix but preserves spaces.
|
||||
* `name_fix_no_ext(name_ string) string`: Removes file extension.
|
||||
* `name_fix_snake_to_pascal(name string) string`: Converts snake_case to PascalCase.
|
||||
|
||||
* `name_fix(name string) string`: Normalizes filenames and paths.
|
||||
- `name_fix_keepspace(name string) !string`: Like name_fix but preserves spaces.
|
||||
- `name_fix_no_ext(name_ string) string`: Removes file extension.
|
||||
- `name_fix_snake_to_pascal(name string) string`: Converts snake_case to PascalCase.
|
||||
|
||||
```v
|
||||
name := texttools.name_fix_snake_to_pascal("hello_world") // Result: "HelloWorld"
|
||||
```
|
||||
* `snake_case(name string) string`: Converts PascalCase to snake_case.
|
||||
|
||||
* `snake_case(name string) string`: Converts PascalCase to snake_case.
|
||||
|
||||
```v
|
||||
name := texttools.snake_case("HelloWorld") // Result: "hello_world"
|
||||
```
|
||||
* `name_split(name string) !(string, string)`: Splits name into site and page components.
|
||||
|
||||
* `name_split(name string) !(string, string)`: Splits name into site and page components.
|
||||
|
||||
### Text Cleaning
|
||||
* `name_clean(r string) string`: Normalizes names by removing special characters.
|
||||
|
||||
* `name_clean(r string) string`: Normalizes names by removing special characters.
|
||||
|
||||
```v
|
||||
name := texttools.name_clean("Hello@World!") // Result: "HelloWorld"
|
||||
```
|
||||
* `ascii_clean(r string) string`: Removes all non-ASCII characters.
|
||||
* `remove_empty_lines(text string) string`: Removes empty lines from text.
|
||||
|
||||
* `ascii_clean(r string) string`: Removes all non-ASCII characters.
|
||||
- `remove_empty_lines(text string) string`: Removes empty lines from text.
|
||||
|
||||
```v
|
||||
text := texttools.remove_empty_lines("line1\n\nline2\n\n\nline3") // Result: "line1\nline2\nline3"
|
||||
```
|
||||
* `remove_double_lines(text string) string`: Removes consecutive empty lines.
|
||||
* `remove_empty_js_blocks(text string) string`: Removes empty code blocks (```...```).
|
||||
|
||||
* `remove_double_lines(text string) string`: Removes consecutive empty lines.
|
||||
- `remove_empty_js_blocks(text string) string`: Removes empty code blocks (```...```).
|
||||
|
||||
### Command Line Parsing
|
||||
* `cmd_line_args_parser(text string) ![]string`: Parses command line arguments with support for quotes and escaping.
|
||||
|
||||
* `cmd_line_args_parser(text string) ![]string`: Parses command line arguments with support for quotes and escaping.
|
||||
|
||||
```v
|
||||
args := texttools.cmd_line_args_parser("'arg with spaces' --flag=value") // Result: ['arg with spaces', '--flag=value']
|
||||
```
|
||||
* `text_remove_quotes(text string) string`: Removes quoted sections from text.
|
||||
* `check_exists_outside_quotes(text string, items []string) bool`: Checks if items exist in text outside of quotes.
|
||||
|
||||
* `text_remove_quotes(text string) string`: Removes quoted sections from text.
|
||||
- `check_exists_outside_quotes(text string, items []string) bool`: Checks if items exist in text outside of quotes.
|
||||
|
||||
### Text Expansion
|
||||
* `expand(txt_ string, l int, expand_with string) string`: Expands text to a specified length with a given character.
|
||||
|
||||
* `expand(txt_ string, l int, expand_with string) string`: Expands text to a specified length with a given character.
|
||||
|
||||
### Indentation
|
||||
* `indent(text string, prefix string) string`: Adds indentation prefix to each line.
|
||||
|
||||
* `indent(text string, prefix string) string`: Adds indentation prefix to each line.
|
||||
|
||||
```v
|
||||
text := texttools.indent("line1\nline2", " ") // Result: " line1\n line2\n"
|
||||
```
|
||||
* `dedent(text string) string`: Removes common leading whitespace from every line.
|
||||
|
||||
* `dedent(text string) string`: Removes common leading whitespace from every line.
|
||||
|
||||
```v
|
||||
text := texttools.dedent(" line1\n line2") // Result: "line1\nline2"
|
||||
```
|
||||
|
||||
### String Validation
|
||||
* `is_int(text string) bool`: Checks if text contains only digits.
|
||||
* `is_upper_text(text string) bool`: Checks if text contains only uppercase letters.
|
||||
|
||||
* `is_int(text string) bool`: Checks if text contains only digits.
|
||||
- `is_upper_text(text string) bool`: Checks if text contains only uppercase letters.
|
||||
|
||||
### Multiline Processing
|
||||
* `multiline_to_single(text string) !string`: Converts multiline text to a single line with proper escaping.
|
||||
|
||||
* `multiline_to_single(text string) !string`: Converts multiline text to a single line with proper escaping.
|
||||
|
||||
### Text Splitting
|
||||
* `split_smart(t string, delimiter_ string) []string`: Intelligent string splitting that respects quotes.
|
||||
|
||||
* `split_smart(t string, delimiter_ string) []string`: Intelligent string splitting that respects quotes.
|
||||
|
||||
### Tokenization
|
||||
* `tokenize(text_ string) TokenizerResult`: Tokenizes text into meaningful parts.
|
||||
* `text_token_replace(text string, tofind string, replacewith string) !string`: Replaces tokens in text.
|
||||
|
||||
* `tokenize(text_ string) TokenizerResult`: Tokenizes text into meaningful parts.
|
||||
- `text_token_replace(text string, tofind string, replacewith string) !string`: Replaces tokens in text.
|
||||
|
||||
### Version Parsing
|
||||
* `version(text_ string) int`: Converts version strings to comparable integers.
|
||||
|
||||
* `version(text_ string) int`: Converts version strings to comparable integers.
|
||||
|
||||
```v
|
||||
ver := texttools.version("v0.4.36") // Result: 4036
|
||||
ver = texttools.version("v1.4.36") // Result: 1004036
|
||||
```
|
||||
|
||||
### Formatting
|
||||
* `format_rfc1123(t time.Time) string`: Formats a time.Time object into RFC 1123 format.
|
||||
|
||||
* `format_rfc1123(t time.Time) string`: Formats a time.Time object into RFC 1123 format.
|
||||
|
||||
### Array Operations
|
||||
* `to_array(r string) []string`: Converts a comma or newline separated list to an array of strings.
|
||||
|
||||
* `to_array(r string) []string`: Converts a comma or newline separated list to an array of strings.
|
||||
|
||||
```v
|
||||
text := "item1,item2,item3"
|
||||
array := texttools.to_array(text) // Result: ['item1', 'item2', 'item3']
|
||||
```
|
||||
* `to_array_int(r string) []int`: Converts a text list to an array of integers.
|
||||
* `to_map(mapstring string, line string, delimiter_ string) map[string]string`: Intelligent mapping of a line to a map based on a template.
|
||||
|
||||
* `to_array_int(r string) []int`: Converts a text list to an array of integers.
|
||||
- `to_map(mapstring string, line string, delimiter_ string) map[string]string`: Intelligent mapping of a line to a map based on a template.
|
||||
|
||||
```v
|
||||
r := texttools.to_map("name,-,-,-,-,pid,-,-,-,-,path",
|
||||
"root 304 0.0 0.0 408185328 1360 ?? S 16Dec23 0:34.06 /usr/sbin/distnoted")
|
||||
@@ -1277,7 +1317,7 @@ has mechanisms to print better to console, see the methods below
|
||||
import as
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.ui.console
|
||||
import incubaid.herolib.ui.console
|
||||
|
||||
```
|
||||
|
||||
@@ -1296,23 +1336,23 @@ fn color_fg(c ForegroundColor) string
|
||||
|
||||
struct PrintArgs {
|
||||
pub mut:
|
||||
foreground ForegroundColor
|
||||
background BackgroundColor
|
||||
text string
|
||||
style Style
|
||||
reset_before bool = true
|
||||
reset_after bool = true
|
||||
foreground ForegroundColor
|
||||
background BackgroundColor
|
||||
text string
|
||||
style Style
|
||||
reset_before bool = true
|
||||
reset_after bool = true
|
||||
}
|
||||
|
||||
fn cprint(args PrintArgs)
|
||||
// print with colors, reset...
|
||||
// ```
|
||||
// foreground ForegroundColor
|
||||
// background BackgroundColor
|
||||
// text string
|
||||
// style Style
|
||||
// reset_before bool = true
|
||||
// reset_after bool = true
|
||||
// foreground ForegroundColor
|
||||
// background BackgroundColor
|
||||
// text string
|
||||
// style Style
|
||||
// reset_before bool = true
|
||||
// reset_after bool = true
|
||||
// ```
|
||||
|
||||
fn cprintln(args_ PrintArgs)
|
||||
@@ -1367,11 +1407,11 @@ Is used to ask feedback to users
|
||||
|
||||
struct UIConsole {
|
||||
pub mut:
|
||||
x_max int = 80
|
||||
y_max int = 60
|
||||
prev_lf bool
|
||||
prev_title bool
|
||||
prev_item bool
|
||||
x_max int = 80
|
||||
y_max int = 60
|
||||
prev_lf bool
|
||||
prev_title bool
|
||||
prev_item bool
|
||||
}
|
||||
|
||||
//DropDownArgs:
|
||||
@@ -1422,51 +1462,51 @@ fn (mut c UIConsole) status() string
|
||||
|
||||
```v
|
||||
enum BackgroundColor {
|
||||
default_color = 49 // 'default' is a reserved keyword in V
|
||||
black = 40
|
||||
red = 41
|
||||
green = 42
|
||||
yellow = 43
|
||||
blue = 44
|
||||
magenta = 45
|
||||
cyan = 46
|
||||
light_gray = 47
|
||||
dark_gray = 100
|
||||
light_red = 101
|
||||
light_green = 102
|
||||
light_yellow = 103
|
||||
light_blue = 104
|
||||
light_magenta = 105
|
||||
light_cyan = 106
|
||||
white = 107
|
||||
default_color = 49 // 'default' is a reserved keyword in V
|
||||
black = 40
|
||||
red = 41
|
||||
green = 42
|
||||
yellow = 43
|
||||
blue = 44
|
||||
magenta = 45
|
||||
cyan = 46
|
||||
light_gray = 47
|
||||
dark_gray = 100
|
||||
light_red = 101
|
||||
light_green = 102
|
||||
light_yellow = 103
|
||||
light_blue = 104
|
||||
light_magenta = 105
|
||||
light_cyan = 106
|
||||
white = 107
|
||||
}
|
||||
enum ForegroundColor {
|
||||
default_color = 39 // 'default' is a reserved keyword in V
|
||||
white = 97
|
||||
black = 30
|
||||
red = 31
|
||||
green = 32
|
||||
yellow = 33
|
||||
blue = 34
|
||||
magenta = 35
|
||||
cyan = 36
|
||||
light_gray = 37
|
||||
dark_gray = 90
|
||||
light_red = 91
|
||||
light_green = 92
|
||||
light_yellow = 93
|
||||
light_blue = 94
|
||||
light_magenta = 95
|
||||
light_cyan = 96
|
||||
default_color = 39 // 'default' is a reserved keyword in V
|
||||
white = 97
|
||||
black = 30
|
||||
red = 31
|
||||
green = 32
|
||||
yellow = 33
|
||||
blue = 34
|
||||
magenta = 35
|
||||
cyan = 36
|
||||
light_gray = 37
|
||||
dark_gray = 90
|
||||
light_red = 91
|
||||
light_green = 92
|
||||
light_yellow = 93
|
||||
light_blue = 94
|
||||
light_magenta = 95
|
||||
light_cyan = 96
|
||||
}
|
||||
enum Style {
|
||||
normal = 99
|
||||
bold = 1
|
||||
dim = 2
|
||||
underline = 4
|
||||
blink = 5
|
||||
reverse = 7
|
||||
hidden = 8
|
||||
normal = 99
|
||||
bold = 1
|
||||
dim = 2
|
||||
underline = 4
|
||||
blink = 5
|
||||
reverse = 7
|
||||
hidden = 8
|
||||
}
|
||||
|
||||
```
|
||||
@@ -1482,7 +1522,7 @@ this is how we want example scripts to be, see the first line
|
||||
```v
|
||||
#!/usr/bin/env -S v -cg -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib...
|
||||
import incubaid.herolib...
|
||||
|
||||
```
|
||||
|
||||
@@ -1688,6 +1728,7 @@ impl Company {
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/git.threefold.info/herocode/db/heromodels/src/models/biz/mod.rs
|
||||
|
||||
```rs
|
||||
// Business models module
|
||||
// Sub-modules will be declared here
|
||||
@@ -1712,6 +1753,7 @@ pub use sale::{Sale, SaleItem, SaleStatus};
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/git.threefold.info/herocode/db/heromodels/src/models/biz/payment.rs
|
||||
|
||||
```rs
|
||||
use heromodels_core::BaseModelData;
|
||||
use heromodels_derive::model;
|
||||
@@ -1933,6 +1975,7 @@ impl Payment {
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/git.threefold.info/herocode/db/heromodels/src/models/biz/product.rs
|
||||
|
||||
```rs
|
||||
use heromodels_core::BaseModelData;
|
||||
use heromodels_derive::model;
|
||||
@@ -2086,6 +2129,7 @@ impl Product {
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/git.threefold.info/herocode/db/heromodels/src/models/biz/README.md
|
||||
|
||||
```md
|
||||
# Business Models (`biz`)
|
||||
|
||||
@@ -2149,6 +2193,7 @@ All models use the builder pattern for easy and readable instance creation.
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/git.threefold.info/herocode/db/heromodels/src/models/biz/sale.rs
|
||||
|
||||
```rs
|
||||
use heromodels_core::{BaseModelData, BaseModelDataOps, Model};
|
||||
use rhai::{CustomType, TypeBuilder};
|
||||
@@ -2326,6 +2371,7 @@ impl Sale {
|
||||
```
|
||||
|
||||
File: /Users/despiegk/code/git.threefold.info/herocode/db/heromodels/src/models/biz/shareholder.rs
|
||||
|
||||
```rs
|
||||
use heromodels_core::BaseModelData;
|
||||
use heromodels_derive::model;
|
||||
@@ -2410,6 +2456,7 @@ impl Shareholder {
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
</file_contents>
|
||||
<meta prompt 1 = "[Architect]">
|
||||
You are a senior software architect specializing in code design and implementation planning. Your role is to:
|
||||
@@ -2425,6 +2472,7 @@ You are a senior software architect specializing in code design and implementati
|
||||
- Configuration updates
|
||||
|
||||
For each change:
|
||||
|
||||
- Describe the exact location in the code where changes are needed
|
||||
- Explain the logic and reasoning behind each modification
|
||||
- Provide example signatures, parameters, and return types
|
||||
@@ -2448,7 +2496,6 @@ forget what rust does, there is no special module things needed, no re-exports o
|
||||
|
||||
there is no defaults for empty strings or 0 ints, … defaults are only for non empty stuff
|
||||
|
||||
|
||||
</meta prompt 2>
|
||||
<user_instructions>
|
||||
$NAME = finance
|
||||
@@ -2472,6 +2519,4 @@ at top of each file we have ```module $NAME```
|
||||
|
||||
don't create management classes, only output the structs
|
||||
|
||||
|
||||
|
||||
</user_instructions>
|
||||
|
||||
@@ -17,16 +17,14 @@ don't do anything additional for modules, don't do import
|
||||
|
||||
at top of each file we have ```module $NAME```
|
||||
|
||||
|
||||
make sure all time related fields are in u64 format, use unix timestamp for that
|
||||
|
||||
don't create management classes, only output the structs, don't create a mod.v, don't make .v scripts executatble, don't create a main.v
|
||||
|
||||
|
||||
## now also make sure we use core.base as follows
|
||||
|
||||
```
|
||||
import freeflowuniverse.herolib.hero.models.core
|
||||
import incubaid.herolib.hero.models.core
|
||||
|
||||
// Account represents a financial account for tracking balances and transactions
|
||||
// Supports multiple account types (checking, savings, investment, etc.)
|
||||
|
||||
@@ -3,7 +3,7 @@ for governance and legal
|
||||
|
||||
make sure we use core.base as follows
|
||||
|
||||
import freeflowuniverse.herolib.hero.models.core
|
||||
import incubaid.herolib.hero.models.core
|
||||
|
||||
// Account represents a financial account for tracking balances and transactions
|
||||
// Supports multiple account types (checking, savings, investment, etc.)
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
371
aiprompts/unpolly/unpolly_api.md
Normal file
371
aiprompts/unpolly/unpolly_api.md
Normal file
@@ -0,0 +1,371 @@
|
||||
# Unpoly API – Complete Reference & Operational Guide for AI Coding Agents
|
||||
|
||||
## Introduction
|
||||
|
||||
This document serves as a complete, self-contained reference manual for the **Unpoly JavaScript API**. It is written explicitly for AI coding agents that need to generate, validate, or refactor Unpoly-enhanced HTML and JavaScript code.
|
||||
|
||||
Unpoly is a front-end framework for progressive enhancement. It allows HTML pages to update fragments instead of reloading the full document, enabling seamless transitions, modals, caching, and navigation while maintaining server-side rendering.
|
||||
|
||||
An AI agent should use this manual to:
|
||||
- Understand each Unpoly module and its purpose.
|
||||
- Generate correct `up-*` attributes and JavaScript calls.
|
||||
- Detect configuration errors and provide correction suggestions.
|
||||
- Apply Unpoly in automated scaffolding, validation, and optimization workflows.
|
||||
|
||||
---
|
||||
|
||||
## 1. The up.link Module
|
||||
|
||||
### Purpose
|
||||
Handles Unpoly-enhanced navigation. Converts normal links into AJAX-based fragment updates rather than full-page reloads.
|
||||
|
||||
### Core Concepts
|
||||
When a user clicks a link with certain attributes, Unpoly intercepts the event and fetches the new page in the background. It then replaces specified fragments in the current document with matching elements from the response.
|
||||
|
||||
### Common Attributes
|
||||
|
||||
| Attribute | Description |
|
||||
| --------------- | -------------------------------------------------------- |
|
||||
| `up-follow` | Marks the link as handled by Unpoly. Usually implied. |
|
||||
| `up-target` | CSS selector identifying which fragment(s) to replace. |
|
||||
| `up-method` | Overrides HTTP method (e.g. `GET`, `POST`). |
|
||||
| `up-params` | Adds query parameters to the request. |
|
||||
| `up-headers` | Adds or overrides HTTP headers. |
|
||||
| `up-layer` | Determines which layer (page, overlay, modal) to update. |
|
||||
| `up-transition` | Defines animation during fragment replacement. |
|
||||
| `up-cache` | Enables caching of the response. |
|
||||
| `up-history` | Controls browser history behavior. |
|
||||
|
||||
### JavaScript API Methods
|
||||
- `up.link.isFollowable(element)` – Returns true if Unpoly will intercept the link.
|
||||
- `up.link.follow(element, options)` – Programmatically follow the link via Unpoly.
|
||||
- `up.link.preload(element, options)` – Preload the linked resource into the cache.
|
||||
|
||||
### Agent Reasoning & Validation
|
||||
- Ensure that every `up-follow` element has a valid `up-target` selector.
|
||||
- Validate that target elements exist in both the current DOM and the server response.
|
||||
- Recommend `up-cache` for commonly visited links to improve performance.
|
||||
- Prevent using `target="_blank"` or `download` attributes with Unpoly links.
|
||||
|
||||
### Example
|
||||
```html
|
||||
<a href="/profile" up-target="#main" up-transition="fade">View Profile</a>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. The up.form Module
|
||||
|
||||
### Purpose
|
||||
Handles progressive enhancement for forms. Submissions happen via AJAX and update only specific fragments.
|
||||
|
||||
### Core Attributes
|
||||
|
||||
| Attribute | Description |
|
||||
| ---------------- | --------------------------------------- |
|
||||
| `up-submit` | Marks form to be submitted via Unpoly. |
|
||||
| `up-target` | Fragment selector to update on success. |
|
||||
| `up-fail-target` | Selector to update if submission fails. |
|
||||
| `up-validate` | Enables live field validation. |
|
||||
| `up-autosubmit` | Submits automatically on change. |
|
||||
| `up-disable-for` | Disables fields during request. |
|
||||
| `up-enable-for` | Enables fields after request completes. |
|
||||
|
||||
### JavaScript API
|
||||
- `up.form.submit(form, options)` – Submit programmatically.
|
||||
- `up.validate(field, options)` – Trigger server validation.
|
||||
- `up.form.fields(form)` – Returns all input fields.
|
||||
|
||||
### Agent Reasoning
|
||||
- Always ensure form has both `action` and `method` attributes.
|
||||
- Match `up-target` to an element existing in the rendered HTML.
|
||||
- For validation, ensure server supports `X-Up-Validate` header.
|
||||
- When generating forms, add `up-fail-target` to handle errors gracefully.
|
||||
|
||||
### Example
|
||||
```html
|
||||
<form action="/update" method="POST" up-submit up-target="#user-info" up-fail-target="#form-errors">
|
||||
<input name="email" up-validate required>
|
||||
<button type="submit">Save</button>
|
||||
</form>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. The up.layer Module
|
||||
|
||||
### Purpose
|
||||
Manages overlays, modals, and stacked layers of navigation.
|
||||
|
||||
### Attributes
|
||||
|
||||
| Attribute | Description |
|
||||
| ---------------- | -------------------------------------------------- |
|
||||
| `up-layer="new"` | Opens content in a new overlay. |
|
||||
| `up-size` | Controls modal size (e.g., `small`, `large`). |
|
||||
| `up-dismissable` | Allows overlay to close by clicking outside. |
|
||||
| `up-history` | Determines if the overlay updates browser history. |
|
||||
| `up-title` | Sets overlay title. |
|
||||
|
||||
### JavaScript API
|
||||
- `up.layer.open(options)` – Opens a new layer.
|
||||
- `up.layer.close(layer)` – Closes a given layer.
|
||||
- `up.layer.on(event, callback)` – Hooks into lifecycle events.
|
||||
|
||||
### Agent Notes
|
||||
- Ensure `up-layer="new"` only used with valid targets.
|
||||
- For overlays, set `up-history="false"` unless explicitly required.
|
||||
- Auto-generate dismiss buttons with `up-layer-close`.
|
||||
|
||||
### Example
|
||||
```html
|
||||
<a href="/settings" up-layer="new" up-size="large" up-target=".modal-content">Open Settings</a>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. The up.fragment Module
|
||||
|
||||
### Purpose
|
||||
Handles low-level fragment rendering, preserving, replacing, and merging.
|
||||
|
||||
### JavaScript API
|
||||
- `up.render(options)` – Replace fragment(s) with new content.
|
||||
- `up.fragment.config` – Configure defaults for rendering.
|
||||
- `up.fragment.get(target)` – Retrieve a fragment.
|
||||
|
||||
### Example
|
||||
```js
|
||||
up.render({ target: '#main', url: '/dashboard', transition: 'fade' })
|
||||
```
|
||||
|
||||
### Agent Notes
|
||||
- Ensure only fragment HTML is sent from server (not full document).
|
||||
- Use `preserve` for elements like forms where input state matters.
|
||||
|
||||
---
|
||||
|
||||
## 5. The up.network Module
|
||||
|
||||
### Purpose
|
||||
Handles network requests, caching, and aborting background loads.
|
||||
|
||||
### JavaScript API
|
||||
- `up.network.loadPage(url, options)` – Load a page via Unpoly.
|
||||
- `up.network.abort()` – Abort ongoing requests.
|
||||
- `up.network.config.timeout` – Default timeout setting.
|
||||
|
||||
### Agent Tasks
|
||||
- Preload probable links (`up.link.preload`).
|
||||
- Use caching for frequent calls.
|
||||
- Handle `up:network:late` event to show spinners.
|
||||
|
||||
---
|
||||
|
||||
## 6. The up.event Module
|
||||
|
||||
### Purpose
|
||||
Manages custom events fired throughout Unpoly’s lifecycle.
|
||||
|
||||
### Common Events
|
||||
- `up:link:follow`
|
||||
- `up:form:submit`
|
||||
- `up:layer:open`
|
||||
- `up:layer:close`
|
||||
- `up:rendered`
|
||||
- `up:network:late`
|
||||
|
||||
### Example
|
||||
```js
|
||||
up.on('up:layer:close', (event) => {
|
||||
console.log('Overlay closed');
|
||||
});
|
||||
```
|
||||
|
||||
### Agent Actions
|
||||
- Register listeners for key events.
|
||||
- Prevent duplicate bindings.
|
||||
- Offer analytics hooks for `up:rendered` or `up:location:changed`.
|
||||
|
||||
---
|
||||
|
||||
## 7. The up.motion Module
|
||||
|
||||
Handles animations and transitions.
|
||||
|
||||
### API
|
||||
- `up.motion()` – Animate elements.
|
||||
- `up.animate(element, keyframes, options)` – Custom animation.
|
||||
|
||||
### Agent Notes
|
||||
- Suggest `up-transition="fade"` or similar for fragment changes.
|
||||
- Avoid heavy animations for performance-sensitive devices.
|
||||
|
||||
---
|
||||
|
||||
## 8. The up.radio Module
|
||||
|
||||
Handles broadcasting and receiving cross-fragment events.
|
||||
|
||||
### Example
|
||||
```js
|
||||
up.radio.emit('user:updated', { id: 5 })
|
||||
up.radio.on('user:updated', (data) => console.log(data))
|
||||
```
|
||||
|
||||
### Agent Tasks
|
||||
- Use for coordinating multiple fragments.
|
||||
- Ensure channel names are namespaced (e.g., `form:valid`, `modal:open`).
|
||||
|
||||
---
|
||||
|
||||
## 9. The up.history Module
|
||||
|
||||
### Purpose
|
||||
Manages URL history, titles, and restoration.
|
||||
|
||||
### API
|
||||
- `up.history.push(url, options)` – Push new history entry.
|
||||
- `up.history.restore()` – Restore previous state.
|
||||
|
||||
### Agent Guidance
|
||||
- Disable history (`up-history="false"`) for temporary overlays.
|
||||
- Ensure proper title update via `up-title`.
|
||||
|
||||
---
|
||||
|
||||
## 10. The up.viewport Module
|
||||
|
||||
### Purpose
|
||||
Manages scrolling, focusing, and viewport restoration.
|
||||
|
||||
### API
|
||||
- `up.viewport.scroll(element)` – Scroll to element.
|
||||
- `up.viewport.restoreScroll()` – Restore previous position.
|
||||
|
||||
### Agent Tasks
|
||||
- Restore scroll after fragment updates.
|
||||
- Manage focus for accessibility after `up.render()`.
|
||||
|
||||
---
|
||||
|
||||
## 11. The up.protocol Module
|
||||
|
||||
Handles request headers and special HTTP status codes.
|
||||
|
||||
### Key Concepts
|
||||
- Adds `X-Up-Target` and `X-Up-Validate` headers.
|
||||
- Interprets redirect and validation responses.
|
||||
|
||||
### Agent Notes
|
||||
- Ensure backend supports Unpoly headers.
|
||||
- Warn if 204 or redirect status used without fragments.
|
||||
|
||||
---
|
||||
|
||||
## 12. The up.util Module
|
||||
|
||||
Contains helpers for arrays, strings, and timing.
|
||||
|
||||
### Examples
|
||||
```js
|
||||
up.util.escapeHTML("<script>") // "<script>"
|
||||
up.util.copy(text)
|
||||
```
|
||||
|
||||
### Agent Tasks
|
||||
- Use helpers for DOM-safe generation.
|
||||
- Avoid reimplementing basic utilities.
|
||||
|
||||
---
|
||||
|
||||
## 13. The up.framework and up.log Modules
|
||||
|
||||
- `up.framework.init()` – Initializes Unpoly.
|
||||
- `up.log.enable()` – Enables debug logging.
|
||||
|
||||
### Agent Tasks
|
||||
- Always call `up.framework.init()` once.
|
||||
- Enable logging during debug sessions.
|
||||
|
||||
---
|
||||
|
||||
Good addition — including **Unpoly from a CDN** is essential for setup and automation.
|
||||
Here’s the section you can append to the Markdown file (I can also regenerate the full file with it included if you prefer):
|
||||
|
||||
---
|
||||
|
||||
## 14. Including Unpoly from CDN
|
||||
|
||||
### Purpose
|
||||
|
||||
Before any Unpoly features or attributes (`up-*`) can work, the library must be loaded into the page.
|
||||
For AI agents generating HTML pages or templates, always include Unpoly’s **CSS** and **JavaScript** assets early in the `<head>` section.
|
||||
|
||||
### Basic Setup (Latest Stable Version)
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>My Unpoly Page</title>
|
||||
|
||||
<!-- Unpoly Core Styles -->
|
||||
<link rel="stylesheet" href="https://unpkg.com/unpoly@3.7.2/unpoly.min.css">
|
||||
|
||||
<!-- Optional Bootstrap integration -->
|
||||
<link rel="stylesheet" href="https://unpkg.com/unpoly@3.7.2/unpoly-bootstrap3.min.css">
|
||||
|
||||
<!-- Unpoly Core Script -->
|
||||
<script src="https://unpkg.com/unpoly@3.7.2/unpoly.min.js"></script>
|
||||
|
||||
<!-- Initialize framework -->
|
||||
<script>
|
||||
up.framework.init()
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<!-- Page content -->
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
### AI Agent Notes
|
||||
|
||||
* Always include **`unpoly.min.css`** before any custom styles to ensure default animations and transitions function properly.
|
||||
* **Never** load Unpoly twice; check if the page already has a `<script src="...unpoly.min.js">`.
|
||||
* After loading, the agent may immediately use Unpoly JavaScript APIs (`up.render`, `up.link.follow`, etc.) or rely on HTML attributes.
|
||||
* If dynamically injecting HTML pages, the agent should re-run `up.framework.init()` **only once globally**, not after every fragment load.
|
||||
|
||||
### Recommended CDN Sources
|
||||
|
||||
* `https://unpkg.com/unpoly@3.x/`
|
||||
* `https://cdn.jsdelivr.net/npm/unpoly@3.x/`
|
||||
|
||||
### Offline Use
|
||||
|
||||
For fully offline or embedded environments, the agent can download both `.js` and `.css` files and reference them locally:
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="/assets/unpoly.min.css">
|
||||
<script src="/assets/unpoly.min.js"></script>
|
||||
```
|
||||
---
|
||||
|
||||
## Agent Validation Checklist
|
||||
|
||||
1. Verify `up-*` attributes match existing fragments.
|
||||
2. Check backend returns valid fragment markup.
|
||||
3. Ensure forms use `up-submit` and `up-fail-target`.
|
||||
4. Overlay layers must have dismissable controls.
|
||||
5. Use caching wisely (`up-cache`, `up.link.preload`).
|
||||
6. Handle network and render events gracefully.
|
||||
7. Log events (`up.log`) for debugging.
|
||||
8. Confirm scroll/focus restoration after renders.
|
||||
9. Gracefully degrade if JavaScript disabled.
|
||||
10. Document reasoning and configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
647
aiprompts/unpolly/unpolly_core.md
Normal file
647
aiprompts/unpolly/unpolly_core.md
Normal file
@@ -0,0 +1,647 @@
|
||||
# Unpoly Quick Reference for AI Agents
|
||||
|
||||
## Installation
|
||||
|
||||
Include Unpoly from CDN in your HTML `<head>`:
|
||||
|
||||
```html
|
||||
<script src="https://unpoly.com/unpoly.min.js"></script>
|
||||
<link rel="stylesheet" href="https://unpoly.com/unpoly.min.css">
|
||||
```
|
||||
|
||||
## Core Concept
|
||||
|
||||
Unpoly updates page fragments without full page reloads. Users click links/submit forms → server responds with HTML → Unpoly extracts and swaps matching fragments.
|
||||
|
||||
---
|
||||
|
||||
## 1. Following Links (Fragment Updates)
|
||||
|
||||
### Basic Link Following
|
||||
|
||||
```html
|
||||
<a href="/users/5" up-follow>View User</a>
|
||||
```
|
||||
|
||||
Updates the `<main>` element (or `<body>` if no main exists) with content from `/users/5`.
|
||||
|
||||
### Target Specific Fragment
|
||||
|
||||
```html
|
||||
<a href="/users/5" up-target=".user-details">View User</a>
|
||||
|
||||
<div class="user-details">
|
||||
<!-- Content replaced here -->
|
||||
</div>
|
||||
```
|
||||
|
||||
### Multiple Fragments
|
||||
|
||||
```html
|
||||
<a href="/users/5" up-target=".profile, .activity">View User</a>
|
||||
```
|
||||
|
||||
Updates both `.profile` and `.activity` from single response.
|
||||
|
||||
### Append/Prepend Content
|
||||
|
||||
```html
|
||||
<!-- Append to list -->
|
||||
<a href="/items?page=2" up-target=".items:after">Load More</a>
|
||||
|
||||
<!-- Prepend to list -->
|
||||
<a href="/latest" up-target=".items:before">Show Latest</a>
|
||||
```
|
||||
|
||||
### Handle All Links Automatically
|
||||
|
||||
```js
|
||||
up.link.config.followSelectors.push('a[href]')
|
||||
```
|
||||
|
||||
Now all links update fragments by default.
|
||||
|
||||
---
|
||||
|
||||
## 2. Submitting Forms
|
||||
|
||||
### Basic Form Submission
|
||||
|
||||
```html
|
||||
<form action="/users" method="post" up-submit>
|
||||
<input name="email">
|
||||
<button type="submit">Create</button>
|
||||
</form>
|
||||
```
|
||||
|
||||
Submits via AJAX and updates `<main>` with response.
|
||||
|
||||
### Target Specific Fragment
|
||||
|
||||
```html
|
||||
<form action="/search" up-submit up-target=".results">
|
||||
<input name="query">
|
||||
<button>Search</button>
|
||||
</form>
|
||||
|
||||
<div class="results">
|
||||
<!-- Search results appear here -->
|
||||
</div>
|
||||
```
|
||||
|
||||
### Handle Success vs. Error Responses
|
||||
|
||||
```html
|
||||
<form action="/users" method="post" up-submit
|
||||
up-target="#success"
|
||||
up-fail-target="form">
|
||||
<input name="email">
|
||||
<button>Create</button>
|
||||
</form>
|
||||
|
||||
<div id="success">Success message here</div>
|
||||
```
|
||||
|
||||
- **Success (2xx status)**: Updates `#success`
|
||||
- **Error (4xx/5xx status)**: Re-renders `form` with validation errors
|
||||
|
||||
**Server must return HTTP 422** (or similar error code) for validation failures.
|
||||
|
||||
---
|
||||
|
||||
## 3. Opening Overlays (Modal, Drawer, Popup)
|
||||
|
||||
### Modal Dialog
|
||||
|
||||
```html
|
||||
<a href="/details" up-layer="new">Open Modal</a>
|
||||
```
|
||||
|
||||
Opens `/details` in a modal overlay.
|
||||
|
||||
### Drawer (Sidebar)
|
||||
|
||||
```html
|
||||
<a href="/menu" up-layer="new drawer">Open Drawer</a>
|
||||
```
|
||||
|
||||
### Popup (Anchored to Link)
|
||||
|
||||
```html
|
||||
<a href="/help" up-layer="new popup">Help</a>
|
||||
```
|
||||
|
||||
### Close Overlay When Condition Met
|
||||
|
||||
```html
|
||||
<a href="/users/new"
|
||||
up-layer="new"
|
||||
up-accept-location="/users/$id"
|
||||
up-on-accepted="console.log('Created user:', value.id)">
|
||||
New User
|
||||
</a>
|
||||
```
|
||||
|
||||
Overlay auto-closes when URL matches `/users/123`, passes `{ id: 123 }` to callback.
|
||||
|
||||
### Local Content (No Server Request)
|
||||
|
||||
```html
|
||||
<a up-layer="new popup" up-content="<p>Help text here</p>">Help</a>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Validation
|
||||
|
||||
### Validate on Field Change
|
||||
|
||||
```html
|
||||
<form action="/users" method="post">
|
||||
<input name="email" up-validate>
|
||||
<input name="password" up-validate>
|
||||
<button type="submit">Register</button>
|
||||
</form>
|
||||
```
|
||||
|
||||
When field loses focus → submits form with `X-Up-Validate: email` header → server re-renders form → Unpoly updates the field's parent `<fieldset>` (or closest form group).
|
||||
|
||||
**Server must return HTTP 422** for validation errors.
|
||||
|
||||
### Validate While Typing
|
||||
|
||||
```html
|
||||
<input name="email" up-validate
|
||||
up-watch-event="input"
|
||||
up-watch-delay="300">
|
||||
```
|
||||
|
||||
Validates 300ms after user stops typing.
|
||||
|
||||
---
|
||||
|
||||
## 5. Lazy Loading & Polling
|
||||
|
||||
### Load When Element Appears in DOM
|
||||
|
||||
```html
|
||||
<div id="menu" up-defer up-href="/menu">
|
||||
Loading menu...
|
||||
</div>
|
||||
```
|
||||
|
||||
Immediately loads `/menu` when placeholder renders.
|
||||
|
||||
### Load When Scrolled Into View
|
||||
|
||||
```html
|
||||
<div id="comments" up-defer="reveal" up-href="/comments">
|
||||
Loading comments...
|
||||
</div>
|
||||
```
|
||||
|
||||
Loads when element scrolls into viewport.
|
||||
|
||||
### Auto-Refresh (Polling)
|
||||
|
||||
```html
|
||||
<div class="status" up-poll up-interval="5000">
|
||||
Current status
|
||||
</div>
|
||||
```
|
||||
|
||||
Reloads fragment every 5 seconds from original URL.
|
||||
|
||||
---
|
||||
|
||||
## 6. Caching & Revalidation
|
||||
|
||||
### Enable Caching
|
||||
|
||||
```html
|
||||
<a href="/users" up-cache="true">Users</a>
|
||||
```
|
||||
|
||||
Caches response, instantly shows cached content, then revalidates with server.
|
||||
|
||||
### Disable Caching
|
||||
|
||||
```html
|
||||
<a href="/stock" up-cache="false">Live Prices</a>
|
||||
```
|
||||
|
||||
### Conditional Requests (Server-Side)
|
||||
|
||||
Server sends:
|
||||
|
||||
```http
|
||||
HTTP/1.1 200 OK
|
||||
ETag: "abc123"
|
||||
|
||||
<div class="data">Content</div>
|
||||
```
|
||||
|
||||
Next reload, Unpoly sends:
|
||||
|
||||
```http
|
||||
GET /path
|
||||
If-None-Match: "abc123"
|
||||
```
|
||||
|
||||
Server responds `304 Not Modified` if unchanged → saves bandwidth.
|
||||
|
||||
---
|
||||
|
||||
## 7. Navigation Bar (Current Link Highlighting)
|
||||
|
||||
```html
|
||||
<nav>
|
||||
<a href="/home">Home</a>
|
||||
<a href="/about">About</a>
|
||||
</nav>
|
||||
```
|
||||
|
||||
Current page link gets `.up-current` class automatically.
|
||||
|
||||
**Style it:**
|
||||
|
||||
```css
|
||||
.up-current {
|
||||
font-weight: bold;
|
||||
color: blue;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 8. Loading State
|
||||
|
||||
### Feedback Classes
|
||||
|
||||
Automatically applied:
|
||||
|
||||
- `.up-active` on clicked link/button
|
||||
- `.up-loading` on targeted fragment
|
||||
|
||||
**Style them:**
|
||||
|
||||
```css
|
||||
.up-active { opacity: 0.6; }
|
||||
.up-loading { opacity: 0.8; }
|
||||
```
|
||||
|
||||
### Disable Form While Submitting
|
||||
|
||||
```html
|
||||
<form up-submit up-disable>
|
||||
<input name="email">
|
||||
<button>Submit</button>
|
||||
</form>
|
||||
```
|
||||
|
||||
All fields disabled during submission.
|
||||
|
||||
### Show Placeholder While Loading
|
||||
|
||||
```html
|
||||
<a href="/data" up-target=".data"
|
||||
up-placeholder="<p>Loading...</p>">
|
||||
Load Data
|
||||
</a>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 9. Preloading
|
||||
|
||||
### Preload on Hover
|
||||
|
||||
```html
|
||||
<a href="/users/5" up-preload>User Profile</a>
|
||||
```
|
||||
|
||||
Starts loading when user hovers (90ms delay by default).
|
||||
|
||||
### Preload Immediately
|
||||
|
||||
```html
|
||||
<a href="/menu" up-preload="insert">Menu</a>
|
||||
```
|
||||
|
||||
Loads as soon as link appears in DOM.
|
||||
|
||||
---
|
||||
|
||||
## 10. Templates (Client-Side HTML)
|
||||
|
||||
### Define Template
|
||||
|
||||
```html
|
||||
<template id="user-card">
|
||||
<div class="card">
|
||||
<h3>{{name}}</h3>
|
||||
<p>{{email}}</p>
|
||||
</div>
|
||||
</template>
|
||||
```
|
||||
|
||||
### Use Template
|
||||
|
||||
```html
|
||||
<a up-fragment="#user-card"
|
||||
up-use-data="{ name: 'Alice', email: 'alice@example.com' }">
|
||||
Show User
|
||||
</a>
|
||||
```
|
||||
|
||||
**Process variables with compiler:**
|
||||
|
||||
```js
|
||||
up.compiler('.card', function(element, data) {
|
||||
element.innerHTML = element.innerHTML
|
||||
.replace(/{{name}}/g, data.name)
|
||||
.replace(/{{email}}/g, data.email)
|
||||
})
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 11. JavaScript API
|
||||
|
||||
### Render Fragment
|
||||
|
||||
```js
|
||||
up.render({
|
||||
url: '/users/5',
|
||||
target: '.user-details'
|
||||
})
|
||||
```
|
||||
|
||||
### Navigate (Updates History)
|
||||
|
||||
```js
|
||||
up.navigate({
|
||||
url: '/users',
|
||||
target: 'main'
|
||||
})
|
||||
```
|
||||
|
||||
### Submit Form
|
||||
|
||||
```js
|
||||
let form = document.querySelector('form')
|
||||
up.submit(form)
|
||||
```
|
||||
|
||||
### Open Overlay
|
||||
|
||||
```js
|
||||
up.layer.open({
|
||||
url: '/users/new',
|
||||
onAccepted: (event) => {
|
||||
console.log('User created:', event.value)
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### Close Overlay with Value
|
||||
|
||||
```js
|
||||
up.layer.accept({ id: 123, name: 'Alice' })
|
||||
```
|
||||
|
||||
### Reload Fragment
|
||||
|
||||
```js
|
||||
up.reload('.status')
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 12. Request Headers (Server Protocol)
|
||||
|
||||
Unpoly sends these headers with requests:
|
||||
|
||||
| Header | Value | Purpose |
|
||||
| --------------- | -------- | ------------------------------- |
|
||||
| `X-Up-Version` | `1.0.0` | Identifies Unpoly request |
|
||||
| `X-Up-Target` | `.users` | Fragment selector being updated |
|
||||
| `X-Up-Mode` | `modal` | Current layer mode |
|
||||
| `X-Up-Validate` | `email` | Field being validated |
|
||||
|
||||
**Server can respond with:**
|
||||
|
||||
| Header | Effect |
|
||||
| ------------------------ | ------------------------ |
|
||||
| `X-Up-Target: .other` | Changes target selector |
|
||||
| `X-Up-Accept-Layer: {}` | Closes overlay (success) |
|
||||
| `X-Up-Dismiss-Layer: {}` | Closes overlay (cancel) |
|
||||
|
||||
---
|
||||
|
||||
## 13. Common Patterns
|
||||
|
||||
### Infinite Scrolling
|
||||
|
||||
```html
|
||||
<div id="items">
|
||||
<div>Item 1</div>
|
||||
<div>Item 2</div>
|
||||
</div>
|
||||
|
||||
<a id="next" href="/items?page=2"
|
||||
up-defer="reveal"
|
||||
up-target="#items:after, #next">
|
||||
Load More
|
||||
</a>
|
||||
```
|
||||
|
||||
### Dependent Form Fields
|
||||
|
||||
```html
|
||||
<form action="/order">
|
||||
<!-- Changing country updates city select -->
|
||||
<select name="country" up-validate="#city">
|
||||
<option>USA</option>
|
||||
<option>Canada</option>
|
||||
</select>
|
||||
|
||||
<select name="city" id="city">
|
||||
<option>New York</option>
|
||||
</select>
|
||||
</form>
|
||||
```
|
||||
|
||||
### Confirm Before Action
|
||||
|
||||
```html
|
||||
<a href="/delete" up-method="delete"
|
||||
up-confirm="Really delete?">
|
||||
Delete
|
||||
</a>
|
||||
```
|
||||
|
||||
### Auto-Submit on Change
|
||||
|
||||
```html
|
||||
<form action="/search" up-autosubmit>
|
||||
<input name="query">
|
||||
</form>
|
||||
```
|
||||
|
||||
Submits form when any field changes.
|
||||
|
||||
---
|
||||
|
||||
## 14. Error Handling
|
||||
|
||||
### Handle Network Errors
|
||||
|
||||
```js
|
||||
up.on('up:fragment:offline', function(event) {
|
||||
if (confirm('You are offline. Retry?')) {
|
||||
event.retry()
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### Handle Failed Responses
|
||||
|
||||
```js
|
||||
try {
|
||||
await up.render({ url: '/path', target: '.data' })
|
||||
} catch (error) {
|
||||
if (error instanceof up.RenderResult) {
|
||||
console.log('Server error:', error)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 15. Compilers (Enhance Elements)
|
||||
|
||||
### Basic Compiler
|
||||
|
||||
```js
|
||||
up.compiler('.current-time', function(element) {
|
||||
element.textContent = new Date().toString()
|
||||
})
|
||||
```
|
||||
|
||||
Runs when `.current-time` is inserted (initial load OR fragment update).
|
||||
|
||||
### Compiler with Cleanup
|
||||
|
||||
```js
|
||||
up.compiler('.auto-refresh', function(element) {
|
||||
let timer = setInterval(() => {
|
||||
element.textContent = new Date().toString()
|
||||
}, 1000)
|
||||
|
||||
// Return destructor function
|
||||
return () => clearInterval(timer)
|
||||
})
|
||||
```
|
||||
|
||||
Destructor called when element is removed from DOM.
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference Table
|
||||
|
||||
| Task | HTML | JavaScript |
|
||||
| --------------- | ---------------------------- | -------------------------- |
|
||||
| Follow link | `<a href="/path" up-follow>` | `up.follow(link)` |
|
||||
| Submit form | `<form up-submit>` | `up.submit(form)` |
|
||||
| Target fragment | `up-target=".foo"` | `{ target: '.foo' }` |
|
||||
| Open modal | `up-layer="new"` | `up.layer.open({ url })` |
|
||||
| Validate field | `up-validate` | `up.validate(field)` |
|
||||
| Lazy load | `up-defer` | — |
|
||||
| Poll fragment | `up-poll` | — |
|
||||
| Preload link | `up-preload` | `up.link.preload(link)` |
|
||||
| Local content | `up-content="<p>Hi</p>"` | `{ content: '<p>Hi</p>' }` |
|
||||
| Append content | `up-target=".list:after"` | — |
|
||||
| Confirm action | `up-confirm="Sure?"` | `{ confirm: 'Sure?' }` |
|
||||
|
||||
---
|
||||
|
||||
## Key Defaults
|
||||
|
||||
- **Target**: Updates `<main>` (or `<body>`) if no `up-target` specified
|
||||
- **Caching**: Auto-enabled for GET requests during navigation
|
||||
- **History**: Auto-updated when rendering `<main>` or major fragments
|
||||
- **Scrolling**: Auto-scrolls to top when updating `<main>`
|
||||
- **Focus**: Auto-focuses new fragment
|
||||
- **Validation**: Targets field's parent `<fieldset>` or form group
|
||||
|
||||
---
|
||||
|
||||
## Best Practices for AI Agents
|
||||
|
||||
1. **Always provide HTTP error codes**: Return 422 for validation errors, 404 for not found, etc.
|
||||
2. **Send full HTML responses**: Include entire page structure; Unpoly extracts needed fragments
|
||||
3. **Use semantic HTML**: `<main>`, `<nav>`, `<form>` elements work best
|
||||
4. **Set IDs on fragments**: Makes targeting easier (e.g., `<div id="user-123">`)
|
||||
5. **Return consistent selectors**: If request targets `.users`, response must contain `.users`
|
||||
|
||||
---
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
❌ **Don't**: Return only partial HTML without wrapper
|
||||
```html
|
||||
<h1>Title</h1>
|
||||
<p>Content</p>
|
||||
```
|
||||
|
||||
✅ **Do**: Wrap in target selector
|
||||
```html
|
||||
<div class="content">
|
||||
<h1>Title</h1>
|
||||
<p>Content</p>
|
||||
</div>
|
||||
```
|
||||
|
||||
❌ **Don't**: Return 200 OK for validation errors
|
||||
✅ **Do**: Return 422 Unprocessable Entity
|
||||
|
||||
❌ **Don't**: Use `onclick="up.follow(this)"`
|
||||
✅ **Do**: Use `up-follow` attribute (handles keyboard, accessibility)
|
||||
|
||||
---
|
||||
|
||||
## Server Response Examples
|
||||
|
||||
### Successful Form Submission
|
||||
|
||||
```http
|
||||
HTTP/1.1 200 OK
|
||||
|
||||
<div id="success">
|
||||
User created successfully!
|
||||
</div>
|
||||
```
|
||||
|
||||
### Validation Error
|
||||
|
||||
```http
|
||||
HTTP/1.1 422 Unprocessable Entity
|
||||
|
||||
<form action="/users" method="post" up-submit>
|
||||
<input name="email" value="invalid">
|
||||
<div class="error">Email is invalid</div>
|
||||
<button>Submit</button>
|
||||
</form>
|
||||
```
|
||||
|
||||
### Partial Response (Optimized)
|
||||
|
||||
```http
|
||||
HTTP/1.1 200 OK
|
||||
Vary: X-Up-Target
|
||||
|
||||
<div class="user-details">
|
||||
<!-- Only the targeted fragment -->
|
||||
</div>
|
||||
```
|
||||
@@ -1,51 +1,10 @@
|
||||
# module orm
|
||||
|
||||
|
||||
## Contents
|
||||
- [Constants](#Constants)
|
||||
- [new_query](#new_query)
|
||||
- [orm_select_gen](#orm_select_gen)
|
||||
- [orm_stmt_gen](#orm_stmt_gen)
|
||||
- [orm_table_gen](#orm_table_gen)
|
||||
- [Connection](#Connection)
|
||||
- [Primitive](#Primitive)
|
||||
- [QueryBuilder[T]](#QueryBuilder[T])
|
||||
- [reset](#reset)
|
||||
- [where](#where)
|
||||
- [or_where](#or_where)
|
||||
- [order](#order)
|
||||
- [limit](#limit)
|
||||
- [offset](#offset)
|
||||
- [select](#select)
|
||||
- [set](#set)
|
||||
- [query](#query)
|
||||
- [count](#count)
|
||||
- [insert](#insert)
|
||||
- [insert_many](#insert_many)
|
||||
- [update](#update)
|
||||
- [delete](#delete)
|
||||
- [create](#create)
|
||||
- [drop](#drop)
|
||||
- [last_id](#last_id)
|
||||
- [MathOperationKind](#MathOperationKind)
|
||||
- [OperationKind](#OperationKind)
|
||||
- [OrderType](#OrderType)
|
||||
- [SQLDialect](#SQLDialect)
|
||||
- [StmtKind](#StmtKind)
|
||||
- [InfixType](#InfixType)
|
||||
- [Null](#Null)
|
||||
- [QueryBuilder](#QueryBuilder)
|
||||
- [QueryData](#QueryData)
|
||||
- [SelectConfig](#SelectConfig)
|
||||
- [Table](#Table)
|
||||
- [TableField](#TableField)
|
||||
|
||||
## Constants
|
||||
```v
|
||||
const num64 = [typeof[i64]().idx, typeof[u64]().idx]
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
```v
|
||||
const nums = [
|
||||
@@ -59,7 +18,7 @@ const nums = [
|
||||
]
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
```v
|
||||
const float = [
|
||||
@@ -68,31 +27,31 @@ const float = [
|
||||
]
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
```v
|
||||
const type_string = typeof[string]().idx
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
```v
|
||||
const serial = -1
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
```v
|
||||
const time_ = -2
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
```v
|
||||
const enum_ = -3
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
```v
|
||||
const type_idx = {
|
||||
@@ -111,19 +70,19 @@ const type_idx = {
|
||||
}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
```v
|
||||
const string_max_len = 2048
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
```v
|
||||
const null_primitive = Primitive(Null{})
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## new_query
|
||||
```v
|
||||
@@ -132,7 +91,7 @@ fn new_query[T](conn Connection) &QueryBuilder[T]
|
||||
|
||||
new_query create a new query object for struct `T`
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## orm_select_gen
|
||||
```v
|
||||
@@ -141,7 +100,7 @@ fn orm_select_gen(cfg SelectConfig, q string, num bool, qm string, start_pos int
|
||||
|
||||
Generates an sql select stmt, from universal parameter orm - See SelectConfig q, num, qm, start_pos - see orm_stmt_gen where - See QueryData
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## orm_stmt_gen
|
||||
```v
|
||||
@@ -151,7 +110,7 @@ fn orm_stmt_gen(sql_dialect SQLDialect, table Table, q string, kind StmtKind, nu
|
||||
|
||||
Generates an sql stmt, from universal parameter q - The quotes character, which can be different in every type, so it's variable num - Stmt uses nums at prepared statements (? or ?1) qm - Character for prepared statement (qm for question mark, as in sqlite) start_pos - When num is true, it's the start position of the counter
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## orm_table_gen
|
||||
```v
|
||||
@@ -161,7 +120,7 @@ fn orm_table_gen(sql_dialect SQLDialect, table Table, q string, defaults bool, d
|
||||
|
||||
Generates an sql table stmt, from universal parameter table - Table struct q - see orm_stmt_gen defaults - enables default values in stmt def_unique_len - sets default unique length for texts fields - See TableField sql_from_v - Function which maps type indices to sql type names alternative - Needed for msdb
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## Connection
|
||||
```v
|
||||
@@ -181,7 +140,7 @@ Interfaces gets called from the backend and can be implemented Since the orm sup
|
||||
|
||||
Every function without last_id() returns an optional, which returns an error if present last_id returns the last inserted id of the db
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## Primitive
|
||||
```v
|
||||
@@ -203,7 +162,7 @@ type Primitive = InfixType
|
||||
| []Primitive
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## QueryBuilder[T]
|
||||
## reset
|
||||
@@ -213,7 +172,7 @@ fn (qb_ &QueryBuilder[T]) reset() &QueryBuilder[T]
|
||||
|
||||
reset reset a query object, but keep the connection and table name
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## where
|
||||
```v
|
||||
@@ -222,7 +181,7 @@ fn (qb_ &QueryBuilder[T]) where(condition string, params ...Primitive) !&QueryBu
|
||||
|
||||
where create a `where` clause, it will `AND` with previous `where` clause. valid token in the `condition` include: `field's names`, `operator`, `(`, `)`, `?`, `AND`, `OR`, `||`, `&&`, valid `operator` incldue: `=`, `!=`, `<>`, `>=`, `<=`, `>`, `<`, `LIKE`, `ILIKE`, `IS NULL`, `IS NOT NULL`, `IN`, `NOT IN` example: `where('(a > ? AND b <= ?) OR (c <> ? AND (x = ? OR y = ?))', a, b, c, x, y)`
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## or_where
|
||||
```v
|
||||
@@ -231,7 +190,7 @@ fn (qb_ &QueryBuilder[T]) or_where(condition string, params ...Primitive) !&Quer
|
||||
|
||||
or_where create a `where` clause, it will `OR` with previous `where` clause.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## order
|
||||
```v
|
||||
@@ -240,7 +199,7 @@ fn (qb_ &QueryBuilder[T]) order(order_type OrderType, field string) !&QueryBuild
|
||||
|
||||
order create a `order` clause
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## limit
|
||||
```v
|
||||
@@ -249,7 +208,7 @@ fn (qb_ &QueryBuilder[T]) limit(limit int) !&QueryBuilder[T]
|
||||
|
||||
limit create a `limit` clause
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## offset
|
||||
```v
|
||||
@@ -258,7 +217,7 @@ fn (qb_ &QueryBuilder[T]) offset(offset int) !&QueryBuilder[T]
|
||||
|
||||
offset create a `offset` clause
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## select
|
||||
```v
|
||||
@@ -267,7 +226,7 @@ fn (qb_ &QueryBuilder[T]) select(fields ...string) !&QueryBuilder[T]
|
||||
|
||||
select create a `select` clause
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## set
|
||||
```v
|
||||
@@ -276,7 +235,7 @@ fn (qb_ &QueryBuilder[T]) set(assign string, values ...Primitive) !&QueryBuilder
|
||||
|
||||
set create a `set` clause for `update`
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## query
|
||||
```v
|
||||
@@ -285,7 +244,7 @@ fn (qb_ &QueryBuilder[T]) query() ![]T
|
||||
|
||||
query start a query and return result in struct `T`
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## count
|
||||
```v
|
||||
@@ -294,7 +253,7 @@ fn (qb_ &QueryBuilder[T]) count() !int
|
||||
|
||||
count start a count query and return result
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## insert
|
||||
```v
|
||||
@@ -303,7 +262,7 @@ fn (qb_ &QueryBuilder[T]) insert[T](value T) !&QueryBuilder[T]
|
||||
|
||||
insert insert a record into the database
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## insert_many
|
||||
```v
|
||||
@@ -312,7 +271,7 @@ fn (qb_ &QueryBuilder[T]) insert_many[T](values []T) !&QueryBuilder[T]
|
||||
|
||||
insert_many insert records into the database
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## update
|
||||
```v
|
||||
@@ -321,7 +280,7 @@ fn (qb_ &QueryBuilder[T]) update() !&QueryBuilder[T]
|
||||
|
||||
update update record(s) in the database
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## delete
|
||||
```v
|
||||
@@ -330,7 +289,7 @@ fn (qb_ &QueryBuilder[T]) delete() !&QueryBuilder[T]
|
||||
|
||||
delete delete record(s) in the database
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## create
|
||||
```v
|
||||
@@ -339,7 +298,7 @@ fn (qb_ &QueryBuilder[T]) create() !&QueryBuilder[T]
|
||||
|
||||
create create a table
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## drop
|
||||
```v
|
||||
@@ -348,7 +307,7 @@ fn (qb_ &QueryBuilder[T]) drop() !&QueryBuilder[T]
|
||||
|
||||
drop drop a table
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## last_id
|
||||
```v
|
||||
@@ -357,7 +316,7 @@ fn (qb_ &QueryBuilder[T]) last_id() int
|
||||
|
||||
last_id returns the last inserted id of the db
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## MathOperationKind
|
||||
```v
|
||||
@@ -369,7 +328,7 @@ enum MathOperationKind {
|
||||
}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## OperationKind
|
||||
```v
|
||||
@@ -389,7 +348,7 @@ enum OperationKind {
|
||||
}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## OrderType
|
||||
```v
|
||||
@@ -399,7 +358,7 @@ enum OrderType {
|
||||
}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## SQLDialect
|
||||
```v
|
||||
@@ -411,7 +370,7 @@ enum SQLDialect {
|
||||
}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## StmtKind
|
||||
```v
|
||||
@@ -422,7 +381,7 @@ enum StmtKind {
|
||||
}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## InfixType
|
||||
```v
|
||||
@@ -434,14 +393,14 @@ pub:
|
||||
}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## Null
|
||||
```v
|
||||
struct Null {}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## QueryBuilder
|
||||
```v
|
||||
@@ -456,7 +415,7 @@ pub mut:
|
||||
}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## QueryData
|
||||
```v
|
||||
@@ -474,7 +433,7 @@ pub mut:
|
||||
|
||||
Examples for QueryData in SQL: abc == 3 && b == 'test' => fields[abc, b]; data[3, 'test']; types[index of int, index of string]; kinds[.eq, .eq]; is_and[true]; Every field, data, type & kind of operation in the expr share the same index in the arrays is_and defines how they're addicted to each other either and or or parentheses defines which fields will be inside () auto_fields are indexes of fields where db should generate a value when absent in an insert
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## SelectConfig
|
||||
```v
|
||||
@@ -496,7 +455,7 @@ pub mut:
|
||||
|
||||
table - Table struct is_count - Either the data will be returned or an integer with the count has_where - Select all or use a where expr has_order - Order the results order - Name of the column which will be ordered order_type - Type of order (asc, desc) has_limit - Limits the output data primary - Name of the primary field has_offset - Add an offset to the result fields - Fields to select types - Types to select
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## Table
|
||||
```v
|
||||
@@ -507,7 +466,7 @@ pub mut:
|
||||
}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
|
||||
## TableField
|
||||
```v
|
||||
@@ -521,7 +480,3 @@ pub mut:
|
||||
is_arr bool
|
||||
}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
#### Powered by vdoc. Generated on: 2 Sep 2025 07:19:37
|
||||
|
||||
282
aiprompts/v_core/orm/orm_cheat.md
Normal file
282
aiprompts/v_core/orm/orm_cheat.md
Normal file
@@ -0,0 +1,282 @@
|
||||
|
||||
# V ORM — Developer Cheat Sheet
|
||||
|
||||
*Fast reference for Struct Mapping, CRUD, Attributes, Query Builder, and Usage Patterns*
|
||||
|
||||
---
|
||||
|
||||
## 1. What V ORM Is
|
||||
|
||||
* Built-in ORM for **SQLite**, **MySQL**, **PostgreSQL**
|
||||
* Unified V-syntax; no SQL string building
|
||||
* Automatic query sanitization
|
||||
* Compile-time type & field checks
|
||||
* Structs map directly to tables
|
||||
|
||||
---
|
||||
|
||||
## 2. Define Models (Struct ↔ Table)
|
||||
|
||||
### Basic Example
|
||||
|
||||
```v
|
||||
struct User {
|
||||
id int @[primary; sql: serial]
|
||||
name string
|
||||
email string @[unique]
|
||||
}
|
||||
```
|
||||
|
||||
### Nullable Fields
|
||||
|
||||
```v
|
||||
age ?int // allows NULL
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Struct Attributes
|
||||
|
||||
### Table-level
|
||||
|
||||
| Attribute | Meaning |
|
||||
| ---------------------------- | ------------------------- |
|
||||
| `@[table: 'custom_name']` | Override table name |
|
||||
| `@[comment: '...']` | Table comment |
|
||||
| `@[index: 'field1, field2']` | Creates multi-field index |
|
||||
|
||||
---
|
||||
|
||||
## 4. Field Attributes
|
||||
|
||||
| Attribute | Description |
|
||||
| ------------------------------------------------ | ---------------------------- |
|
||||
| `@[primary]` | Primary key |
|
||||
| `@[unique]` | UNIQUE constraint |
|
||||
| `@[unique: 'group']` | Composite unique group |
|
||||
| `@[skip]` / `@[sql: '-']` | Ignore field |
|
||||
| `@[sql: serial]` | Auto-increment key |
|
||||
| `@[sql: 'col_name']` | Rename column |
|
||||
| `@[sql_type: 'BIGINT']` | Force SQL type |
|
||||
| `@[default: 'CURRENT_TIMESTAMP']` | Raw SQL default |
|
||||
| `@[fkey: 'field']` | Foreign key on a child array |
|
||||
| `@[references]`, `@[references: 'table(field)']` | FK relationship |
|
||||
| `@[index]` | Index on field |
|
||||
| `@[comment: '...']` | Column comment |
|
||||
|
||||
### Example
|
||||
|
||||
```v
|
||||
struct Post {
|
||||
id int @[primary; sql: serial]
|
||||
title string
|
||||
body string
|
||||
author_id int @[references: 'users(id)']
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. ORM SQL Block (Primary API)
|
||||
|
||||
### Create Table
|
||||
|
||||
```v
|
||||
sql db {
|
||||
create table User
|
||||
}!
|
||||
```
|
||||
|
||||
### Drop Table
|
||||
|
||||
```v
|
||||
sql db {
|
||||
drop table User
|
||||
}!
|
||||
```
|
||||
|
||||
### Insert
|
||||
|
||||
```v
|
||||
id := sql db {
|
||||
insert new_user into User
|
||||
}!
|
||||
```
|
||||
|
||||
### Select
|
||||
|
||||
```v
|
||||
users := sql db {
|
||||
select from User where age > 18 && name != 'Tom'
|
||||
order by id desc
|
||||
limit 10
|
||||
}!
|
||||
```
|
||||
|
||||
### Update
|
||||
|
||||
```v
|
||||
sql db {
|
||||
update User set name = 'Alice' where id == 1
|
||||
}!
|
||||
```
|
||||
|
||||
### Delete
|
||||
|
||||
```v
|
||||
sql db {
|
||||
delete from User where id > 100
|
||||
}!
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. Relationships
|
||||
|
||||
### One-to-Many
|
||||
|
||||
```v
|
||||
struct Parent {
|
||||
id int @[primary; sql: serial]
|
||||
children []Child @[fkey: 'parent_id']
|
||||
}
|
||||
|
||||
struct Child {
|
||||
id int @[primary; sql: serial]
|
||||
parent_id int
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 7. Notes on `time.Time`
|
||||
|
||||
* Stored as integer timestamps
|
||||
* SQL defaults like `NOW()` / `CURRENT_TIMESTAMP` **don’t work** for `time.Time` with V ORM defaults
|
||||
* Use `@[default: 'CURRENT_TIMESTAMP']` only with custom SQL types
|
||||
|
||||
---
|
||||
|
||||
## 8. Query Builder API (Dynamic Queries)
|
||||
|
||||
### Create Builder
|
||||
|
||||
```v
|
||||
mut qb := orm.new_query[User](db)
|
||||
```
|
||||
|
||||
### Create Table
|
||||
|
||||
```v
|
||||
qb.create()!
|
||||
```
|
||||
|
||||
### Insert Many
|
||||
|
||||
```v
|
||||
qb.insert_many(users)!
|
||||
```
|
||||
|
||||
### Select
|
||||
|
||||
```v
|
||||
results := qb
|
||||
.select('id, name')!
|
||||
.where('age > ?', 18)!
|
||||
.order('id DESC')!
|
||||
.limit(20)!
|
||||
.query()!
|
||||
```
|
||||
|
||||
### Update
|
||||
|
||||
```v
|
||||
qb
|
||||
.set('name = ?', 'NewName')!
|
||||
.where('id = ?', 1)!
|
||||
.update()!
|
||||
```
|
||||
|
||||
### Delete
|
||||
|
||||
```v
|
||||
qb.where('created_at IS NULL')!.delete()!
|
||||
```
|
||||
|
||||
### Complex WHERE
|
||||
|
||||
```v
|
||||
qb.where(
|
||||
'(salary > ? AND age < ?) OR (role LIKE ?)',
|
||||
3000, 40, '%engineer%'
|
||||
)!
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 9. Connecting to Databases
|
||||
|
||||
### SQLite
|
||||
|
||||
```v
|
||||
import db.sqlite
|
||||
db := sqlite.connect('db.sqlite')!
|
||||
```
|
||||
|
||||
### MySQL
|
||||
|
||||
```v
|
||||
import db.mysql
|
||||
db := mysql.connect(host: 'localhost', user: 'root', password: '', dbname: 'test')!
|
||||
```
|
||||
|
||||
### PostgreSQL
|
||||
|
||||
```v
|
||||
import db.pg
|
||||
db := pg.connect(conn_str)!
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 10. Full Example (Complete CRUD)
|
||||
|
||||
```v
|
||||
import db.sqlite
|
||||
|
||||
struct Customer {
|
||||
id int @[primary; sql: serial]
|
||||
name string
|
||||
email string @[unique]
|
||||
}
|
||||
|
||||
fn main() {
|
||||
db := sqlite.connect('customers.db')!
|
||||
|
||||
sql db { create table Customer }!
|
||||
|
||||
new_c := Customer{name: 'Alice', email: 'alice@x.com'}
|
||||
|
||||
id := sql db { insert new_c into Customer }!
|
||||
println(id)
|
||||
|
||||
list := sql db { select from Customer where name == 'Alice' }!
|
||||
println(list)
|
||||
|
||||
sql db { update Customer set name = 'Alicia' where id == id }!
|
||||
|
||||
sql db { delete from Customer where id == id }!
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 11. Best Practices
|
||||
|
||||
* Always use `sql db { ... }` for static queries
|
||||
* Use QueryBuilder for dynamic conditions
|
||||
* Prefer `sql: serial` for primary keys
|
||||
* Explicitly define foreign keys
|
||||
* Use `?T` for nullable fields
|
||||
* Keep struct names identical to table names unless overridden
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -10,6 +10,7 @@ fp.version('v0.1.0')
|
||||
fp.description('Compile hero binary in debug or production mode')
|
||||
fp.skip_executable()
|
||||
|
||||
|
||||
prod_mode := fp.bool('prod', `p`, false, 'Build production version (optimized)')
|
||||
help_requested := fp.bool('help', `h`, false, 'Show help message')
|
||||
|
||||
@@ -61,12 +62,14 @@ compile_cmd := if os.user_os() == 'macos' {
|
||||
'v -enable-globals -g -w -n -prod hero.v'
|
||||
} else {
|
||||
'v -n -g -w -cg -gc none -cc tcc -d use_openssl -enable-globals hero.v'
|
||||
// 'v -n -g -w -cg -gc none -cc tcc -d use_openssl -enable-globals hero.v'
|
||||
// 'v -cg -enable-globals -parallel-cc -w -n -d use_openssl hero.v'
|
||||
}
|
||||
} else {
|
||||
if prod_mode {
|
||||
'v -cg -enable-globals -parallel-cc -w -n hero.v'
|
||||
'v -cg -enable-globals -parallel-cc -w -n -d use_openssl hero.v'
|
||||
} else {
|
||||
'v -cg -enable-globals -w -n hero.v'
|
||||
'v -cg -enable-globals -w -n -d use_openssl hero.v'
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
32
cli/hero.v
32
cli/hero.v
@@ -2,14 +2,14 @@ module main
|
||||
|
||||
import os
|
||||
import cli { Command }
|
||||
import freeflowuniverse.herolib.core.herocmds
|
||||
import freeflowuniverse.herolib.installers.base
|
||||
import freeflowuniverse.herolib.ui.console
|
||||
import freeflowuniverse.herolib.ui
|
||||
import freeflowuniverse.herolib.osal.core as osal
|
||||
import freeflowuniverse.herolib.core
|
||||
import freeflowuniverse.herolib.core.playbook
|
||||
import freeflowuniverse.herolib.core.playcmds
|
||||
import incubaid.herolib.core.herocmds
|
||||
import incubaid.herolib.installers.base
|
||||
import incubaid.herolib.ui.console
|
||||
import incubaid.herolib.ui
|
||||
import incubaid.herolib.osal.core as osal
|
||||
import incubaid.herolib.core
|
||||
import incubaid.herolib.core.playbook
|
||||
import incubaid.herolib.core.playcmds
|
||||
|
||||
fn playcmds_do(path string) ! {
|
||||
mut plbook := playbook.new(path: path)!
|
||||
@@ -38,7 +38,12 @@ fn do() ! {
|
||||
|
||||
if os.args.len == 2 {
|
||||
mypath := os.args[1]
|
||||
if mypath.to_lower().ends_with('.hero') || mypath.to_lower().ends_with('.heroscript') || mypath.to_lower().ends_with('.hs') {
|
||||
if mypath == '.' {
|
||||
playcmds_do(os.getwd())!
|
||||
return
|
||||
}
|
||||
if mypath.to_lower().ends_with('.hero') || mypath.to_lower().ends_with('.heroscript')
|
||||
|| mypath.to_lower().ends_with('.hs') {
|
||||
// hero was called from a file
|
||||
playcmds_do(mypath)!
|
||||
return
|
||||
@@ -48,11 +53,9 @@ fn do() ! {
|
||||
mut cmd := Command{
|
||||
name: 'hero'
|
||||
description: 'Your HERO toolset.'
|
||||
version: '1.0.33'
|
||||
version: '1.0.38'
|
||||
}
|
||||
|
||||
// herocmds.cmd_run_add_flags(mut cmd)
|
||||
|
||||
mut toinstall := false
|
||||
if !osal.cmd_exists('mc') || !osal.cmd_exists('redis-cli') {
|
||||
toinstall = true
|
||||
@@ -87,6 +90,7 @@ fn do() ! {
|
||||
herocmds.cmd_docusaurus(mut cmd)
|
||||
herocmds.cmd_web(mut cmd)
|
||||
herocmds.cmd_sshagent(mut cmd)
|
||||
herocmds.cmd_atlas(mut cmd)
|
||||
|
||||
cmd.setup()
|
||||
cmd.parse(os.args)
|
||||
@@ -100,7 +104,3 @@ fn main() {
|
||||
exit(1)
|
||||
}
|
||||
}
|
||||
|
||||
// fn pre_func(cmd Command) ! {
|
||||
// herocmds.plbook_run(cmd)!
|
||||
// }
|
||||
@@ -1,6 +1,6 @@
|
||||
module main
|
||||
|
||||
import freeflowuniverse.herolib.mcp.v_do
|
||||
import incubaid.herolib.mcp.v_do
|
||||
|
||||
fn main() {
|
||||
// Create and start the MCP server
|
||||
|
||||
47
compare_dirs.sh
Executable file
47
compare_dirs.sh
Executable file
@@ -0,0 +1,47 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Usage: ./compare_dirs.sh <branch1> <branch2> <dir_path>
|
||||
# Example: ./compare_dirs.sh main feature-branch src
|
||||
|
||||
if [ "$#" -ne 3 ]; then
|
||||
echo "Usage: $0 <branch1> <branch2> <dir_path>"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
BRANCH1=$1
|
||||
BRANCH2=$2
|
||||
DIR_PATH=$3
|
||||
|
||||
TMP_DIR1=$(mktemp -d)
|
||||
TMP_DIR2=$(mktemp -d)
|
||||
|
||||
# Ensure we're in a Git repo
|
||||
if ! git rev-parse --is-inside-work-tree > /dev/null 2>&1; then
|
||||
echo "Error: Not inside a Git repository"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Fetch branch contents without switching branches
|
||||
git worktree add "$TMP_DIR1" "$BRANCH1" > /dev/null 2>&1
|
||||
git worktree add "$TMP_DIR2" "$BRANCH2" > /dev/null 2>&1
|
||||
|
||||
# Check if the directory exists in both branches
|
||||
if [ ! -d "$TMP_DIR1/$DIR_PATH" ]; then
|
||||
echo "Error: $DIR_PATH does not exist in $BRANCH1"
|
||||
exit 1
|
||||
fi
|
||||
if [ ! -d "$TMP_DIR2/$DIR_PATH" ]; then
|
||||
echo "Error: $DIR_PATH does not exist in $BRANCH2"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Compare directories
|
||||
echo "Comparing $DIR_PATH between $BRANCH1 and $BRANCH2..."
|
||||
diff -qr "$TMP_DIR1/$DIR_PATH" "$TMP_DIR2/$DIR_PATH"
|
||||
|
||||
# Detailed differences
|
||||
diff -u -r "$TMP_DIR1/$DIR_PATH" "$TMP_DIR2/$DIR_PATH"
|
||||
|
||||
# Clean up temporary worktrees
|
||||
git worktree remove "$TMP_DIR1" --force
|
||||
git worktree remove "$TMP_DIR2" --force
|
||||
15
doc.vsh
15
doc.vsh
@@ -6,15 +6,22 @@ abs_dir_of_script := dir(@FILE)
|
||||
|
||||
// Format code
|
||||
println('Formatting code...')
|
||||
if os.system('v fmt -w ${abs_dir_of_script}/examples') != 0 {
|
||||
eprintln('Warning: Failed to format examples')
|
||||
// v fmt returns:
|
||||
// - 0: all files already formatted (no changes)
|
||||
// - 5: files were formatted (changes made) - this is SUCCESS
|
||||
// - other: actual errors (syntax errors, file access issues, etc.)
|
||||
fmt_examples_result := os.system('v fmt -w ${abs_dir_of_script}/examples')
|
||||
if fmt_examples_result != 0 && fmt_examples_result != 5 {
|
||||
eprintln('Error: Failed to format examples (exit code: ${fmt_examples_result})')
|
||||
exit(1)
|
||||
}
|
||||
|
||||
if os.system('v fmt -w ${abs_dir_of_script}/lib') != 0 {
|
||||
eprintln('Warning: Failed to format herolib')
|
||||
fmt_lib_result := os.system('v fmt -w ${abs_dir_of_script}/lib')
|
||||
if fmt_lib_result != 0 && fmt_lib_result != 5 {
|
||||
eprintln('Error: Failed to format herolib (exit code: ${fmt_lib_result})')
|
||||
exit(1)
|
||||
}
|
||||
println('✓ Code formatting completed')
|
||||
|
||||
// Clean existing docs
|
||||
println('Cleaning existing documentation...')
|
||||
|
||||
@@ -40,4 +40,3 @@ RUN /tmp/install_herolib.vsh && \
|
||||
|
||||
ENTRYPOINT ["/bin/bash"]
|
||||
CMD ["/bin/bash"]
|
||||
|
||||
|
||||
@@ -5,8 +5,8 @@ SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||
cd "$SCRIPT_DIR"
|
||||
|
||||
# Copy installation files
|
||||
cp ../../install_v.sh ./scripts/install_v.sh
|
||||
cp ../../install_herolib.vsh ./scripts/install_herolib.vsh
|
||||
cp ../../scripts/install_v.sh ./scripts/install_v.sh
|
||||
cp ../../scripts/install_herolib.vsh ./scripts/install_herolib.vsh
|
||||
|
||||
# Docker image and container names
|
||||
DOCKER_IMAGE_NAME="herolib"
|
||||
|
||||
@@ -51,8 +51,8 @@ println('Resetting all symlinks...')
|
||||
os.rm('${os.home_dir()}/.vmodules/incubaid/herolib') or {}
|
||||
|
||||
// Create necessary directories
|
||||
os.mkdir_all('${os.home_dir()}/.vmodules/freeflowuniverse') or {
|
||||
panic('Failed to create directory ~/.vmodules/freeflowuniverse: ${err}')
|
||||
os.mkdir_all('${os.home_dir()}/.vmodules/incubaid') or {
|
||||
panic('Failed to create directory ~/.vmodules/incubaid: ${err}')
|
||||
}
|
||||
|
||||
// Create new symlinks
|
||||
|
||||
@@ -224,7 +224,7 @@ function hero_lib_get {
|
||||
hero_lib_pull
|
||||
else
|
||||
pushd $DIR_CODE/github/incubaid 2>&1 >> /dev/null
|
||||
git clone --depth 1 --no-single-branch https://github.com/freeflowuniverse/herolib.git
|
||||
git clone --depth 1 --no-single-branch https://github.com/incubaid/herolib.git
|
||||
popd 2>&1 >> /dev/null
|
||||
fi
|
||||
}
|
||||
|
||||
29
examples/ai/aiclient.vsh
Executable file
29
examples/ai/aiclient.vsh
Executable file
@@ -0,0 +1,29 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import incubaid.herolib.ai.client
|
||||
|
||||
mut cl := client.new()!
|
||||
|
||||
// response := cl.llms.llm_local.chat_completion(
|
||||
// message: 'Explain quantum computing in simple terms'
|
||||
// temperature: 0.5
|
||||
// max_completion_tokens: 1024
|
||||
// )!
|
||||
|
||||
response := cl.llms.llm_maverick.chat_completion(
|
||||
message: 'Explain quantum computing in simple terms'
|
||||
temperature: 0.5
|
||||
max_completion_tokens: 1024
|
||||
)!
|
||||
|
||||
println(response)
|
||||
|
||||
// response := cl.llms.llm_embed_local.embed(input: [
|
||||
// 'The food was delicious and the waiter..',
|
||||
// ])!
|
||||
|
||||
// response2 := cl.llms.llm_embed.embed(input: [
|
||||
// 'The food was delicious and the waiter..',
|
||||
// ])!
|
||||
|
||||
println(response2)
|
||||
17
examples/ai/aiclient_embed.vsh
Executable file
17
examples/ai/aiclient_embed.vsh
Executable file
@@ -0,0 +1,17 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import incubaid.herolib.ai.client
|
||||
|
||||
mut cl := client.new()!
|
||||
|
||||
// response := cl.llms.llm_local.chat_completion(
|
||||
// message: 'Explain quantum computing in simple terms'
|
||||
// temperature: 0.5
|
||||
// max_completion_tokens: 1024
|
||||
// )!
|
||||
|
||||
response := cl.llms.llm_embed.chat_completion(
|
||||
message: 'Explain quantum computing in simple terms'
|
||||
)!
|
||||
|
||||
println(response)
|
||||
8
examples/ai/flow_test1.vsh
Executable file
8
examples/ai/flow_test1.vsh
Executable file
@@ -0,0 +1,8 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import incubaid.herolib.ai.client
|
||||
import incubaid.herolib.ai.flow_calendar
|
||||
|
||||
prompt = 'Explain quantum computing in simple terms'
|
||||
|
||||
flow_calendar.start(mut coordinator, prompt)!
|
||||
26
examples/ai/groq.vsh
Executable file
26
examples/ai/groq.vsh
Executable file
@@ -0,0 +1,26 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import incubaid.herolib.clients.openai
|
||||
import os
|
||||
import incubaid.herolib.core.playcmds
|
||||
|
||||
// models see https://console.groq.com/docs/models
|
||||
|
||||
playcmds.run(
|
||||
heroscript: '
|
||||
!!openai.configure name:"groq"
|
||||
url:"https://api.groq.com/openai/v1"
|
||||
model_default:"openai/gpt-oss-120b"
|
||||
'
|
||||
reset: true
|
||||
)!
|
||||
|
||||
mut client := openai.get(name: 'groq')!
|
||||
|
||||
response := client.chat_completion(
|
||||
message: 'Explain quantum computing in simple terms'
|
||||
temperature: 0.5
|
||||
max_completion_tokens: 1024
|
||||
)!
|
||||
|
||||
println(response.result)
|
||||
@@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.mcp.aitools
|
||||
import incubaid.herolib.mcp.aitools
|
||||
|
||||
// aitools.convert_pug("/root/code/github/incubaid/herolauncher/pkg/herolauncher/web/templates/admin")!
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.clients.jina
|
||||
import incubaid.herolib.clients.jina
|
||||
|
||||
mut jina_client := jina.get()!
|
||||
mut jina_client := jina.new()!
|
||||
health := jina_client.health()!
|
||||
println('Server health: ${health}')
|
||||
|
||||
@@ -34,7 +34,7 @@ train_result := jina_client.train(
|
||||
label: 'positive'
|
||||
},
|
||||
jina.TrainingExample{
|
||||
image: 'https://letsenhance.io/static/73136da51c245e80edc6ccfe44888a99/1015f/MainBefore.jpg'
|
||||
image: 'https://picsum.photos/id/11/367/267'
|
||||
label: 'negative'
|
||||
},
|
||||
]
|
||||
@@ -50,7 +50,7 @@ classify_result := jina_client.classify(
|
||||
text: 'A photo of a cat'
|
||||
},
|
||||
jina.ClassificationInput{
|
||||
image: 'https://letsenhance.io/static/73136da51c245e80edc6ccfe44888a99/1015f/MainBefore.jpg'
|
||||
image: 'https://picsum.photos/id/11/367/267'
|
||||
},
|
||||
]
|
||||
labels: ['cat', 'dog']
|
||||
30
examples/ai/jina_simple.vsh
Executable file
30
examples/ai/jina_simple.vsh
Executable file
@@ -0,0 +1,30 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import incubaid.herolib.clients.jina
|
||||
import os
|
||||
import json
|
||||
|
||||
mut j := jina.new()!
|
||||
|
||||
embeddings := j.create_embeddings(
|
||||
input: ['Hello world', 'This is a test']
|
||||
model: .jina_embeddings_v3
|
||||
task: 'separation'
|
||||
) or {
|
||||
println('Error creating embeddings: ${err}')
|
||||
return
|
||||
}
|
||||
|
||||
println('Embeddings created successfully!')
|
||||
println('Model: ${embeddings.model}')
|
||||
println('Dimension: ${embeddings.dimension}')
|
||||
println('Number of embeddings: ${embeddings.data.len}')
|
||||
|
||||
// If there are embeddings, print the first one (truncated)
|
||||
if embeddings.data.len > 0 {
|
||||
first_embedding := embeddings.data[0]
|
||||
println('First embedding (first 5 values): ${first_embedding.embedding[0..5]}')
|
||||
}
|
||||
|
||||
// Usage information
|
||||
println('Token usage: ${embeddings.usage.total_tokens} ${embeddings.usage.unit}')
|
||||
120
examples/ai/openai/README.md
Normal file
120
examples/ai/openai/README.md
Normal file
@@ -0,0 +1,120 @@
|
||||
# OpenRouter Examples - Proof of Concept
|
||||
|
||||
## Overview
|
||||
|
||||
This folder contains **example scripts** demonstrating how to use the **OpenAI client** (`herolib.clients.openai`) configured to work with **OpenRouter**.
|
||||
|
||||
* **Goal:** Show how to send messages to OpenRouter models using the OpenAI client, run a **two-model pipeline** for code enhancement, and illustrate multi-model usage.
|
||||
* **Key Insight:** The OpenAI client is OpenRouter-compatible by design - simply configure it with OpenRouter's base URL (`https://openrouter.ai/api/v1`) and API key.
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
All examples configure the OpenAI client to use OpenRouter by setting:
|
||||
|
||||
* **URL**: `https://openrouter.ai/api/v1`
|
||||
* **API Key**: Read from `OPENROUTER_API_KEY` environment variable
|
||||
* **Model**: OpenRouter model IDs (e.g., `qwen/qwen-2.5-coder-32b-instruct`)
|
||||
|
||||
Example configuration:
|
||||
|
||||
```v
|
||||
playcmds.run(
|
||||
heroscript: '
|
||||
!!openai.configure
|
||||
name: "default"
|
||||
url: "https://openrouter.ai/api/v1"
|
||||
model_default: "qwen/qwen-2.5-coder-32b-instruct"
|
||||
'
|
||||
)!
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Example Scripts
|
||||
|
||||
### 1. `openai_init.vsh`
|
||||
|
||||
* **Purpose:** Basic initialization example showing OpenAI client configured for OpenRouter.
|
||||
* **Demonstrates:** Client configuration and simple chat completion.
|
||||
* **Usage:**
|
||||
|
||||
```bash
|
||||
examples/ai/openai/openai_init.vsh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 2. `openai_hello.vsh`
|
||||
|
||||
* **Purpose:** Simple hello message to OpenRouter.
|
||||
* **Demonstrates:** Sending a single message using `client.chat_completion`.
|
||||
* **Usage:**
|
||||
|
||||
```bash
|
||||
examples/ai/openai/openai_hello.vsh
|
||||
```
|
||||
|
||||
* **Expected output:** A friendly "hello" response from the AI and token usage.
|
||||
|
||||
---
|
||||
|
||||
### 3. `openai_example.vsh`
|
||||
|
||||
* **Purpose:** Demonstrates basic conversation features.
|
||||
* **Demonstrates:**
|
||||
* Sending a single message
|
||||
* Using system + user messages for conversation context
|
||||
* Printing token usage
|
||||
* **Usage:**
|
||||
|
||||
```bash
|
||||
examples/ai/openai/openai_example.vsh
|
||||
```
|
||||
|
||||
* **Expected output:** Responses from the AI for both simple and system-prompt conversations.
|
||||
|
||||
---
|
||||
|
||||
### 4. `openai_two_model_pipeline.vsh`
|
||||
|
||||
* **Purpose:** Two-model code enhancement pipeline (proof of concept).
|
||||
* **Demonstrates:**
|
||||
* Model A (`Qwen3 Coder`) suggests code improvements.
|
||||
* Model B (`morph-v3-fast`) applies the suggested edits.
|
||||
* Tracks tokens and shows before/after code.
|
||||
* Using two separate OpenAI client instances with different models
|
||||
* **Usage:**
|
||||
|
||||
```bash
|
||||
examples/ai/openai/openai_two_model_pipeline.vsh
|
||||
```
|
||||
|
||||
* **Expected output:**
|
||||
* Original code
|
||||
* Suggested edits
|
||||
* Final updated code
|
||||
* Token usage summary
|
||||
|
||||
---
|
||||
|
||||
## Environment Variables
|
||||
|
||||
Set your OpenRouter API key before running the examples:
|
||||
|
||||
```bash
|
||||
export OPENROUTER_API_KEY="sk-or-v1-..."
|
||||
```
|
||||
|
||||
The OpenAI client automatically detects when the URL contains "openrouter" and will use the `OPENROUTER_API_KEY` environment variable.
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
1. **No separate OpenRouter client needed** - The OpenAI client is fully compatible with OpenRouter's API.
|
||||
2. All scripts configure the OpenAI client with OpenRouter's base URL.
|
||||
3. The two-model pipeline uses **two separate client instances** (one per model) to demonstrate multi-model workflows.
|
||||
4. Scripts can be run individually using the `v -enable-globals run` command.
|
||||
5. The two-model pipeline is a **proof of concept**; the flow can later be extended to multiple files or OpenRPC specs.
|
||||
59
examples/ai/openai/openai_example.vsh
Executable file
59
examples/ai/openai/openai_example.vsh
Executable file
@@ -0,0 +1,59 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import incubaid.herolib.clients.openai
|
||||
import incubaid.herolib.core.playcmds
|
||||
|
||||
// Configure OpenAI client to use OpenRouter
|
||||
playcmds.run(
|
||||
heroscript: '
|
||||
!!openai.configure
|
||||
name: "default"
|
||||
url: "https://openrouter.ai/api/v1"
|
||||
model_default: "qwen/qwen-2.5-coder-32b-instruct"
|
||||
'
|
||||
)!
|
||||
|
||||
// Get the client instance
|
||||
mut client := openai.get()!
|
||||
|
||||
println('🤖 OpenRouter Client Example (using OpenAI client)')
|
||||
println('═'.repeat(50))
|
||||
println('')
|
||||
|
||||
// Example 1: Simple message
|
||||
println('Example 1: Simple Hello')
|
||||
println('─'.repeat(50))
|
||||
mut r := client.chat_completion(
|
||||
model: 'qwen/qwen-2.5-coder-32b-instruct'
|
||||
message: 'Say hello in a creative way!'
|
||||
temperature: 0.7
|
||||
max_completion_tokens: 150
|
||||
)!
|
||||
|
||||
println('AI: ${r.result}')
|
||||
println('Tokens: ${r.usage.total_tokens}\n')
|
||||
|
||||
// Example 2: Conversation with system prompt
|
||||
println('Example 2: Conversation with System Prompt')
|
||||
println('─'.repeat(50))
|
||||
r = client.chat_completion(
|
||||
model: 'qwen/qwen-2.5-coder-32b-instruct'
|
||||
messages: [
|
||||
openai.Message{
|
||||
role: .system
|
||||
content: 'You are a helpful coding assistant who speaks concisely.'
|
||||
},
|
||||
openai.Message{
|
||||
role: .user
|
||||
content: 'What is V programming language?'
|
||||
},
|
||||
]
|
||||
temperature: 0.3
|
||||
max_completion_tokens: 200
|
||||
)!
|
||||
|
||||
println('AI: ${r.result}')
|
||||
println('Tokens: ${r.usage.total_tokens}\n')
|
||||
|
||||
println('═'.repeat(50))
|
||||
println('✓ Examples completed successfully!')
|
||||
41
examples/ai/openai/openai_hello.vsh
Executable file
41
examples/ai/openai/openai_hello.vsh
Executable file
@@ -0,0 +1,41 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import incubaid.herolib.clients.openai
|
||||
import incubaid.herolib.core.playcmds
|
||||
|
||||
// Configure OpenAI client to use OpenRouter
|
||||
playcmds.run(
|
||||
heroscript: '
|
||||
!!openai.configure
|
||||
name: "default"
|
||||
url: "https://openrouter.ai/api/v1"
|
||||
model_default: "qwen/qwen-2.5-coder-32b-instruct"
|
||||
'
|
||||
)!
|
||||
|
||||
// Get the client instance
|
||||
mut client := openai.get() or {
|
||||
eprintln('Failed to get client: ${err}')
|
||||
return
|
||||
}
|
||||
|
||||
println('Sending message to OpenRouter...\n')
|
||||
|
||||
// Simple hello message
|
||||
response := client.chat_completion(
|
||||
model: 'qwen/qwen-2.5-coder-32b-instruct'
|
||||
message: 'Say hello in a friendly way!'
|
||||
temperature: 0.7
|
||||
max_completion_tokens: 100
|
||||
) or {
|
||||
eprintln('Failed to get completion: ${err}')
|
||||
return
|
||||
}
|
||||
|
||||
println('Response from AI:')
|
||||
println('─'.repeat(50))
|
||||
println(response.result)
|
||||
println('─'.repeat(50))
|
||||
println('\nTokens used: ${response.usage.total_tokens}')
|
||||
println(' - Prompt: ${response.usage.prompt_tokens}')
|
||||
println(' - Completion: ${response.usage.completion_tokens}')
|
||||
@@ -1,7 +1,9 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.clients.openai
|
||||
import freeflowuniverse.herolib.core.playcmds
|
||||
import incubaid.herolib.clients.openai
|
||||
import incubaid.herolib.core.playcmds
|
||||
|
||||
// to set the API key, either set it here, or set the OPENAI_API_KEY environment variable
|
||||
|
||||
playcmds.run(
|
||||
heroscript: '
|
||||
@@ -18,3 +20,5 @@ mut r := client.chat_completion(
|
||||
temperature: 0.3
|
||||
max_completion_tokens: 1024
|
||||
)!
|
||||
|
||||
println(r.result)
|
||||
134
examples/ai/openai/openai_two_model_pipeline.vsh
Executable file
134
examples/ai/openai/openai_two_model_pipeline.vsh
Executable file
@@ -0,0 +1,134 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import incubaid.herolib.clients.openai
|
||||
import incubaid.herolib.core.playcmds
|
||||
|
||||
// Sample code file to be improved
|
||||
const sample_code = '
|
||||
def calculate_sum(numbers):
|
||||
total = 0
|
||||
for i in range(len(numbers)):
|
||||
total = total + numbers[i]
|
||||
return total
|
||||
|
||||
def find_max(lst):
|
||||
max = lst[0]
|
||||
for i in range(1, len(lst)):
|
||||
if lst[i] > max:
|
||||
max = lst[i]
|
||||
return max
|
||||
'
|
||||
|
||||
// Configure two OpenAI client instances to use OpenRouter with different models
|
||||
// Model A: Enhancement model (Qwen Coder)
|
||||
playcmds.run(
|
||||
heroscript: '
|
||||
!!openai.configure
|
||||
name: "enhancer"
|
||||
url: "https://openrouter.ai/api/v1"
|
||||
model_default: "qwen/qwen-2.5-coder-32b-instruct"
|
||||
'
|
||||
)!
|
||||
|
||||
// Model B: Modification model (Llama 3.3 70B)
|
||||
playcmds.run(
|
||||
heroscript: '
|
||||
!!openai.configure
|
||||
name: "modifier"
|
||||
url: "https://openrouter.ai/api/v1"
|
||||
model_default: "meta-llama/llama-3.3-70b-instruct"
|
||||
'
|
||||
)!
|
||||
|
||||
mut enhancer := openai.get(name: 'enhancer') or { panic('Failed to get enhancer client: ${err}') }
|
||||
|
||||
mut modifier := openai.get(name: 'modifier') or { panic('Failed to get modifier client: ${err}') }
|
||||
|
||||
println('═'.repeat(70))
|
||||
println('🔧 Two-Model Code Enhancement Pipeline - Proof of Concept')
|
||||
println('🔧 Using OpenAI client configured for OpenRouter')
|
||||
println('═'.repeat(70))
|
||||
println('')
|
||||
|
||||
// Step 1: Get enhancement suggestions from Model A (Qwen Coder)
|
||||
println('📝 STEP 1: Code Enhancement Analysis')
|
||||
println('─'.repeat(70))
|
||||
println('Model: qwen/qwen-2.5-coder-32b-instruct')
|
||||
println('Task: Analyze code and suggest improvements\n')
|
||||
|
||||
enhancement_prompt := 'You are a code enhancement agent.
|
||||
Your job is to analyze the following Python code and propose improvements or fixes.
|
||||
Output your response as **pure edits or diffs only**, not a full rewritten file.
|
||||
Focus on:
|
||||
- Performance improvements
|
||||
- Pythonic idioms
|
||||
- Bug fixes
|
||||
- Code clarity
|
||||
|
||||
Here is the code to analyze:
|
||||
${sample_code}
|
||||
|
||||
Provide specific edit instructions or diffs.'
|
||||
|
||||
println('🤖 Sending to enhancement model...')
|
||||
enhancement_result := enhancer.chat_completion(
|
||||
message: enhancement_prompt
|
||||
temperature: 0.3
|
||||
max_completion_tokens: 2000
|
||||
) or {
|
||||
eprintln('❌ Enhancement failed: ${err}')
|
||||
return
|
||||
}
|
||||
|
||||
println('\n✅ Enhancement suggestions received:')
|
||||
println('─'.repeat(70))
|
||||
println(enhancement_result.result)
|
||||
println('─'.repeat(70))
|
||||
println('Tokens used: ${enhancement_result.usage.total_tokens}\n')
|
||||
|
||||
// Step 2: Apply edits using Model B (Llama 3.3 70B)
|
||||
println('\n📝 STEP 2: Apply Code Modifications')
|
||||
println('─'.repeat(70))
|
||||
println('Model: meta-llama/llama-3.3-70b-instruct')
|
||||
println('Task: Apply the suggested edits to produce updated code\n')
|
||||
|
||||
modification_prompt := 'You are a file editing agent.
|
||||
Apply the given edits or diffs to the provided file.
|
||||
Output the updated Python code only, without comments or explanations.
|
||||
|
||||
ORIGINAL CODE:
|
||||
${sample_code}
|
||||
|
||||
EDITS TO APPLY:
|
||||
${enhancement_result.result}
|
||||
|
||||
Output only the final, updated Python code.'
|
||||
|
||||
println('🤖 Sending to modification model...')
|
||||
modification_result := modifier.chat_completion(
|
||||
message: modification_prompt
|
||||
temperature: 0.1
|
||||
max_completion_tokens: 2000
|
||||
) or {
|
||||
eprintln('❌ Modification failed: ${err}')
|
||||
return
|
||||
}
|
||||
|
||||
println('\n✅ Modified code received:')
|
||||
println('─'.repeat(70))
|
||||
println(modification_result.result)
|
||||
println('─'.repeat(70))
|
||||
println('Tokens used: ${modification_result.usage.total_tokens}\n')
|
||||
|
||||
// Summary
|
||||
println('\n📊 PIPELINE SUMMARY')
|
||||
println('═'.repeat(70))
|
||||
println('Original code length: ${sample_code.len} chars')
|
||||
println('Enhancement model: qwen/qwen-2.5-coder-32b-instruct')
|
||||
println('Enhancement tokens: ${enhancement_result.usage.total_tokens}')
|
||||
println('Modification model: meta-llama/llama-3.3-70b-instruct')
|
||||
println('Modification tokens: ${modification_result.usage.total_tokens}')
|
||||
println('Total tokens: ${enhancement_result.usage.total_tokens +
|
||||
modification_result.usage.total_tokens}')
|
||||
println('═'.repeat(70))
|
||||
println('\n✅ Two-model pipeline completed successfully!')
|
||||
42
examples/ai/openaiclient_openrouter.vsh
Executable file
42
examples/ai/openaiclient_openrouter.vsh
Executable file
@@ -0,0 +1,42 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import incubaid.herolib.clients.openai
|
||||
import incubaid.herolib.core.playcmds
|
||||
|
||||
playcmds.run(
|
||||
heroscript: '
|
||||
!!openai.configure name:"default"
|
||||
url:"https://openrouter.ai/api/v1"
|
||||
model_default:"gpt-oss-120b"
|
||||
'
|
||||
reset: false
|
||||
)!
|
||||
|
||||
// Get the client instance
|
||||
mut client := openai.get() or {
|
||||
eprintln('Failed to get client: ${err}')
|
||||
return
|
||||
}
|
||||
|
||||
println(client.list_models()!)
|
||||
|
||||
println('Sending message to OpenRouter...\n')
|
||||
|
||||
// Simple hello message
|
||||
response := client.chat_completion(
|
||||
model: 'qwen/qwen-2.5-coder-32b-instruct'
|
||||
message: 'Say hello in a friendly way!'
|
||||
temperature: 0.7
|
||||
max_completion_tokens: 100
|
||||
) or {
|
||||
eprintln('Failed to get completion: ${err}')
|
||||
return
|
||||
}
|
||||
|
||||
println('Response from AI:')
|
||||
println('─'.repeat(50))
|
||||
println(response.result)
|
||||
println('─'.repeat(50))
|
||||
println('\nTokens used: ${response.usage.total_tokens}')
|
||||
println(' - Prompt: ${response.usage.prompt_tokens}')
|
||||
println(' - Completion: ${response.usage.completion_tokens}')
|
||||
@@ -1,8 +1,8 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.clients.qdrant
|
||||
import freeflowuniverse.herolib.installers.db.qdrant_installer
|
||||
import freeflowuniverse.herolib.core.httpconnection
|
||||
import incubaid.herolib.clients.qdrant
|
||||
import incubaid.herolib.installers.db.qdrant_installer
|
||||
import incubaid.herolib.core.httpconnection
|
||||
import rand
|
||||
import os
|
||||
|
||||
9
examples/ai/readme.md
Normal file
9
examples/ai/readme.md
Normal file
@@ -0,0 +1,9 @@
|
||||
|
||||
configuration can happen by means of environment variables, e.g.:
|
||||
|
||||
```bash
|
||||
export OPENROUTER_API_KEY='sk-or-v1-..'
|
||||
export JINAKEY='jina_..'
|
||||
export GROQKEY='gsk_'
|
||||
```
|
||||
|
||||
@@ -1,71 +0,0 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
module main
|
||||
|
||||
import freeflowuniverse.herolib.clients.openai
|
||||
import os
|
||||
|
||||
fn test1(mut client openai.OpenAI) ! {
|
||||
instruction := '
|
||||
You are a template language converter. You convert Pug templates to Jet templates.
|
||||
|
||||
The target template language, Jet, is defined as follows:
|
||||
'
|
||||
|
||||
// Create a chat completion request
|
||||
res := client.chat_completion(
|
||||
msgs: openai.Messages{
|
||||
messages: [
|
||||
openai.Message{
|
||||
role: .user
|
||||
content: 'What are the key differences between Groq and other AI inference providers?'
|
||||
},
|
||||
]
|
||||
}
|
||||
)!
|
||||
|
||||
// Print the response
|
||||
println('\nGroq AI Response:')
|
||||
println('==================')
|
||||
println(res.choices[0].message.content)
|
||||
println('\nUsage Statistics:')
|
||||
println('Prompt tokens: ${res.usage.prompt_tokens}')
|
||||
println('Completion tokens: ${res.usage.completion_tokens}')
|
||||
println('Total tokens: ${res.usage.total_tokens}')
|
||||
}
|
||||
|
||||
fn test2(mut client openai.OpenAI) ! {
|
||||
// Create a chat completion request
|
||||
res := client.chat_completion(
|
||||
model: 'deepseek-r1-distill-llama-70b'
|
||||
msgs: openai.Messages{
|
||||
messages: [
|
||||
openai.Message{
|
||||
role: .user
|
||||
content: 'A story of 10 lines?'
|
||||
},
|
||||
]
|
||||
}
|
||||
)!
|
||||
|
||||
println('\nGroq AI Response:')
|
||||
println('==================')
|
||||
println(res.choices[0].message.content)
|
||||
println('\nUsage Statistics:')
|
||||
println('Prompt tokens: ${res.usage.prompt_tokens}')
|
||||
println('Completion tokens: ${res.usage.completion_tokens}')
|
||||
println('Total tokens: ${res.usage.total_tokens}')
|
||||
}
|
||||
|
||||
println("
|
||||
TO USE:
|
||||
export AIKEY='gsk_...'
|
||||
export AIURL='https://api.groq.com/openai/v1'
|
||||
export AIMODEL='llama-3.3-70b-versatile'
|
||||
")
|
||||
|
||||
mut client := openai.get(name: 'test')!
|
||||
println(client)
|
||||
|
||||
// test1(mut client)!
|
||||
test2(mut client)!
|
||||
@@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.hero.bootstrap
|
||||
import incubaid.herolib.hero.bootstrap
|
||||
|
||||
mut al := bootstrap.new_alpine_loader()
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.biz.investortool
|
||||
import freeflowuniverse.herolib.core.playbook
|
||||
import incubaid.herolib.biz.investortool
|
||||
import incubaid.herolib.core.playbook
|
||||
import os
|
||||
|
||||
mut plbook := playbook.new(
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
#!/usr/bin/env -S v -cg -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
// #!/usr/bin/env -S v -cg -enable-globals run
|
||||
import freeflowuniverse.herolib.data.doctree
|
||||
import freeflowuniverse.herolib.ui.console
|
||||
import freeflowuniverse.herolib.biz.bizmodel
|
||||
import freeflowuniverse.herolib.core.playbook
|
||||
import freeflowuniverse.herolib.core.playcmds
|
||||
import freeflowuniverse.herolib.web.mdbook
|
||||
import freeflowuniverse.herolib.biz.spreadsheet
|
||||
import incubaid.herolib.data.doctree
|
||||
import incubaid.herolib.ui.console
|
||||
import incubaid.herolib.biz.bizmodel
|
||||
import incubaid.herolib.core.playbook
|
||||
import incubaid.herolib.core.playcmds
|
||||
import incubaid.herolib.web.mdbook
|
||||
import incubaid.herolib.biz.spreadsheet
|
||||
import os
|
||||
|
||||
const name = 'tf9_budget'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.biz.bizmodel
|
||||
import incubaid.herolib.biz.bizmodel
|
||||
import os
|
||||
|
||||
const playbook_path = os.dir(@FILE) + '/playbook'
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.biz.bizmodel
|
||||
import freeflowuniverse.herolib.core.playbook
|
||||
import incubaid.herolib.biz.bizmodel
|
||||
import incubaid.herolib.core.playbook
|
||||
import os
|
||||
|
||||
heroscript := "
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.biz.bizmodel
|
||||
import freeflowuniverse.herolib.core.playbook
|
||||
import incubaid.herolib.biz.bizmodel
|
||||
import incubaid.herolib.core.playbook
|
||||
import os
|
||||
|
||||
heroscript := "
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.biz.bizmodel
|
||||
import freeflowuniverse.herolib.core.playbook
|
||||
import incubaid.herolib.biz.bizmodel
|
||||
import incubaid.herolib.core.playbook
|
||||
import os
|
||||
|
||||
heroscript_path := os.join_path(os.dir(@FILE), 'examples/complete.heroscript')
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.biz.bizmodel
|
||||
import freeflowuniverse.herolib.core.playbook
|
||||
import freeflowuniverse.herolib.core.playcmds
|
||||
import incubaid.herolib.biz.bizmodel
|
||||
import incubaid.herolib.core.playbook
|
||||
import incubaid.herolib.core.playcmds
|
||||
import os
|
||||
|
||||
heroscript_path := os.join_path(os.dir(@FILE), 'examples/complete.heroscript')
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.biz.bizmodel
|
||||
import freeflowuniverse.herolib.core.playbook
|
||||
import incubaid.herolib.biz.bizmodel
|
||||
import incubaid.herolib.core.playbook
|
||||
import os
|
||||
|
||||
heroscript_path := os.join_path(os.dir(@FILE), 'examples/full')
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.biz.bizmodel
|
||||
import freeflowuniverse.herolib.core.playbook
|
||||
import incubaid.herolib.biz.bizmodel
|
||||
import incubaid.herolib.core.playbook
|
||||
import os
|
||||
|
||||
heroscript := "
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.biz.bizmodel
|
||||
import freeflowuniverse.herolib.core.playbook
|
||||
import incubaid.herolib.biz.bizmodel
|
||||
import incubaid.herolib.core.playbook
|
||||
import os
|
||||
|
||||
heroscript := "
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.biz.bizmodel
|
||||
import freeflowuniverse.herolib.core.playbook
|
||||
import incubaid.herolib.biz.bizmodel
|
||||
import incubaid.herolib.core.playbook
|
||||
import os
|
||||
|
||||
heroscript := "
|
||||
|
||||
@@ -19,6 +19,7 @@ A V program that demonstrates remote execution of system operations:
|
||||
### `run.sh`
|
||||
|
||||
A bash script that:
|
||||
|
||||
1. Compiles the V program
|
||||
2. Copies it to a remote machine using SCP
|
||||
3. Executes it remotely using SSH
|
||||
@@ -45,16 +46,19 @@ Modify these values to match your remote system configuration.
|
||||
## Usage
|
||||
|
||||
1. Set the required environment variable:
|
||||
|
||||
```bash
|
||||
export SECRET=your_secret_value
|
||||
```
|
||||
|
||||
2. Make the script executable:
|
||||
|
||||
```bash
|
||||
chmod +x run.sh
|
||||
```
|
||||
|
||||
3. Run the script:
|
||||
|
||||
```bash
|
||||
./run.sh
|
||||
```
|
||||
@@ -66,9 +70,8 @@ This example demonstrates practical usage of the herolib builder module's remote
|
||||
The builder module provides a more structured way to manage remote nodes and execute commands:
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.builder
|
||||
import incubaid.herolib.builder
|
||||
mut b := builder.new()!
|
||||
mut n := b.node_new(ipaddr:"user@host:port")!
|
||||
// Execute commands on the remote node
|
||||
```
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
module main
|
||||
|
||||
import freeflowuniverse.herolib.core
|
||||
import incubaid.herolib.core
|
||||
|
||||
fn do() ! {
|
||||
// base.uninstall_brew()!
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.builder
|
||||
import freeflowuniverse.herolib.core.pathlib
|
||||
import incubaid.herolib.builder
|
||||
import incubaid.herolib.core.pathlib
|
||||
import os
|
||||
|
||||
fn do1() ! {
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.builder
|
||||
import freeflowuniverse.herolib.core.pathlib
|
||||
import incubaid.herolib.builder
|
||||
import incubaid.herolib.core.pathlib
|
||||
import os
|
||||
|
||||
mut b := builder.new()!
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.builder
|
||||
import freeflowuniverse.herolib.core.pathlib
|
||||
import incubaid.herolib.builder
|
||||
import incubaid.herolib.core.pathlib
|
||||
import os
|
||||
|
||||
mut b := builder.new()!
|
||||
|
||||
391
examples/builder/zosbuilder.vsh
Executable file
391
examples/builder/zosbuilder.vsh
Executable file
@@ -0,0 +1,391 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import incubaid.herolib.builder
|
||||
import incubaid.herolib.core.pathlib
|
||||
|
||||
// Configuration for the remote builder
|
||||
// Update these values for your remote machine
|
||||
const remote_host = 'root@65.109.31.171' // Change to your remote host
|
||||
|
||||
const remote_port = 22 // SSH port
|
||||
|
||||
// Build configuration
|
||||
const build_dir = '/root/zosbuilder'
|
||||
const repo_url = 'https://git.ourworld.tf/tfgrid/zosbuilder'
|
||||
|
||||
// Optional: Set to true to upload kernel to S3
|
||||
const upload_kernel = false
|
||||
|
||||
fn main() {
|
||||
println('=== Zero OS Builder - Remote Build System ===\n')
|
||||
|
||||
// Initialize builder
|
||||
mut b := builder.new() or {
|
||||
eprintln('Failed to initialize builder: ${err}')
|
||||
exit(1)
|
||||
}
|
||||
|
||||
// Connect to remote node
|
||||
println('Connecting to remote builder: ${remote_host}:${remote_port}')
|
||||
mut node := b.node_new(
|
||||
ipaddr: '${remote_host}:${remote_port}'
|
||||
name: 'zosbuilder'
|
||||
) or {
|
||||
eprintln('Failed to connect to remote node: ${err}')
|
||||
exit(1)
|
||||
}
|
||||
|
||||
// Run the build process
|
||||
build_zos(mut node) or {
|
||||
eprintln('Build failed: ${err}')
|
||||
exit(1)
|
||||
}
|
||||
|
||||
println('\n=== Build completed successfully! ===')
|
||||
}
|
||||
|
||||
fn build_zos(mut node builder.Node) ! {
|
||||
println('\n--- Step 1: Installing prerequisites ---')
|
||||
install_prerequisites(mut node)!
|
||||
|
||||
println('\n--- Step 2: Cloning zosbuilder repository ---')
|
||||
clone_repository(mut node)!
|
||||
|
||||
println('\n--- Step 3: Creating RFS configuration ---')
|
||||
create_rfs_config(mut node)!
|
||||
|
||||
println('\n--- Step 4: Running build ---')
|
||||
run_build(mut node)!
|
||||
|
||||
println('\n--- Step 5: Checking build artifacts ---')
|
||||
check_artifacts(mut node)!
|
||||
|
||||
println('\n=== Build completed successfully! ===')
|
||||
}
|
||||
|
||||
fn install_prerequisites(mut node builder.Node) ! {
|
||||
println('Detecting platform...')
|
||||
|
||||
// Check platform type
|
||||
if node.platform == .ubuntu {
|
||||
println('Installing Ubuntu/Debian prerequisites...')
|
||||
|
||||
// Update package list and install all required packages
|
||||
node.exec_cmd(
|
||||
cmd: '
|
||||
apt-get update
|
||||
apt-get install -y \\
|
||||
build-essential \\
|
||||
upx-ucl \\
|
||||
binutils \\
|
||||
git \\
|
||||
wget \\
|
||||
curl \\
|
||||
qemu-system-x86 \\
|
||||
podman \\
|
||||
musl-tools \\
|
||||
cpio \\
|
||||
xz-utils \\
|
||||
bc \\
|
||||
flex \\
|
||||
bison \\
|
||||
libelf-dev \\
|
||||
libssl-dev
|
||||
|
||||
# Install rustup and Rust toolchain
|
||||
if ! command -v rustup &> /dev/null; then
|
||||
echo "Installing rustup..."
|
||||
curl --proto "=https" --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain stable
|
||||
source "\$HOME/.cargo/env"
|
||||
fi
|
||||
|
||||
# Add Rust musl target
|
||||
source "\$HOME/.cargo/env"
|
||||
rustup target add x86_64-unknown-linux-musl
|
||||
'
|
||||
name: 'install_ubuntu_packages'
|
||||
reset: true
|
||||
)!
|
||||
} else if node.platform == .alpine {
|
||||
println('Installing Alpine prerequisites...')
|
||||
|
||||
node.exec_cmd(
|
||||
cmd: '
|
||||
apk add --no-cache \\
|
||||
build-base \\
|
||||
rust \\
|
||||
cargo \\
|
||||
upx \\
|
||||
git \\
|
||||
wget \\
|
||||
qemu-system-x86 \\
|
||||
podman
|
||||
|
||||
# Add Rust musl target
|
||||
rustup target add x86_64-unknown-linux-musl || echo "rustup not available"
|
||||
'
|
||||
name: 'install_alpine_packages'
|
||||
reset: true
|
||||
)!
|
||||
} else {
|
||||
return error('Unsupported platform: ${node.platform}. Only Ubuntu/Debian and Alpine are supported.')
|
||||
}
|
||||
|
||||
println('Prerequisites installed successfully')
|
||||
}
|
||||
|
||||
fn clone_repository(mut node builder.Node) ! {
|
||||
// Clean up disk space first
|
||||
println('Cleaning up disk space...')
|
||||
node.exec_cmd(
|
||||
cmd: '
|
||||
# Remove old build directories if they exist
|
||||
rm -rf ${build_dir} || true
|
||||
|
||||
# Clean up podman/docker cache to free space
|
||||
podman system prune -af || true
|
||||
|
||||
# Clean up package manager cache
|
||||
if command -v apt-get &> /dev/null; then
|
||||
apt-get clean || true
|
||||
fi
|
||||
|
||||
# Show disk space
|
||||
df -h /
|
||||
'
|
||||
name: 'cleanup_disk_space'
|
||||
stdout: true
|
||||
)!
|
||||
|
||||
// Clone the repository
|
||||
println('Cloning from ${repo_url}...')
|
||||
node.exec_cmd(
|
||||
cmd: '
|
||||
git clone ${repo_url} ${build_dir}
|
||||
cd ${build_dir}
|
||||
git log -1 --oneline
|
||||
'
|
||||
name: 'clone_zosbuilder'
|
||||
stdout: true
|
||||
)!
|
||||
|
||||
println('Repository cloned successfully')
|
||||
}
|
||||
|
||||
fn create_rfs_config(mut node builder.Node) ! {
|
||||
println('Creating config/rfs.conf...')
|
||||
|
||||
rfs_config := 'S3_ENDPOINT="http://wizenoze.grid.tf:3900"
|
||||
S3_REGION="garage"
|
||||
S3_BUCKET="zos"
|
||||
S3_PREFIX="store"
|
||||
S3_ACCESS_KEY="<put key here>"
|
||||
S3_SECRET_KEY="<put key here>"
|
||||
WEB_ENDPOINT=""
|
||||
MANIFESTS_SUBPATH="flists"
|
||||
READ_ACCESS_KEY="<put key here>"
|
||||
READ_SECRET_KEY="<put key here>"
|
||||
ROUTE_ENDPOINT="http://wizenoze.grid.tf:3900"
|
||||
ROUTE_PATH="/zos/store"
|
||||
ROUTE_REGION="garage"
|
||||
KEEP_S3_FALLBACK="false"
|
||||
UPLOAD_MANIFESTS="true"
|
||||
'
|
||||
|
||||
// Create config directory if it doesn't exist
|
||||
node.exec_cmd(
|
||||
cmd: 'mkdir -p ${build_dir}/config'
|
||||
name: 'create_config_dir'
|
||||
stdout: false
|
||||
)!
|
||||
|
||||
// Write the RFS configuration file
|
||||
node.file_write('${build_dir}/config/rfs.conf', rfs_config)!
|
||||
|
||||
// Verify the file was created
|
||||
result := node.exec(
|
||||
cmd: 'cat ${build_dir}/config/rfs.conf'
|
||||
stdout: false
|
||||
)!
|
||||
|
||||
println('RFS configuration created successfully')
|
||||
println('Config preview:')
|
||||
println(result)
|
||||
|
||||
// Skip youki component by removing it from sources.conf
|
||||
println('\nRemoving youki from sources.conf (requires SSH keys)...')
|
||||
node.exec_cmd(
|
||||
cmd: '
|
||||
# Remove any line containing youki from sources.conf
|
||||
grep -v "youki" ${build_dir}/config/sources.conf > ${build_dir}/config/sources.conf.tmp
|
||||
mv ${build_dir}/config/sources.conf.tmp ${build_dir}/config/sources.conf
|
||||
|
||||
# Verify it was removed
|
||||
echo "Updated sources.conf:"
|
||||
cat ${build_dir}/config/sources.conf
|
||||
'
|
||||
name: 'remove_youki'
|
||||
stdout: true
|
||||
)!
|
||||
println('youki component skipped')
|
||||
}
|
||||
|
||||
fn run_build(mut node builder.Node) ! {
|
||||
println('Starting build process...')
|
||||
println('This may take 15-30 minutes depending on your system...')
|
||||
println('Status updates will be printed every 2 minutes...\n')
|
||||
|
||||
// Check disk space before building
|
||||
println('Checking disk space...')
|
||||
disk_info := node.exec(
|
||||
cmd: 'df -h ${build_dir}'
|
||||
stdout: false
|
||||
)!
|
||||
println(disk_info)
|
||||
|
||||
// Clean up any previous build artifacts and corrupted databases
|
||||
println('Cleaning up previous build artifacts...')
|
||||
node.exec_cmd(
|
||||
cmd: '
|
||||
cd ${build_dir}
|
||||
|
||||
# Remove dist directory to clean up any corrupted databases
|
||||
rm -rf dist/
|
||||
|
||||
# Clean up any temporary files
|
||||
rm -rf /tmp/rfs-* || true
|
||||
|
||||
# Show available disk space after cleanup
|
||||
df -h ${build_dir}
|
||||
'
|
||||
name: 'cleanup_before_build'
|
||||
stdout: true
|
||||
)!
|
||||
|
||||
// Make scripts executable and run build with periodic status messages
|
||||
mut build_cmd := '
|
||||
cd ${build_dir}
|
||||
|
||||
# Source Rust environment
|
||||
source "\$HOME/.cargo/env"
|
||||
|
||||
# Make scripts executable
|
||||
chmod +x scripts/build.sh scripts/clean.sh
|
||||
|
||||
# Set environment variables
|
||||
export UPLOAD_KERNEL=${upload_kernel}
|
||||
export UPLOAD_MANIFESTS=false
|
||||
|
||||
# Create a wrapper script that prints status every 2 minutes
|
||||
cat > /tmp/build_with_status.sh << "EOF"
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
# Source Rust environment
|
||||
source "\$HOME/.cargo/env"
|
||||
|
||||
# Start the build in background
|
||||
./scripts/build.sh &
|
||||
BUILD_PID=\$!
|
||||
|
||||
# Print status every 2 minutes while build is running
|
||||
COUNTER=0
|
||||
while kill -0 \$BUILD_PID 2>/dev/null; do
|
||||
sleep 120
|
||||
COUNTER=\$((COUNTER + 2))
|
||||
echo ""
|
||||
echo "=== Build still in progress... (\${COUNTER} minutes elapsed) ==="
|
||||
echo ""
|
||||
done
|
||||
|
||||
# Wait for build to complete and get exit code
|
||||
wait \$BUILD_PID
|
||||
EXIT_CODE=\$?
|
||||
|
||||
if [ \$EXIT_CODE -eq 0 ]; then
|
||||
echo ""
|
||||
echo "=== Build completed successfully after \${COUNTER} minutes ==="
|
||||
else
|
||||
echo ""
|
||||
echo "=== Build failed after \${COUNTER} minutes with exit code \$EXIT_CODE ==="
|
||||
fi
|
||||
|
||||
exit \$EXIT_CODE
|
||||
EOF
|
||||
|
||||
chmod +x /tmp/build_with_status.sh
|
||||
/tmp/build_with_status.sh
|
||||
' // Execute build with output
|
||||
|
||||
result := node.exec_cmd(
|
||||
cmd: build_cmd
|
||||
name: 'zos_build'
|
||||
stdout: true
|
||||
reset: true
|
||||
period: 0 // Don't cache, always rebuild
|
||||
)!
|
||||
|
||||
println('\nBuild completed!')
|
||||
println(result)
|
||||
}
|
||||
|
||||
fn check_artifacts(mut node builder.Node) ! {
|
||||
println('Checking build artifacts in ${build_dir}/dist/...')
|
||||
|
||||
// List the dist directory
|
||||
result := node.exec(
|
||||
cmd: 'ls -lh ${build_dir}/dist/'
|
||||
stdout: true
|
||||
)!
|
||||
|
||||
println('\nBuild artifacts:')
|
||||
println(result)
|
||||
|
||||
// Check for expected files
|
||||
vmlinuz_exists := node.file_exists('${build_dir}/dist/vmlinuz.efi')
|
||||
initramfs_exists := node.file_exists('${build_dir}/dist/initramfs.cpio.xz')
|
||||
|
||||
if vmlinuz_exists && initramfs_exists {
|
||||
println('\n✓ Build artifacts created successfully:')
|
||||
println(' - vmlinuz.efi (Kernel with embedded initramfs)')
|
||||
println(' - initramfs.cpio.xz (Standalone initramfs archive)')
|
||||
|
||||
// Get file sizes
|
||||
size_info := node.exec(
|
||||
cmd: 'du -h ${build_dir}/dist/vmlinuz.efi ${build_dir}/dist/initramfs.cpio.xz'
|
||||
stdout: false
|
||||
)!
|
||||
println('\nFile sizes:')
|
||||
println(size_info)
|
||||
} else {
|
||||
return error('Build artifacts not found. Build may have failed.')
|
||||
}
|
||||
}
|
||||
|
||||
// Download artifacts to local machine
|
||||
fn download_artifacts(mut node builder.Node, local_dest string) ! {
|
||||
println('Downloading artifacts to local machine...')
|
||||
|
||||
mut dest_path := pathlib.get_dir(path: local_dest, create: true)!
|
||||
|
||||
println('Downloading to ${dest_path.path}...')
|
||||
|
||||
// Download the entire dist directory
|
||||
node.download(
|
||||
source: '${build_dir}/dist/'
|
||||
dest: dest_path.path
|
||||
)!
|
||||
|
||||
println('\n✓ Artifacts downloaded successfully to ${dest_path.path}')
|
||||
|
||||
// List downloaded files
|
||||
println('\nDownloaded files:')
|
||||
result := node.exec(
|
||||
cmd: 'ls -lh ${dest_path.path}'
|
||||
stdout: false
|
||||
) or {
|
||||
println('Could not list local files')
|
||||
return
|
||||
}
|
||||
println(result)
|
||||
}
|
||||
224
examples/builder/zosbuilder_README.md
Normal file
224
examples/builder/zosbuilder_README.md
Normal file
@@ -0,0 +1,224 @@
|
||||
# Zero OS Builder - Remote Build System
|
||||
|
||||
This example demonstrates how to build [Zero OS (zosbuilder)](https://git.ourworld.tf/tfgrid/zosbuilder) on a remote machine using the herolib builder module.
|
||||
|
||||
## Overview
|
||||
|
||||
The zosbuilder creates a Zero OS Alpine Initramfs with:
|
||||
- Alpine Linux 3.22 base
|
||||
- Custom kernel with embedded initramfs
|
||||
- ThreeFold components (zinit, rfs, mycelium, zosstorage)
|
||||
- Optimized size with UPX compression
|
||||
- Two-stage module loading
|
||||
|
||||
## Prerequisites
|
||||
|
||||
### Local Machine
|
||||
- V compiler installed
|
||||
- SSH access to a remote build machine
|
||||
- herolib installed
|
||||
|
||||
### Remote Build Machine
|
||||
The script will automatically install these on the remote machine:
|
||||
- **Ubuntu/Debian**: build-essential, rustc, cargo, upx-ucl, binutils, git, wget, qemu-system-x86, podman, musl-tools
|
||||
- **Alpine Linux**: build-base, rust, cargo, upx, git, wget, qemu-system-x86, podman
|
||||
- Rust musl target (x86_64-unknown-linux-musl)
|
||||
|
||||
## Configuration
|
||||
|
||||
Edit the constants in `zosbuilder.vsh`:
|
||||
|
||||
```v
|
||||
const (
|
||||
// Remote machine connection
|
||||
remote_host = 'root@195.192.213.2' // Your remote host
|
||||
remote_port = 22 // SSH port
|
||||
|
||||
// Build configuration
|
||||
build_dir = '/root/zosbuilder' // Build directory on remote
|
||||
repo_url = 'https://git.ourworld.tf/tfgrid/zosbuilder'
|
||||
|
||||
// Optional: Upload kernel to S3
|
||||
upload_kernel = false
|
||||
)
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Build
|
||||
|
||||
```bash
|
||||
# Make the script executable
|
||||
chmod +x zosbuilder.vsh
|
||||
|
||||
# Run the build
|
||||
./zosbuilder.vsh
|
||||
```
|
||||
|
||||
### What the Script Does
|
||||
|
||||
1. **Connects to Remote Machine**: Establishes SSH connection to the build server
|
||||
2. **Installs Prerequisites**: Automatically installs all required build tools
|
||||
3. **Clones Repository**: Fetches the latest zosbuilder code
|
||||
4. **Runs Build**: Executes the build process (takes 15-30 minutes)
|
||||
5. **Verifies Artifacts**: Checks that build outputs were created successfully
|
||||
|
||||
### Build Output
|
||||
|
||||
The build creates two main artifacts in `${build_dir}/dist/`:
|
||||
- `vmlinuz.efi` - Kernel with embedded initramfs (bootable)
|
||||
- `initramfs.cpio.xz` - Standalone initramfs archive
|
||||
|
||||
## Build Process Details
|
||||
|
||||
The zosbuilder follows these phases:
|
||||
|
||||
### Phase 1: Environment Setup
|
||||
- Creates build directories
|
||||
- Installs build dependencies
|
||||
- Sets up Rust musl target
|
||||
|
||||
### Phase 2: Alpine Base
|
||||
- Downloads Alpine 3.22 miniroot
|
||||
- Extracts to initramfs directory
|
||||
- Installs packages from config/packages.list
|
||||
|
||||
### Phase 3: Component Building
|
||||
- Builds zinit (init system)
|
||||
- Builds rfs (remote filesystem)
|
||||
- Builds mycelium (networking)
|
||||
- Builds zosstorage (storage orchestration)
|
||||
|
||||
### Phase 4: System Configuration
|
||||
- Replaces /sbin/init with zinit
|
||||
- Copies zinit configuration
|
||||
- Sets up 2-stage module loading
|
||||
- Configures system services
|
||||
|
||||
### Phase 5: Optimization
|
||||
- Removes docs, man pages, locales
|
||||
- Strips executables and libraries
|
||||
- UPX compresses all binaries
|
||||
- Aggressive cleanup
|
||||
|
||||
### Phase 6: Packaging
|
||||
- Creates initramfs.cpio.xz with XZ compression
|
||||
- Builds kernel with embedded initramfs
|
||||
- Generates vmlinuz.efi
|
||||
- Optionally uploads to S3
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
### Download Artifacts to Local Machine
|
||||
|
||||
Add this to your script after the build completes:
|
||||
|
||||
```v
|
||||
// Download artifacts to local machine
|
||||
download_artifacts(mut node, '/tmp/zos-artifacts') or {
|
||||
eprintln('Failed to download artifacts: ${err}')
|
||||
}
|
||||
```
|
||||
|
||||
### Custom Build Configuration
|
||||
|
||||
You can modify the build by editing files on the remote machine before building:
|
||||
|
||||
```v
|
||||
// After cloning, before building
|
||||
node.file_write('${build_dir}/config/packages.list', 'your custom packages')!
|
||||
```
|
||||
|
||||
### Rebuild Without Re-cloning
|
||||
|
||||
To rebuild without re-cloning the repository, modify the script to skip the clone step:
|
||||
|
||||
```v
|
||||
// Comment out the clone_repository call
|
||||
// clone_repository(mut node)!
|
||||
|
||||
// Or just run the build directly
|
||||
node.exec_cmd(
|
||||
cmd: 'cd ${build_dir} && ./scripts/build.sh'
|
||||
name: 'zos_rebuild'
|
||||
)!
|
||||
```
|
||||
|
||||
## Testing the Build
|
||||
|
||||
After building, you can test the kernel with QEMU:
|
||||
|
||||
```bash
|
||||
# On the remote machine
|
||||
cd /root/zosbuilder
|
||||
./scripts/test-qemu.sh
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Build Fails
|
||||
|
||||
1. Check the build output for specific errors
|
||||
2. Verify all prerequisites are installed
|
||||
3. Ensure sufficient disk space (at least 5GB)
|
||||
4. Check internet connectivity for downloading components
|
||||
|
||||
### SSH Connection Issues
|
||||
|
||||
1. Verify SSH access: `ssh root@195.192.213.2`
|
||||
2. Check SSH key authentication is set up
|
||||
3. Verify the remote host and port are correct
|
||||
|
||||
### Missing Dependencies
|
||||
|
||||
The script automatically installs dependencies, but if manual installation is needed:
|
||||
|
||||
**Ubuntu/Debian:**
|
||||
```bash
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y build-essential rustc cargo upx-ucl binutils git wget qemu-system-x86 podman musl-tools
|
||||
rustup target add x86_64-unknown-linux-musl
|
||||
```
|
||||
|
||||
**Alpine Linux:**
|
||||
```bash
|
||||
apk add --no-cache build-base rust cargo upx git wget qemu-system-x86 podman
|
||||
rustup target add x86_64-unknown-linux-musl
|
||||
```
|
||||
|
||||
## Integration with CI/CD
|
||||
|
||||
This builder can be integrated into CI/CD pipelines:
|
||||
|
||||
```v
|
||||
// Example: Build and upload to artifact storage
|
||||
fn ci_build() ! {
|
||||
mut b := builder.new()!
|
||||
mut node := b.node_new(ipaddr: '${ci_builder_host}')!
|
||||
|
||||
build_zos(mut node)!
|
||||
|
||||
// Upload to artifact storage
|
||||
node.exec_cmd(
|
||||
cmd: 's3cmd put ${build_dir}/dist/* s3://artifacts/zos/'
|
||||
name: 'upload_artifacts'
|
||||
)!
|
||||
}
|
||||
```
|
||||
|
||||
## Related Examples
|
||||
|
||||
- `simple.vsh` - Basic builder usage
|
||||
- `remote_executor/` - Remote code execution
|
||||
- `simple_ip4.vsh` - IPv4 connection example
|
||||
- `simple_ip6.vsh` - IPv6 connection example
|
||||
|
||||
## References
|
||||
|
||||
- [zosbuilder Repository](https://git.ourworld.tf/tfgrid/zosbuilder)
|
||||
- [herolib Builder Documentation](../../lib/builder/readme.md)
|
||||
- [Zero OS Documentation](https://manual.grid.tf/)
|
||||
|
||||
## License
|
||||
|
||||
This example follows the same license as herolib.
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -n -w -g -cg -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.core.playcmds
|
||||
import freeflowuniverse.herolib.clients.giteaclient
|
||||
import incubaid.herolib.core.playcmds
|
||||
import incubaid.herolib.clients.giteaclient
|
||||
|
||||
heroscript := "
|
||||
!!giteaclient.configure
|
||||
|
||||
@@ -1,50 +0,0 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.clients.jina
|
||||
import os
|
||||
import json
|
||||
|
||||
fn main() {
|
||||
// Initialize Jina client
|
||||
mut j := jina.Jina{
|
||||
name: 'test_client'
|
||||
secret: os.getenv('JINAKEY')
|
||||
}
|
||||
|
||||
// Initialize the client
|
||||
j = jina.obj_init(j) or {
|
||||
println('Error initializing Jina client: ${err}')
|
||||
return
|
||||
}
|
||||
|
||||
// Check if authentication works
|
||||
auth_ok := j.check_auth() or {
|
||||
println('Authentication failed: ${err}')
|
||||
return
|
||||
}
|
||||
|
||||
println('Authentication successful: ${auth_ok}')
|
||||
|
||||
// Create embeddings
|
||||
model := 'jina-embeddings-v2-base-en'
|
||||
input := ['Hello world', 'This is a test']
|
||||
|
||||
embeddings := j.create_embeddings(input, model, 'search') or {
|
||||
println('Error creating embeddings: ${err}')
|
||||
return
|
||||
}
|
||||
|
||||
println('Embeddings created successfully!')
|
||||
println('Model: ${embeddings.model}')
|
||||
println('Dimension: ${embeddings.dimension}')
|
||||
println('Number of embeddings: ${embeddings.data.len}')
|
||||
|
||||
// If there are embeddings, print the first one (truncated)
|
||||
if embeddings.data.len > 0 {
|
||||
first_embedding := embeddings.data[0]
|
||||
println('First embedding (first 5 values): ${first_embedding.embedding[0..5]}')
|
||||
}
|
||||
|
||||
// Usage information
|
||||
println('Token usage: ${embeddings.usage.total_tokens} ${embeddings.usage.unit}')
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.clients.mailclient
|
||||
import incubaid.herolib.clients.mailclient
|
||||
|
||||
// remove the previous one, otherwise the env variables are not read
|
||||
mailclient.config_delete(name: 'test')!
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.clients.mycelium
|
||||
import freeflowuniverse.herolib.installers.net.mycelium_installer
|
||||
import incubaid.herolib.clients.mycelium
|
||||
import incubaid.herolib.installers.net.mycelium_installer
|
||||
import time
|
||||
import os
|
||||
import encoding.base64
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
// Mycelium RPC Client Example
|
||||
// This example demonstrates how to use the new Mycelium JSON-RPC client
|
||||
// to interact with a Mycelium node's admin API
|
||||
import freeflowuniverse.herolib.clients.mycelium_rpc
|
||||
import freeflowuniverse.herolib.installers.net.mycelium_installer
|
||||
import incubaid.herolib.clients.mycelium_rpc
|
||||
import incubaid.herolib.installers.net.mycelium_installer
|
||||
import time
|
||||
import os
|
||||
import encoding.base64
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env -S v -n -w -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import freeflowuniverse.herolib.core
|
||||
import freeflowuniverse.herolib.clients.postgresql_client
|
||||
import incubaid.herolib.core
|
||||
import incubaid.herolib.clients.postgresql_client
|
||||
|
||||
// Configure PostgreSQL client
|
||||
heroscript := "
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user