refactor: mk dedicated api pkg

.dagger/generate.go

@@ -120,7 +120,7 @@ func (m *Generate) Server() *dagger.Directory {
 
 	return goModule().
 		WithSource(source).
-		Exec([]string{"go", "generate", "-x", "./api"}).
+		Exec([]string{"go", "-C", "api", "generate", "-x", "."}).
 		Directory("/work/src/api")
 }
 

api/client/go/client_test.go

@@ -12,7 +12,7 @@ import (
 	"github.com/samber/lo"
 	"github.com/stretchr/testify/assert"
 
-	"github.com/openmeterio/openmeter/pkg/models"
+	"github.com/openmeterio/openmeter/api/models"
 )
 
 func TestIngest(t *testing.T) {

api/client/go/codegen.yaml

@@ -1,6 +1,9 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/oapi-codegen/oapi-codegen/HEAD/configuration-schema.json
 package: openmeter
 generate:
   client: true
   models: true
   embedded-spec: true
+additional-imports:
+  - package: github.com/openmeterio/openmeter/api/models
 output: ./client.gen.go

api/codegen.yaml

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/oapi-codegen/oapi-codegen/HEAD/configuration-schema.json
 package: api
 generate:
   chi-server: true

api/go.mod

@@ -0,0 +1,39 @@
+module github.com/openmeterio/openmeter/api
+
+go 1.23.1
+
+require (
+	github.com/cloudevents/sdk-go/v2 v2.15.2
+	github.com/getkin/kin-openapi v0.127.0
+	github.com/go-chi/chi/v5 v5.1.0
+	github.com/oapi-codegen/oapi-codegen/v2 v2.4.1
+	github.com/oapi-codegen/runtime v1.1.1
+	github.com/oklog/ulid/v2 v2.1.0
+	github.com/samber/lo v1.47.0
+	github.com/stretchr/testify v1.10.0
+)
+
+require (
+	github.com/apapsch/go-jsonmerge/v2 v2.0.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/dprotaso/go-yit v0.0.0-20220510233725-9ba8df137936 // indirect
+	github.com/go-openapi/jsonpointer v0.21.0 // indirect
+	github.com/go-openapi/swag v0.23.0 // indirect
+	github.com/google/uuid v1.5.0 // indirect
+	github.com/invopop/yaml v0.3.1 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect
+	github.com/perimeterx/marshmallow v1.1.5 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/speakeasy-api/openapi-overlay v0.9.0 // indirect
+	github.com/vmware-labs/yaml-jsonpath v0.3.2 // indirect
+	golang.org/x/mod v0.17.0 // indirect
+	golang.org/x/text v0.18.0 // indirect
+	golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

api/models/error.go

@@ -0,0 +1,11 @@
+package models
+
+import "fmt"
+
+type MeterNotFoundError struct {
+	MeterSlug string
+}
+
+func (e *MeterNotFoundError) Error() string {
+	return fmt.Sprintf("meter not found: %s", e.MeterSlug)
+}

api/openapi.cloud.yaml

@@ -12404,7 +12404,7 @@ components:
           type: $.type
       description: A meter is a configuration that defines how to match and aggregate events.
       x-go-type-import:
-        path: github.com/openmeterio/openmeter/pkg/models
+        path: github.com/openmeterio/openmeter/api/models
       x-go-type: models.Meter
     MeterAggregation:
       type: string
@@ -12417,7 +12417,7 @@ components:
         - MAX
       description: The aggregation type to use for the meter.
       x-go-type-import:
-        path: github.com/openmeterio/openmeter/pkg/models
+        path: github.com/openmeterio/openmeter/api/models
       x-go-type: models.MeterAggregation
     MeterCreate:
       type: object
@@ -12488,7 +12488,7 @@ components:
           type: $.type
       description: A meter is a configuration that defines how to match and aggregate events.
       x-go-type-import:
-        path: github.com/openmeterio/openmeter/pkg/models
+        path: github.com/openmeterio/openmeter/api/models
       x-go-type: models.Meter
     MeterQueryResult:
       type: object
@@ -12559,7 +12559,7 @@ components:
           type: prompt
       description: A row in the result of a meter query.
       x-go-type-import:
-        path: github.com/openmeterio/openmeter/pkg/models
+        path: github.com/openmeterio/openmeter/api/models
       x-go-type: models.MeterQueryRow
     NotFoundProblemResponse:
       type: object
@@ -15337,7 +15337,7 @@ components:
         A Problem Details object (RFC 7807).
         Additional properties specific to the problem type may be present.
       x-go-type-import:
-        path: github.com/openmeterio/openmeter/pkg/models
+        path: github.com/openmeterio/openmeter/api/models
       x-go-type: models.StatusProblem
     UnitPrice:
       type: object
@@ -15594,7 +15594,7 @@ components:
         - DAY
       description: Aggregation window size.
       x-go-type-import:
-        path: github.com/openmeterio/openmeter/pkg/models
+        path: github.com/openmeterio/openmeter/api/models
       x-go-type: models.WindowSize
     WindowedBalanceHistory:
       type: object

api/openapi.yaml

@@ -12106,7 +12106,7 @@ components:
           type: $.type
       description: A meter is a configuration that defines how to match and aggregate events.
       x-go-type-import:
-        path: github.com/openmeterio/openmeter/pkg/models
+        path: github.com/openmeterio/openmeter/api/models
       x-go-type: models.Meter
     MeterAggregation:
       type: string
@@ -12119,7 +12119,7 @@ components:
         - MAX
       description: The aggregation type to use for the meter.
       x-go-type-import:
-        path: github.com/openmeterio/openmeter/pkg/models
+        path: github.com/openmeterio/openmeter/api/models
       x-go-type: models.MeterAggregation
     MeterQueryResult:
       type: object
@@ -12190,7 +12190,7 @@ components:
           type: prompt
       description: A row in the result of a meter query.
       x-go-type-import:
-        path: github.com/openmeterio/openmeter/pkg/models
+        path: github.com/openmeterio/openmeter/api/models
       x-go-type: models.MeterQueryRow
     NotFoundProblemResponse:
       type: object
@@ -15200,7 +15200,7 @@ components:
         A Problem Details object (RFC 7807).
         Additional properties specific to the problem type may be present.
       x-go-type-import:
-        path: github.com/openmeterio/openmeter/pkg/models
+        path: github.com/openmeterio/openmeter/api/models
       x-go-type: models.StatusProblem
     UnitPrice:
       type: object
@@ -15463,7 +15463,7 @@ components:
         - DAY
       description: Aggregation window size.
       x-go-type-import:
-        path: github.com/openmeterio/openmeter/pkg/models
+        path: github.com/openmeterio/openmeter/api/models
       x-go-type: models.WindowSize
     WindowedBalanceHistory:
       type: object

api/spec/src/cloud/main.tsp

@@ -226,7 +226,7 @@ namespace OpenMeterCloud.ProductCatalog {
 @extension(
   "x-go-type-import",
   {
-    path: "github.com/openmeterio/openmeter/pkg/models",
+    path: "github.com/openmeterio/openmeter/api/models",
   }
 )
 @friendlyName("MeterCreate")

api/spec/src/errors.tsp

@@ -15,7 +15,7 @@ namespace OpenMeter;
 @extension(
   "x-go-type-import",
   {
-    path: "github.com/openmeterio/openmeter/pkg/models",
+    path: "github.com/openmeterio/openmeter/api/models",
   }
 )
 @friendlyName("UnexpectedProblemResponse")

api/spec/src/meters.tsp

@@ -84,7 +84,7 @@ interface Meters {
 @extension(
   "x-go-type-import",
   {
-    path: "github.com/openmeterio/openmeter/pkg/models",
+    path: "github.com/openmeterio/openmeter/api/models",
   }
 )
 @friendlyName("Meter")
@@ -163,7 +163,7 @@ model Meter {
 @extension(
   "x-go-type-import",
   {
-    path: "github.com/openmeterio/openmeter/pkg/models",
+    path: "github.com/openmeterio/openmeter/api/models",
   }
 )
 @friendlyName("MeterAggregation")
@@ -184,7 +184,7 @@ enum MeterAggregation {
 @extension(
   "x-go-type-import",
   {
-    path: "github.com/openmeterio/openmeter/pkg/models",
+    path: "github.com/openmeterio/openmeter/api/models",
   }
 )
 @friendlyName("WindowSize")
@@ -289,7 +289,7 @@ model MeterQueryResult {
 @extension(
   "x-go-type-import",
   {
-    path: "github.com/openmeterio/openmeter/pkg/models",
+    path: "github.com/openmeterio/openmeter/api/models",
   }
 )
 @friendlyName("MeterQueryRow")

api/tools.go

@@ -0,0 +1,8 @@
+//go:build tools
+// +build tools
+
+package main
+
+import (
+	_ "github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen"
+)

app/common/meter.go

@@ -4,9 +4,9 @@ import (
 	"github.com/google/wire"
 	"github.com/samber/lo"
 
+	"github.com/openmeterio/openmeter/api/models"
 	"github.com/openmeterio/openmeter/app/config"
 	"github.com/openmeterio/openmeter/openmeter/meter"
-	"github.com/openmeterio/openmeter/pkg/models"
 	"github.com/openmeterio/openmeter/pkg/slicesx"
 )
 

app/config/config.go

@@ -8,8 +8,8 @@ import (
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 
+	"github.com/openmeterio/openmeter/api/models"
 	"github.com/openmeterio/openmeter/pkg/errorsx"
-	"github.com/openmeterio/openmeter/pkg/models"
 )
 
 // Configuration holds any kind of Configuration that comes from the outside world and

e2e/e2e_test.go

@@ -18,9 +18,9 @@ import (
 	"github.com/stretchr/testify/require"
 
 	api "github.com/openmeterio/openmeter/api/client/go"
+	"github.com/openmeterio/openmeter/api/models"
 	"github.com/openmeterio/openmeter/openmeter/testutils"
 	"github.com/openmeterio/openmeter/pkg/convert"
-	"github.com/openmeterio/openmeter/pkg/models"
 )
 
 func TestMain(m *testing.M) {

go.mod

@@ -1,6 +1,10 @@
 module github.com/openmeterio/openmeter
 
-go 1.23.0
+go 1.23.1
+
+require github.com/openmeterio/openmeter/api v1.0.0-beta.187
+
+replace github.com/openmeterio/openmeter/api => ./api
 
 require (
 	entgo.io/ent v0.14.1
@@ -35,7 +39,7 @@ require (
 	github.com/mitchellh/mapstructure v1.5.0
 	github.com/oapi-codegen/nethttp-middleware v1.0.2
 	github.com/oapi-codegen/oapi-codegen/v2 v2.4.1
-	github.com/oapi-codegen/runtime v1.1.1
+	github.com/oapi-codegen/runtime v1.1.1 // indirect
 	github.com/oklog/run v1.1.0
 	github.com/oklog/ulid/v2 v2.1.0
 	github.com/oliveagle/jsonpath v0.0.0-20180606110733-2e52cf6e6852

openmeter/billing/service/lineservice/meters.go

@@ -7,10 +7,10 @@ import (
 
 	"github.com/alpacahq/alpacadecimal"
 
+	"github.com/openmeterio/openmeter/api/models"
 	"github.com/openmeterio/openmeter/openmeter/billing"
 	"github.com/openmeterio/openmeter/openmeter/productcatalog/feature"
 	"github.com/openmeterio/openmeter/openmeter/streaming"
-	"github.com/openmeterio/openmeter/pkg/models"
 )
 
 type getFeatureUsageInput struct {

openmeter/billing/service/lineservice/usagebasedline.go

@@ -8,10 +8,10 @@ import (
 	"github.com/alpacahq/alpacadecimal"
 	"github.com/samber/lo"
 
+	"github.com/openmeterio/openmeter/api/models"
 	"github.com/openmeterio/openmeter/openmeter/billing"
 	"github.com/openmeterio/openmeter/openmeter/productcatalog"
 	"github.com/openmeterio/openmeter/pkg/currencyx"
-	"github.com/openmeterio/openmeter/pkg/models"
 	"github.com/openmeterio/openmeter/pkg/slicesx"
 )
 

openmeter/credit/engine/engine.go

@@ -9,9 +9,9 @@ import (
 	"github.com/alpacahq/alpacadecimal"
 	"github.com/samber/lo"
 
+	"github.com/openmeterio/openmeter/api/models"
 	"github.com/openmeterio/openmeter/openmeter/credit/balance"
 	"github.com/openmeterio/openmeter/openmeter/credit/grant"
-	"github.com/openmeterio/openmeter/pkg/models"
 	"github.com/openmeterio/openmeter/pkg/recurrence"
 )
 

openmeter/credit/grant/owner_connector.go

@@ -5,8 +5,8 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/openmeterio/openmeter/api/models"
 	"github.com/openmeterio/openmeter/openmeter/streaming"
-	"github.com/openmeterio/openmeter/pkg/models"
 )
 
 type EndCurrentUsagePeriodParams struct {

openmeter/credit/helper.go

@@ -9,10 +9,10 @@ import (
 	"github.com/alpacahq/alpacadecimal"
 	"github.com/samber/lo"
 
+	"github.com/openmeterio/openmeter/api/models"
 	"github.com/openmeterio/openmeter/openmeter/credit/balance"
 	"github.com/openmeterio/openmeter/openmeter/credit/engine"
 	"github.com/openmeterio/openmeter/openmeter/credit/grant"
-	"github.com/openmeterio/openmeter/pkg/models"
 	"github.com/openmeterio/openmeter/pkg/recurrence"
 )