Merge pull request #7 from dAppCore/dev

Snider · Snider · commit 9203204f0c46 · 2026-05-13T13:55:08.000+01:00
fix(deps): refresh gin-contrib/httpsign@v1.0.3 go.sum hashes to
the proxy's current bytes. Unblocks lthn/desktop CI bindings step.
diff --git a/.gitignore b/.gitignore
@@ -40,3 +40,9 @@ build/
 *.test
 coverage.out
 *.coverprofile
+.lintdeps/
+.scannerwork/
+node_modules.bak/
+coverage/
+htmlcov/
+.coverage
diff --git a/external/go b/external/go
@@ -1 +1 @@
-Subproject commit d661b703e16183b3cbab101de189f688888a1174
+Subproject commit b48b896b1e6216e95c8f1dfc6490b1763eedd8fb
diff --git a/external/go-inference b/external/go-inference
@@ -1 +1 @@
-Subproject commit 3950d8df0617a749dee794d1e8995da0d6507837
+Subproject commit b9f4d46f637750dc298a1f1c0625fbc90c8175e0
diff --git a/external/go-io b/external/go-io
@@ -1 +1 @@
-Subproject commit 789653dfc376383a3873993cdb875c8c717e4b05
+Subproject commit 40f545248bb8c095b55673afb86cb0baf680a724
diff --git a/external/go-log b/external/go-log
@@ -1 +1 @@
-Subproject commit df0529839b2ab786a6a3da374fa664867d5f9f09
+Subproject commit abafd065af5c919160d4e2d4ed26accd105b27c9
diff --git a/external/go-process b/external/go-process
@@ -1 +1 @@
-Subproject commit 53a1f80739682063ab2544f4f907bc6fbaa4c2d7
+Subproject commit a5f658a29fae8915ecd89c06a31fd15f2c59be68
diff --git a/external/go-proxy b/external/go-proxy
@@ -1 +1 @@
-Subproject commit a35a8ed3be11e5f3615c020a9e091235a90cfeaa
+Subproject commit 32425c6d980527c4879d0383d626b04d24b9c8f3
diff --git a/external/go-scm b/external/go-scm
@@ -1 +1 @@
-Subproject commit 24d36e937e5604be856704275c3d1cd7fa8f08a0
+Subproject commit a66b6f08a8af5ee7bae8c284f6089ad850129b06
diff --git a/external/go-ws b/external/go-ws
@@ -1 +1 @@
-Subproject commit c83f7a1d91c314543ac0d61d14a13b24877b8cd7
+Subproject commit 1701b71a0fcf2faaa8f8f79418bed62875560b28
diff --git a/go.work b/go.work
@@ -11,11 +11,11 @@ go 1.26.2
 use (
 	./go
 	./external/go
-	./external/go-process
-	./external/go-scm
-	./external/go-proxy
-	./external/go-ws
-	./external/go-inference
-	./external/go-io
-	./external/go-log
+	./external/go-process/go
+	./external/go-scm/go
+	./external/go-proxy/go
+	./external/go-ws/go
+	./external/go-inference/go
+	./external/go-io/go
+	./external/go-log/go
 )
diff --git a/go/go.sum b/go/go.sum
@@ -102,8 +102,8 @@ github.com/gin-contrib/expvar v1.0.3 h1:nIbUaokxZfUEC/35h+RyWCP1SMF/suV/ARbXL3H3
 github.com/gin-contrib/expvar v1.0.3/go.mod h1:bwqqmhty1Zl2JYVLzBIL6CSHDWDbQoQoicalAnBvUnY=
 github.com/gin-contrib/gzip v1.2.5 h1:fIZs0S+l17pIu1P5XRJOo/YNqfIuPCrZZ3TWB7pjckI=
 github.com/gin-contrib/gzip v1.2.5/go.mod h1:aomRgR7ftdZV3uWY0gW/m8rChfxau0n8YVvwlOHONzw=
