sails-hook-slipway 0.0.0

package/README.md

@@ -0,0 +1,109 @@
+# sails-hook-slipway
+
+> The Sails hook that makes your app Slipway-aware
+
+## What It Does
+
+This hook transforms any Sails app into a fully-managed application with:
+
+- **The Bridge** - Auto-generated CRUD for all your models (ship's command center)
+- **The Helm** - Production REPL with full Sails context (where you steer your app)
+- **Quest Dashboard** - Job queue management (if sails-quest installed)
+- **Content CMS** - Visual content editor (if sails-content installed)
+- **Telemetry** - OpenTelemetry instrumentation sent to Slipway
+
+## Routes
+
+| Route | Feature | Condition |
+|-------|---------|-----------|
+| `/slipway` | Control panel dashboard | Always |
+| `/slipway/bridge` | The Bridge (data management) | Always |
+| `/slipway/helm` | The Helm (REPL) | Always |
+| `/slipway/quest` | Job queue dashboard | If sails-quest detected |
+| `/slipway/content` | CMS interface | If sails-content detected |
+
+## Two Access Methods
+
+### 1. Direct (via app URL)
+```
+myapp.example.com/slipway/bridge
+myapp.example.com/slipway/helm
+```
+Users go directly to your app's Bridge or Helm.
+
+### 2. Via Slipway Dashboard (centralized)
+```
+slipway.yourdomain.com/app/myapp/bridge
+slipway.yourdomain.com/app/myapp/helm
+```
+The Slipway Dashboard proxies requests, providing single sign-on across all apps.
+
+## Installation
+
+```bash
+npm install sails-hook-slipway
+```
+
+The hook auto-registers with Sails.
+
+## Configuration
+
+```javascript
+// config/slipway.js
+module.exports.slipway = {
+  bridge: {
+    enabled: true,
+    path: '/slipway/bridge'
+  },
+  helm: {
+    enabled: true,
+    path: '/slipway/helm',
+    readOnly: false  // Set true in production
+  },
+  quest: {
+    enabled: true    // Auto-disabled if sails-quest not installed
+  },
+  content: {
+    enabled: true    // Auto-disabled if sails-content not installed
+  },
+  telemetry: {
+    enabled: true,
+    endpoint: process.env.SLIPWAY_TELEMETRY_URL
+  }
+}
+```
+
+## Permissions (Sails Clearance)
+
+The hook integrates with Sails Clearance for fine-grained access control:
+
+```javascript
+{
+  'bridge:read': ['admin', 'support'],
+  'bridge:write': ['admin'],
+  'helm:access': ['admin', 'developer'],
+  'quest:retry': ['admin', 'developer'],
+  'content:publish': ['admin', 'editor']
+}
+```
+
+## Dev Mode
+
+When you run `slipway dev`, this hook provides the full experience locally:
+
+```bash
+slipway dev
+
+  App:      http://localhost:1337
+  Bridge:   http://localhost:1337/slipway/bridge
+  Helm:     http://localhost:1337/slipway/helm
+```
+
+## Part of the Slipway Suite
+
+- **Slipway Dashboard** - Can proxy to this hook's routes
+- **slipway CLI** - `slipway helm` connects to this hook
+
+---
+
+*Where your apps slide into production.*

package/index.js

@@ -0,0 +1,101 @@
+/**
+ * sails-hook-slipway
+ *
+ * Provides admin panel, console (REPL), and telemetry for Sails apps
+ * deployed with Slipway.
+ */
+
+module.exports = function defineSlipwayHook(sails) {
+  return {
+    defaults: {
+      slipway: {
+        // Enable/disable features
+        admin: {
+          enabled: true,
+          path: '/_slipway/admin'
+        },
+        console: {
+          enabled: true,
+          path: '/_slipway/console'
+        },
+        telemetry: {
+          enabled: true,
+          endpoint: process.env.SLIPWAY_TELEMETRY_URL || null
+        }
+      }
+    },
+
+    configure: function () {
+      // Expose slipway config
+      sails.config.slipway = sails.config.slipway || {}
+    },
+
+    initialize: async function () {
+      const config = sails.config.slipway
+
+      sails.log.info('sails-hook-slipway: Initializing...')
+
+      // Initialize telemetry if configured
+      if (config.telemetry.enabled && config.telemetry.endpoint) {
+        await this.initTelemetry(config.telemetry)
+      }
+
+      sails.log.info('sails-hook-slipway: Ready')
+    },
+
+    initTelemetry: async function (telemetryConfig) {
+      try {
+        // OpenTelemetry setup will go here
+        sails.log.verbose('sails-hook-slipway: Telemetry initialized')
+      } catch (err) {
+        sails.log.warn('sails-hook-slipway: Failed to initialize telemetry:', err.message)
+      }
+    },
+
+    routes: {
+      before: {
+        // Admin panel
+        'GET /_slipway/admin': function (req, res, next) {
+          if (!sails.config.slipway.admin.enabled) {
+            return next()
+          }
+          // TODO: Render admin panel
+          res.json({ message: 'Slipway Admin Panel - Coming Soon' })
+        },
+
+        // Console (REPL)
+        'GET /_slipway/console': function (req, res, next) {
+          if (!sails.config.slipway.console.enabled) {
+            return next()
+          }
+          // TODO: Render console
+          res.json({ message: 'Slipway Console - Coming Soon' })
+        },
+
+        // Health check for Slipway
+        'GET /_slipway/health': function (req, res) {
+          res.json({
+            status: 'ok',
+            sails: sails.config.environment,
+            uptime: process.uptime()
+          })
+        },
+
+        // Models list (for admin panel)
+        'GET /_slipway/api/models': function (req, res, next) {
+          if (!sails.config.slipway.admin.enabled) {
+            return next()
+          }
+
+          const models = Object.keys(sails.models).map(identity => ({
+            identity,
+            globalId: sails.models[identity].globalId,
+            attributes: Object.keys(sails.models[identity].attributes)
+          }))
+
+          res.json({ models })
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "sails-hook-slipway",
+  "version": "0.0.0",
+  "description": "Sails hook for Slipway - admin panel, console, and telemetry",
+  "keywords": ["sails", "hook", "admin", "slipway"],
+  "main": "index.js",
+  "sails": {
+    "isHook": true,
+    "hookName": "slipway"
+  },
+  "scripts": {
+    "test": "echo \"TODO: add tests\""
+  },
+  "dependencies": {},
+  "peerDependencies": {
+    "sails": "^1.5.0"
+  },
+  "peerDependenciesMeta": {
+    "sails-quest": {
+      "optional": true
+    },
+    "sails-content": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=18.0"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sailscastshq/slipway.git",
+    "directory": "packages/hook"
+  }
+}