wiki-plugin-allyabase 0.0.2 → 0.0.3

package/README.md

@@ -1,165 +1,143 @@
-# Federated Wiki - allyabase plugin
+# wiki-plugin-allyabase
 
-allyabase is a Backend as a Service (BaaS) similar to Firebase and Supabase except it is open, and interoperable with other systems that utilize the [Sessionless] protocol. 
-allyabase has many features, but the few that are exposed at this time in wiki are enable the signing of smart contracts, and the subsequent creation and/or transfer of nineum tokens upon completed parameters from the contracts. 
-To facilitate this, the plugin exposes the following routes to the client:
+Allyabase management plugin for Federated Wiki.
 
-<details>
- <summary><code>GET</code> <code><b>/plugin/allyabase/user/:pubKey</b></code> <code>Gets an existing user by public key</code></summary>
+This plugin provides a convenient interface for launching and monitoring your local Allyabase instance directly from the wiki.
 
-##### Parameters
+## Features
 
-> | name         |  required     | data type               | description                                                           |
-> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
-> | pubKey       |  true     | string (hex)            | the publicKey of the user's keypair  |
+- **Launch a Base**: One-click button to run the allyabase_setup.sh script
+- **Service Healthcheck**: Real-time monitoring of all 14 miniservices
+- **Auto-refresh**: Status updates every 30 seconds
+- **Service Details**: Shows port and HTTP status for each service
+- **Federated Emojishortcodes**: Decentralized resource discovery using emoji-based identifiers (see [FEDERATION.md](./FEDERATION.md))
+- **Federated BDO Resolution**: Cross-wiki BDO (Basic Data Object) fetching using emoji-based identifiers
 
+## Services Monitored
 
-##### Responses
+The plugin monitors the following services:
 
-> | http code     | content-type                      | response                                                            |
-> |---------------|-----------------------------------|---------------------------------------------------------------------|
-> | `200`         | `application/json`                | `USER`   |
-> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
+- julia (port 3000)
+- continuebee (port 2999)
+- fount (port 3002)
+- bdo (port 3003)
+- joan (port 3004)
+- addie (port 3005)
+- pref (port 3006)
+- dolores (port 3007)
+- prof (port 3008)
+- covenant (port 3011)
+- minnie (port 2525)
+- aretha (port 7277)
+- sanora (port 7243)
+- wiki (port 3333)
 
-</details>
+## Installation
 
-<details>
- <summary><code>GET</code> <code><b>/plugin/allyabase/bdo</b></code> <code>Gets the user's BDO</code></summary>
+```bash
+npm install wiki-plugin-allyabase
+```
 
-##### Parameters
+## Configuration
 
-> | name         |  required     | data type               | description                                                           |
-> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
-> | pubKey       |  true     | string (hex)            | the publicKey of the user's keypair  |
+The plugin includes the `allyabase_setup.sh` script bundled within the package, so no external dependencies are required. The script will be run from the plugin's installation directory.
 
+## Usage
 
-##### Responses
+Add the plugin to your wiki page by creating an `allyabase` item. The plugin will display:
 
-> | http code     | content-type                      | response                                                            |
-> |---------------|-----------------------------------|---------------------------------------------------------------------|
-> | `200`         | `application/json`                | `USER`   |
-> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
+1. A "Launch a Base" button to start all services
+2. A status panel showing which services are running
+3. Automatic health checks with visual indicators (✅/❌)
 
-</details>
+## API Endpoints
 
-<details>
- <summary><code>PUT</code> <code><b>/plugin/allyabase/bdo</b></code> <code>Puts a new bdo or updates the bdo for the user</code></summary>
+### Allyabase Management
 
-##### Parameters
+#### POST /plugin/allyabase/launch
+Launches the allyabase setup script.
 
-> | name         |  required     | data type               | description                                                           |
-> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
-> | pubKey       |  true     | string (hex)            | the publicKey of the user's keypair  |
-> | bdo          |  true     | object                  | the signature from sessionless for the message  |
+#### GET /plugin/allyabase/healthcheck
+Returns the current health status of all services.
 