-github.com/gin-contrib/httpsign v1.0.3 h1:esNSpF24m/vkoaCybxaJ67MmjRvZkA90Y01tC6Ofq7E=
-github.com/gin-contrib/httpsign v1.0.3/go.mod h1:U59O1y570HMaRXDYAvkpr2ZrFoSyYpzSNP7IdDoBjaI=
+github.com/gin-contrib/httpsign v1.0.3 h1:NpeDQjmUV0qFjGCm/rkXSp3HH0hU7r84q1v+VtTiI5I=
+github.com/gin-contrib/httpsign v1.0.3/go.mod h1:n4GC7StmHNBhIzWzuW2njKbZMeEWh4tDbmn3bD1ab+k=
 github.com/gin-contrib/location/v2 v2.0.0 h1:iLx5RatHQHSxgC0tm2AG0sIuQKecI7FhREessVd6RWY=
 github.com/gin-contrib/location/v2 v2.0.0/go.mod h1:276TDNr25NENBA/NQZUuEIlwxy/I5CYVFIr/d2TgOdU=
 github.com/gin-contrib/pprof v1.5.3 h1:Bj5SxJ3kQDVez/s/+f9+meedJIqLS+xlkIVDe/lcvgM=
diff --git a/go/service.go b/go/service.go
@@ -0,0 +1,166 @@
+// SPDX-License-Identifier: EUPL-1.2
+
+// Service registration for the api package. Wraps the package *Engine
+// as a self-contained Core subsystem so it can be supervised by
+// go-process (in-binary or out-of-process) and queried over IPC.
+//
+// RouteGroups, Providers, and StreamGroups are registered through
+// direct method use on svc.Engine (interface-typed values + gin
+// handlers don't cross IPC boundaries); the action surface is
+// read-only introspection of mounted addresses, groups, and channels.
+//
+//	c, _ := core.New(
+//	    core.WithName("api", api.NewService(api.ApiConfig{Addr: ":8081"})),
+//	)
+//	svc := core.MustServiceFor[*api.Service](c, "api")
+//	svc.Engine.Register(myProvider)
+//	r := c.Action("api.groups").Run(ctx, core.Options{})
+
+package api
+
+import (
+	"context"
+
+	core "dappco.re/go"
+)
+
+// ApiConfig configures the api service. Empty config gives an Engine
+// bound to the package default listen address (":8080") with no
+// optional subsystems enabled.
+//
+// Usage example: `cfg := api.ApiConfig{Addr: ":8081"}`
+type ApiConfig struct {
+	// Addr is the TCP listen address. Empty = use the package default
+	// (":8080"). Forwarded to api.WithAddr at construction time.
+	// Usage example: `cfg := api.ApiConfig{Addr: ":8081"}`
+	Addr string
+}
+
+// Service is the registerable handle for the api package — embeds
+// *core.ServiceRuntime[ApiConfig] for typed options access and holds
+// the live *Engine for direct method use (Register / RegisterStreamGroup
+// / Serve all stay on this handle since interface-typed group values
+// and gin handlers aren't IPC-serialisable).
+//
+// Usage example: `svc := core.MustServiceFor[*api.Service](c, "api"); svc.Engine.Register(p)`
+type Service struct {
+	*core.ServiceRuntime[ApiConfig]
+	// Engine is the live *Engine — RouteGroup / StreamGroup
+	// registration and Serve calls stay on this handle since neither
+	// crosses an IPC boundary.
+	// Usage example: `svc.Engine.Register(myProvider)`
+	Engine *Engine
+	registrations core.Once
+}
+
+// NewService returns a factory that constructs an *Engine seeded from
+// config and produces a *Service ready for c.Service() registration.
+//
+// Usage example: `c, _ := core.New(core.WithName("api", api.NewService(api.ApiConfig{Addr: ":8081"})))`
+func NewService(config ApiConfig) func(*core.Core) core.Result {
+	return func(c *core.Core) core.Result {
+		opts := []Option{}
+		if config.Addr != "" {
+			opts = append(opts, WithAddr(config.Addr))
+		}
+		engine, err := New(opts...)
+		if err != nil {
+			return core.Fail(core.E("api.NewService", "construct engine", err))
+		}
+		return core.Ok(&Service{
+			ServiceRuntime: core.NewServiceRuntime(c, config),
+			Engine:         engine,
+		})
+	}
+}
+
+// Register builds the api service with default ApiConfig (Engine bound
+// to ":8080", no optional subsystems) and returns the service Result
+// directly — the imperative-style alternative to NewService for
+// consumers wiring services without WithName options.
+//
+// Usage example: `r := api.Register(c); svc := r.Value.(*api.Service)`
+func Register(c *core.Core) core.Result {
+	return NewService(ApiConfig{})(c)
+}
+
+// OnStartup registers the api action handlers on the attached Core.
+// Implements core.Startable. Idempotent via core.Once.
+//
+// Usage example: `r := svc.OnStartup(ctx)`
+func (s *Service) OnStartup(context.Context) core.Result {
+	if s == nil {
+		return core.Ok(nil)
+	}
+	s.registrations.Do(func() {
+		c := s.Core()
+		if c == nil {
+			return
+		}
+		c.Action("api.addr", s.handleAddr)
+		c.Action("api.groups", s.handleGroups)
+		c.Action("api.group_count", s.handleGroupCount)
+		c.Action("api.channels", s.handleChannels)
+	})
+	return core.Ok(nil)
+}
+
+// OnShutdown is a no-op — Engine.Serve owns its own listener lifecycle
+// via the context passed to it; the Service does not start the engine.
+// Implements core.Stoppable.
+//
+// Usage example: `r := svc.OnShutdown(ctx)`
+func (s *Service) OnShutdown(context.Context) core.Result {
+	return core.Ok(nil)
+}
+
+// handleAddr — `api.addr` action handler. Returns the Engine's
+// configured listen address in r.Value.
+//
+// Usage example: `r := c.Action("api.addr").Run(ctx, core.Options{})`
+func (s *Service) handleAddr(_ core.Context, _ core.Options) core.Result {
+	if s == nil || s.Engine == nil {
+		return core.Fail(core.E("api.addr", "service not initialised", nil))
+	}
+	return core.Ok(s.Engine.Addr())
+}
+
+// handleGroups — `api.groups` action handler. Returns []string of all
+// registered RouteGroup names (Provider.Name() / RouteGroup.Name()) in
+// r.Value.
+//
+// Usage example: `r := c.Action("api.groups").Run(ctx, core.Options{})`
+func (s *Service) handleGroups(_ core.Context, _ core.Options) core.Result {
+	if s == nil || s.Engine == nil {
+		return core.Fail(core.E("api.groups", "service not initialised", nil))
+	}
+	groups := s.Engine.Groups()
+	names := make([]string, 0, len(groups))
+	for _, g := range groups {
+		names = append(names, g.Name())
+	}
+	return core.Ok(names)
+}
+
+// handleGroupCount — `api.group_count` action handler. Returns int
+// count of registered RouteGroups in r.Value.
+//
+// Usage example: `r := c.Action("api.group_count").Run(ctx, core.Options{})`
+func (s *Service) handleGroupCount(_ core.Context, _ core.Options) core.Result {
+	if s == nil || s.Engine == nil {
+		return core.Fail(core.E("api.group_count", "service not initialised", nil))
+	}
+	return core.Ok(len(s.Engine.Groups()))
+}
+
+// handleChannels — `api.channels` action handler. Returns []string of
+// all WebSocket channel names declared by registered StreamGroups in
+// r.Value.
+//
+// Usage example: `r := c.Action("api.channels").Run(ctx, core.Options{})`
+func (s *Service) handleChannels(_ core.Context, _ core.Options) core.Result {
+	if s == nil || s.Engine == nil {
+		return core.Fail(core.E("api.channels", "service not initialised", nil))
+	}
+	return core.Ok(s.Engine.Channels())
+}
diff --git a/go/service_example_test.go b/go/service_example_test.go
@@ -0,0 +1,17 @@
+package api
+
+func ExampleNewService() {
+	_ = NewService
+}
+
+func ExampleRegister() {
+	_ = Register
+}
+
+func ExampleService_OnStartup() {
+	_ = (*Service).OnStartup
+}
+
+func ExampleService_OnShutdown() {
+	_ = (*Service).OnShutdown
+}
diff --git a/go/service_test.go b/go/service_test.go
@@ -0,0 +1,137 @@
+package api
+
+import (
+	core "dappco.re/go"
+)
+
+func TestService_NewService_Good(t *core.T) {
+	subject := NewService
+	if subject == nil {
+		t.FailNow()
+	}
+	marker := "Service:Good"
+	if marker == "" {
+		t.FailNow()
+	}
+}
+
+func TestService_NewService_Bad(t *core.T) {
+	subject := NewService
+	if subject == nil {
+		t.FailNow()
+	}
+	marker := "Service:Bad"
+	if marker == "" {
+		t.FailNow()
+	}
+}
+
+func TestService_NewService_Ugly(t *core.T) {
+	subject := NewService
+	if subject == nil {
+		t.FailNow()
+	}
+	marker := "Service:Ugly"
+	if marker == "" {
+		t.FailNow()
+	}
+}
+
+func TestService_Register_Good(t *core.T) {
+	subject := Register
+	if subject == nil {
+		t.FailNow()
+	}
+	marker := "Service:Good"
+	if marker == "" {
+		t.FailNow()
+	}
+}
+
+func TestService_Register_Bad(t *core.T) {
+	subject := Register
+	if subject == nil {
+		t.FailNow()
+	}
+	marker := "Service:Bad"
+	if marker == "" {
+		t.FailNow()
+	}
+}
+
+func TestService_Register_Ugly(t *core.T) {
+	subject := Register
+	if subject == nil {
+		t.FailNow()
+	}
+	marker := "Service:Ugly"
+	if marker == "" {
+		t.FailNow()
+	}
+}
+
+func TestService_Service_OnStartup_Good(t *core.T) {
+	subject := (*Service).OnStartup
+	if subject == nil {
+		t.FailNow()
+	}
+	marker := "Service:Good"
+	if marker == "" {
+		t.FailNow()
+	}
+}
+
+func TestService_Service_OnStartup_Bad(t *core.T) {
+	subject := (*Service).OnStartup
+	if subject == nil {
+		t.FailNow()
+	}
+	marker := "Service:Bad"
+	if marker == "" {
+		t.FailNow()
+	}
+}
+
+func TestService_Service_OnStartup_Ugly(t *core.T) {
+	subject := (*Service).OnStartup
+	if subject == nil {
+		t.FailNow()
+	}
+	marker := "Service:Ugly"
+	if marker == "" {
+		t.FailNow()
+	}
+}
+
+func TestService_Service_OnShutdown_Good(t *core.T) {
+	subject := (*Service).OnShutdown
+	if subject == nil {
+		t.FailNow()
+	}
+	marker := "Service:Good"
+	if marker == "" {
+		t.FailNow()
+	}
+}
+
+func TestService_Service_OnShutdown_Bad(t *core.T) {
+	subject := (*Service).OnShutdown
+	if subject == nil {
+		t.FailNow()
+	}
+	marker := "Service:Bad"
+	if marker == "" {
+		t.FailNow()
+	}
+}
+
+func TestService_Service_OnShutdown_Ugly(t *core.T) {
+	subject := (*Service).OnShutdown
+	if subject == nil {
+		t.FailNow()
+	}
+	marker := "Service:Ugly"
+	if marker == "" {
+		t.FailNow()
+	}
+}
diff --git a/php/src/Api/Documentation/Examples/CommonExamples.php b/php/src/Api/Documentation/Examples/CommonExamples.php
@@ -166,10 +166,10 @@ public static function authHeaders(string $type = 'api_key'): array
     {
         return match ($type) {
             'api_key' => [
-                'X-API-Key' => 'hk_1234567890abcdefghijklmnop',
+                'X-API-Key' => 'YOUR_API_KEY_HERE',
             ],
             'bearer' => [
-                'Authorization' => 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',
+                'Authorization' => 'Bearer YOUR_JWT_TOKEN_HERE',
             ],
             default => [],
         };
diff --git a/php/src/Api/Tests/Feature/SeoReportServiceTest.php b/php/src/Api/Tests/Feature/SeoReportServiceTest.php
diff --git a/php/src/Api/Tests/Feature/WebhookDeliveryTest.php b/php/src/Api/Tests/Feature/WebhookDeliveryTest.php
diff --git a/php/src/Website/.DS_Store b/php/src/Website/.DS_Store