+#### GET /plugin/allyabase/status
+Returns the overall base status including last launch time.
 
-##### Responses
+### Service Proxies
 
-> | http code     | content-type                      | response                                                            |
-> |---------------|-----------------------------------|---------------------------------------------------------------------|
-> | `200`         | `application/json`                | `USER`   |
-> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
+All allyabase services are accessible via proxy routes:
 
-</details>
+- `/plugin/allyabase/julia/*` → julia service
+- `/plugin/allyabase/bdo/*` → bdo service
+- `/plugin/allyabase/fount/*` → fount service
+- (and so on for all 14 services)
 
-<details>
- <summary><code>POST</code> <code><b>/plugin/allyabase/grant-nineum</b></code> <code>grants a nineum to a user. Requires the wiki owner to have an admin or galactic nineum</code></summary>
+### Federated BDO Endpoints
 
-##### Parameters
+#### GET /plugin/allyabase/bdo/emoji/:emojicode
 
-> | name         |  required     | data type               | description                                                           |
-> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
-> | toUUID       |  true     | string (hex)            | the uuid of the user to grant the nineum  |
-> | flavor       |  true     | string (hex)            | the flavor of nineum to grant |
+Fetch a BDO by its emojicode, with automatic federation support.
 
+**Emojicode Format**: `💚[3-location-emoji][5-uuid-emoji]`
 
-##### Responses
+Example: `💚☮️🌙🎸🔔🔫🕕🕓🚅`
 
-> | http code     | content-type                      | response                                                            |
-> |---------------|-----------------------------------|---------------------------------------------------------------------|
-> | `200`         | `application/json`                | `USER`   |
-> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
+**How it works:**
 
-</details>
+1. Extracts the 9 emoji from the emojicode
+2. First emoji (💚) is the federation prefix
+3. Next 3 emoji identify the wiki location (e.g., ☮️🌙🎸)
+4. Remaining 5 emoji identify the BDO UUID
+5. Looks up the location identifier in the federation registry
+6. If the BDO is on this wiki, fetches locally
+7. If the BDO is on a remote wiki, forwards the request automatically
 
-<details>
- <summary><code>POST</code> <code><b>/plugin/allyabase/grant-admin-nineum</b></code> <code>grants an admin nineum to a user</code></summary>
+**Response:**
+```json
+{
+  "emojicode": "💚☮️🌙🎸🔔🔫🕕🕓🚅",
+  "pubKey": "029dd60e726cbcc00fc486e158751d290172cc92733a3be4a5d18a2ef07e097f73",
+  "bdo": {
+    "data": "Test BDO data",
+    "timestamp": 1761676196398
+  },
+  "createdAt": 1761676196526
+}
+```
 
-##### Parameters
+**Key Features:**
+- Automatic cross-wiki resolution
+- Location-based routing using emoji identifiers
+- Transparent local vs. remote detection
+- Compatible with Docker networking (host.docker.internal)
 
-> | name         |  required     | data type               | description                                                           |
-> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
-> | toUUID       |  true     | string (hex)            | the uuid of the user to grant the nineum  |
+### Federation
 
-##### Responses
+The plugin includes a federated emojishortcode system for decentralized resource discovery. See [FEDERATION.md](./FEDERATION.md) for complete documentation.
 
-> | http code     | content-type                      | response                                                            |
-> |---------------|-----------------------------------|---------------------------------------------------------------------|
-> | `200`         | `application/json`                | `USER`   |
-> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
+#### POST /plugin/allyabase/federation/register
+Register a location identifier for this wiki.
 
-</details>
+#### GET /plugin/allyabase/federation/location/:identifier
+Get the URL for a specific location identifier.
 
-<details>
- <summary><code>POST</code> <code><b>/plugin/allyabase/transfer</b></code> <code>transfer nineum to another user</code></summary>
+#### GET /plugin/allyabase/federation/locations
+Get all registered location mappings.
 
-##### Parameters
+#### POST /plugin/allyabase/federation/resolve
+Resolve a federated shortcode to a full URL.
 
-> | name         |  required     | data type               | description                                                           |
-> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
-> | toUUID       |  true     | string (hex)            | the uuid of the user to grant the nineum  |
-> | nineum       |  true     | array of nineum hex strings | the nineum to transfer |
+#### POST /plugin/allyabase/federation/parse
+Parse a federated shortcode without resolving it.
 
-##### Responses
+## Development
 
-> | http code     | content-type                      | response                                                            |
-> |---------------|-----------------------------------|---------------------------------------------------------------------|
-> | `200`         | `application/json`                | `USER`   |
-> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
+This plugin follows the standard wiki-plugin structure:
 
-</details>
-
-<details>
- <summary><code>GET</code> <code><b>/plugin/allyabase/sign/:thing</b></code> <code>creates a signature from the thing to sign</code></summary>
-
-##### Parameters
-
-> | name         |  required     | data type               | description                                                           |
-> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
-> | thing        |  true     | string                  | the uuid of the user to grant the nineum  |
-
-##### Responses
-
-> | http code     | content-type                      | response                                                            |
-> |---------------|-----------------------------------|---------------------------------------------------------------------|
-> | `200`         | `application/json`                | `{signature: <signature>}`   |
-> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
-
-</details>
-
-<details>
- <summary><code>GET</code> <code><b>/plugin/allyabase/verify</b></code> <code>verifies a signature</code></summary>
-
-##### Parameters
-
-> | name         |  required     | data type               | description                                                           |
-> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
-> | signature    |  true     | string (hex)            | the signature to verify  |
-> | message      |  true     | string                  | the message to check |
-
-##### Responses
-
-> | http code     | content-type                      | response                                                            |
-> |---------------|-----------------------------------|---------------------------------------------------------------------|
-> | `200`         | `application/json`                | `USER`   |
-> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`
-|
-
-</details>
+- `client/allyabase.js` - Client-side code for the wiki interface
+- `server/server.js` - Server-side endpoints for launching and monitoring
+- `factory.json` - Plugin metadata
 
 ## License
 
 MIT
-
-[Sessionless]: https://github.com/planet-nine-app/sessionless
-

package/allyabase_setup.sh

@@ -0,0 +1,169 @@
+#!/bin/bash
+
+set -e
+
+tmpDir="${TMPDIR:-${XDG_RUNTIME_DIR:-/tmp}}"
+buildDir="${1:-$tmpDir}"
+[[ $buildDir != /* ]]&& buildDir="${PWD%/}/$buildDir"
+buildDir="${buildDir#./}/allyabase"
+ecosystem_config='ecosystem.config.js'
+services=(
+    'addie'
+    'aretha'
+    'bdo'
+    'continuebee'
+    'covenant'
+    'dolores'
+    'fount'
+    'joan'
+    'julia'
+    'minnie'
+    'pref'
+    'prof'
+    'sanora'
+)
+
+setup_services() {
+    # Remove existing directory if it exists to ensure clean setup
+    if [ -d "$buildDir" ]; then
+        echo "Removing existing allyabase directory..."
+        rm -rf "$buildDir"
+    fi
+
+    mkdir -p "$buildDir" && cd "$buildDir"
+
+    # Configure git for better performance and reliability in containers
+    git config --global http.postBuffer 524288000  # 500MB buffer
+    git config --global http.lowSpeedLimit 0
+    git config --global http.lowSpeedTime 999999
+
+    for service in "${services[@]}"; do
+        echo "Cloning '$service'..."
+        # Use shallow clone to reduce data transfer and retry on failure
+        if ! git clone --depth 1 "https://github.com/planet-nine-app/$service"; then
+            echo "First attempt failed, retrying with full clone..."
+            if ! git clone "https://github.com/planet-nine-app/$service"; then
+                echo "ERROR: Failed to clone $service after retry"
+                exit 1
+            fi
+        fi
+
+        printf '%s\n' "Installing '$service'..."
+        npm install "$service/src/server/node"
+    done
+
+    # Add logging to BDO service to debug request handling
+    echo "Adding debug logging to BDO service..."
+
+    # Find the PUT /user/create endpoint and add logging at the start
+    sed -i.bak "/app.put.*user\/create/,/^app\./ {
+        /^app\.put/a\\
+console.log('[BDO] Received PUT /user/create request');\
+console.log('[BDO] Headers:', JSON.stringify(req.headers, null, 2));\
+console.log('[BDO] Body:', JSON.stringify(req.body, null, 2));
+    }" bdo/src/server/node/bdo.js
+
+    echo "✓ Added logging to BDO service"
+
+} # setup_services
+
+setup_ecosystem() {
+    if [[ ! -f "package.json" || ! -f "package-lock.json" ]]; then
+        echo "Initializing npm in this directory..."
+        npm init -y
+    else
+        echo "Both package.json and package-lock.json are already present. Skipping initialization."
+    fi
+
+    npm install pm2-runtime
+
+    # Try to read location emoji and federation emoji from wiki's owner.json
+    LOCATION_EMOJI=""
+    FEDERATION_EMOJI=""
+    OWNER_JSON="${HOME}/.wiki/status/owner.json"
+    if [[ -f "$OWNER_JSON" ]]; then
+        # Try to extract locationEmoji and federationEmoji using node
+        read -r LOCATION_EMOJI FEDERATION_EMOJI < <(node -e "
+            try {
+                const owner = require('$OWNER_JSON');
+                const location = owner.locationEmoji || '';
+                const federation = owner.federationEmoji || '';
+                console.log(location + ' ' + federation);
+            } catch (e) {
+                console.log(' ');
+            }
+        " 2>/dev/null || echo " ")
+
+        if [[ -n "$LOCATION_EMOJI" ]]; then
+            echo "Found location emoji: $LOCATION_EMOJI"
+        fi
+        if [[ -n "$FEDERATION_EMOJI" ]]; then
+            echo "Found federation emoji: $FEDERATION_EMOJI"
+        fi
+    fi
+
+    printf '%s\n' \
+        'module.exports = {' \
+        '  apps: [' >>"$ecosystem_config"
+
+    # Port mapping for each service (using defaults from original repos)
+    declare -A service_ports=(
+        [julia]=3000
+        [continuebee]=2999
+        [fount]=3002
+        [bdo]=3003
+        [joan]=3004
+        [addie]=3005
+        [pref]=3006
+        [dolores]=3007
+        [prof]=3008
+        [covenant]=3011
+        [minnie]=2525
+        [aretha]=7277
+        [sanora]=7243
+    )
+
+    for service in "${services[@]}"; do
+        port="${service_ports[$service]}"
+
+        if [[ $service == 'addie' ]]; then
+            env="{
+                LOCALHOST: 'true',
+                PORT: '$port',
+                STRIPE_KEY: '<api key here>',
+                STRIPE_PUBLISHING_KEY: '<publishing key here>',
+                SQUARE_KEY: '<api key here>'
+            }"
+        elif [[ $service == 'bdo' && -n "$LOCATION_EMOJI" && -n "$FEDERATION_EMOJI" ]]; then
+            # Pass location emoji and federation emoji to BDO service
+            env="{
+                LOCALHOST: 'true',
+                PORT: '$port',
+                BDO_BASE_EMOJI: '$LOCATION_EMOJI',
+                BDO_FEDERATION_EMOJI: '$FEDERATION_EMOJI'
+            }"
+        else
+            env="{
+                LOCALHOST: 'true',
+                PORT: '$port'
+            }"
+        fi
+
+        printf '%s\n' \
+            "    {" \
+            "      name: '$service'," \
+            "      script: '$buildDir/$service/src/server/node/${service}.js'," \
+            "      env: $env" \
+            "    }," >>"$ecosystem_config"
+    done
+
+    printf '%s\n' '    ]' \
+        '}' >>"$ecosystem_config"
+} # setup_ecosystem
+
+main() {
+    setup_services
+    setup_ecosystem
+    
+    ./node_modules/.bin/pm2-runtime start ecosystem.config.js
+}; main