refactor: Start implementation of public API

Makefile

@@ -3,4 +3,4 @@ generate:
 	go generate ./...
 
 clean:
-	rm -rf pkg/db
+	rm -rf internal/db

cmd/stbak/cmd/archive.go

@@ -26,13 +26,13 @@ import (
 	"github.com/klauspost/compress/zstd"
 	"github.com/klauspost/pgzip"
 	"github.com/pierrec/lz4/v4"
-	"github.com/pojntfx/stfs/pkg/adapters"
-	"github.com/pojntfx/stfs/pkg/controllers"
-	"github.com/pojntfx/stfs/pkg/counters"
-	"github.com/pojntfx/stfs/pkg/formatting"
-	"github.com/pojntfx/stfs/pkg/noop"
-	"github.com/pojntfx/stfs/pkg/pax"
-	"github.com/pojntfx/stfs/pkg/persisters"
+	"github.com/pojntfx/stfs/internal/adapters"
+	"github.com/pojntfx/stfs/internal/controllers"
+	"github.com/pojntfx/stfs/internal/counters"
+	"github.com/pojntfx/stfs/internal/formatting"
+	"github.com/pojntfx/stfs/internal/noop"
+	"github.com/pojntfx/stfs/internal/pax"
+	"github.com/pojntfx/stfs/internal/persisters"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/volatiletech/sqlboiler/v4/boil"

cmd/stbak/cmd/delete.go

@@ -6,13 +6,13 @@ import (
 	"context"
 	"os"
 
-	"github.com/pojntfx/stfs/pkg/controllers"
-	"github.com/pojntfx/stfs/pkg/converters"
-	"github.com/pojntfx/stfs/pkg/counters"
-	models "github.com/pojntfx/stfs/pkg/db/sqlite/models/metadata"
-	"github.com/pojntfx/stfs/pkg/formatting"
-	"github.com/pojntfx/stfs/pkg/pax"
-	"github.com/pojntfx/stfs/pkg/persisters"
+	"github.com/pojntfx/stfs/internal/controllers"
+	"github.com/pojntfx/stfs/internal/converters"
+	"github.com/pojntfx/stfs/internal/counters"
+	models "github.com/pojntfx/stfs/internal/db/sqlite/models/metadata"
+	"github.com/pojntfx/stfs/internal/formatting"
+	"github.com/pojntfx/stfs/internal/pax"
+	"github.com/pojntfx/stfs/internal/persisters"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/volatiletech/sqlboiler/v4/boil"

cmd/stbak/cmd/drive_eject.go

@@ -3,7 +3,7 @@ package cmd
 import (
 	"os"
 
-	"github.com/pojntfx/stfs/pkg/controllers"
+	"github.com/pojntfx/stfs/internal/controllers"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/volatiletech/sqlboiler/v4/boil"

cmd/stbak/cmd/drive_tell.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/pojntfx/stfs/pkg/controllers"
+	"github.com/pojntfx/stfs/internal/controllers"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/volatiletech/sqlboiler/v4/boil"

cmd/stbak/cmd/find.go

@@ -4,9 +4,9 @@ import (
 	"context"
 	"regexp"
 
-	"github.com/pojntfx/stfs/pkg/converters"
-	"github.com/pojntfx/stfs/pkg/formatting"
-	"github.com/pojntfx/stfs/pkg/persisters"
+	"github.com/pojntfx/stfs/internal/converters"
+	"github.com/pojntfx/stfs/internal/formatting"
+	"github.com/pojntfx/stfs/internal/persisters"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/volatiletech/sqlboiler/v4/boil"

cmd/stbak/cmd/list.go

@@ -3,9 +3,9 @@ package cmd
 import (
 	"context"
 
-	"github.com/pojntfx/stfs/pkg/converters"
-	"github.com/pojntfx/stfs/pkg/formatting"
-	"github.com/pojntfx/stfs/pkg/persisters"
+	"github.com/pojntfx/stfs/internal/converters"
+	"github.com/pojntfx/stfs/internal/formatting"
+	"github.com/pojntfx/stfs/internal/persisters"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/volatiletech/sqlboiler/v4/boil"

cmd/stbak/cmd/move.go

@@ -5,11 +5,11 @@ import (
 	"context"
 	"strings"
 
-	"github.com/pojntfx/stfs/pkg/converters"
-	models "github.com/pojntfx/stfs/pkg/db/sqlite/models/metadata"
-	"github.com/pojntfx/stfs/pkg/formatting"
-	"github.com/pojntfx/stfs/pkg/pax"
-	"github.com/pojntfx/stfs/pkg/persisters"
+	"github.com/pojntfx/stfs/internal/converters"
+	models "github.com/pojntfx/stfs/internal/db/sqlite/models/metadata"
+	"github.com/pojntfx/stfs/internal/formatting"
+	"github.com/pojntfx/stfs/internal/pax"
+	"github.com/pojntfx/stfs/internal/persisters"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/volatiletech/sqlboiler/v4/boil"

cmd/stbak/cmd/recovery_fetch.go

@@ -23,9 +23,9 @@ import (
 	"github.com/klauspost/compress/zstd"
 	"github.com/klauspost/pgzip"
 	"github.com/pierrec/lz4/v4"
-	"github.com/pojntfx/stfs/pkg/controllers"
-	"github.com/pojntfx/stfs/pkg/formatting"
-	"github.com/pojntfx/stfs/pkg/pax"
+	"github.com/pojntfx/stfs/internal/controllers"
+	"github.com/pojntfx/stfs/internal/formatting"
+	"github.com/pojntfx/stfs/internal/pax"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/volatiletech/sqlboiler/v4/boil"

cmd/stbak/cmd/recovery_index.go

@@ -11,13 +11,13 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/pojntfx/stfs/pkg/controllers"
-	"github.com/pojntfx/stfs/pkg/converters"
-	"github.com/pojntfx/stfs/pkg/counters"
-	models "github.com/pojntfx/stfs/pkg/db/sqlite/models/metadata"
-	"github.com/pojntfx/stfs/pkg/formatting"
-	"github.com/pojntfx/stfs/pkg/pax"
-	"github.com/pojntfx/stfs/pkg/persisters"
+	"github.com/pojntfx/stfs/internal/controllers"
+	"github.com/pojntfx/stfs/internal/converters"
+	"github.com/pojntfx/stfs/internal/counters"
+	models "github.com/pojntfx/stfs/internal/db/sqlite/models/metadata"
+	"github.com/pojntfx/stfs/internal/formatting"
+	"github.com/pojntfx/stfs/internal/pax"
+	"github.com/pojntfx/stfs/internal/persisters"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/volatiletech/sqlboiler/v4/boil"

cmd/stbak/cmd/recovery_query.go

@@ -7,9 +7,9 @@ import (
 	"io/ioutil"
 	"math"
 
-	"github.com/pojntfx/stfs/pkg/controllers"
-	"github.com/pojntfx/stfs/pkg/counters"
-	"github.com/pojntfx/stfs/pkg/formatting"
+	"github.com/pojntfx/stfs/internal/controllers"
+	"github.com/pojntfx/stfs/internal/counters"
+	"github.com/pojntfx/stfs/internal/formatting"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/volatiletech/sqlboiler/v4/boil"

cmd/stbak/cmd/restore.go

@@ -8,10 +8,10 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/pojntfx/stfs/pkg/converters"
-	models "github.com/pojntfx/stfs/pkg/db/sqlite/models/metadata"
-	"github.com/pojntfx/stfs/pkg/formatting"
-	"github.com/pojntfx/stfs/pkg/persisters"
+	"github.com/pojntfx/stfs/internal/converters"
+	models "github.com/pojntfx/stfs/internal/db/sqlite/models/metadata"
+	"github.com/pojntfx/stfs/internal/formatting"
+	"github.com/pojntfx/stfs/internal/persisters"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/volatiletech/sqlboiler/v4/boil"

cmd/stbak/cmd/update.go

@@ -10,12 +10,12 @@ import (
 	"path/filepath"
 	"strconv"
 
-	"github.com/pojntfx/stfs/pkg/adapters"
-	"github.com/pojntfx/stfs/pkg/controllers"
-	"github.com/pojntfx/stfs/pkg/counters"
-	"github.com/pojntfx/stfs/pkg/formatting"
-	"github.com/pojntfx/stfs/pkg/pax"
-	"github.com/pojntfx/stfs/pkg/persisters"
+	"github.com/pojntfx/stfs/internal/adapters"
+	"github.com/pojntfx/stfs/internal/controllers"
+	"github.com/pojntfx/stfs/internal/counters"
+	"github.com/pojntfx/stfs/internal/formatting"
+	"github.com/pojntfx/stfs/internal/pax"
+	"github.com/pojntfx/stfs/internal/persisters"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/volatiletech/sqlboiler/v4/boil"

internal/converters/header.go

@@ -4,7 +4,7 @@ import (
 	"archive/tar"
 	"encoding/json"
 
-	models "github.com/pojntfx/stfs/pkg/db/sqlite/models/metadata"
+	models "github.com/pojntfx/stfs/internal/db/sqlite/models/metadata"
 )
 
 func DBHeaderToTarHeader(dbhdr *models.Header) (*tar.Header, error) {

internal/persisters/metadata.go

@@ -9,8 +9,8 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/pojntfx/stfs/pkg/db/sqlite/migrations/metadata"
-	models "github.com/pojntfx/stfs/pkg/db/sqlite/models/metadata"
+	"github.com/pojntfx/stfs/internal/db/sqlite/migrations/metadata"
+	models "github.com/pojntfx/stfs/internal/db/sqlite/models/metadata"
 	migrate "github.com/rubenv/sql-migrate"
 	"github.com/volatiletech/sqlboiler/v4/boil"
 	"github.com/volatiletech/sqlboiler/v4/queries"

pkg/config/config.go

@@ -0,0 +1,18 @@
+package config
+
+type StateConfig struct {
+	Drive    string
+	Metadata string
+}
+
+type PipeConfig struct {
+	Compression string
+	Encryption  string
+	Signature   string
+}
+
+type CryptoConfig struct {
+	Recipient interface{}
+	Identity  interface{}
+	Password  string
+}

pkg/hardware/hardware.go

@@ -0,0 +1,13 @@
+package hardware
+
+type DriveConfig struct {
+	Drive string
+}
+
+func Eject(
+	state DriveConfig,
+) error
+
+func Tell(
+	state DriveConfig,
+) (int, error)

pkg/inventory/inventory.go

@@ -0,0 +1,19 @@
+package inventory
+
+import "archive/tar"
+
+type MetadataConfig struct {
+	Metadata string
+}
+
+func Find(
+	state MetadataConfig,
+
+	expression string,
+) ([]*tar.Header, error)
+
+func List(
+	state MetadataConfig,
+
+	name string,
+) ([]*tar.Header, error)

pkg/operations/operations.go

@@ -0,0 +1,59 @@
+package operations
+
+import (
+	"archive/tar"
+
+	"github.com/pojntfx/stfs/pkg/config"
+)
+
+func Archive(
+	state config.StateConfig,
+	pipes config.PipeConfig,
+	crypto config.CryptoConfig,
+
+	recordSize int,
+	from string,
+	overwrite bool,
+	compressionLevel string,
+) ([]*tar.Header, error)
+
+func Restore(
+	state config.StateConfig,
+	pipes config.PipeConfig,
+	crypto config.CryptoConfig,
+
+	recordSize int,
+	from string,
+	to string,
+	flatten bool,
+) error
+
+func Update(
+	state config.StateConfig,
+	pipes config.PipeConfig,
+	crypto config.CryptoConfig,
+
+	recordSize int,
+	from string,
+	overwrite bool,
+	compressionLevel string,
+) error
+
+func Delete(
+	state config.StateConfig,
+	pipes config.PipeConfig,
+	crypto config.CryptoConfig,
+
+	recordSize int,
+	name string,
+) error
+
+func Move(
+	state config.StateConfig,
+	pipes config.PipeConfig,
+	crypto config.CryptoConfig,
+
+	recordSize int,
+	from string,
+	to string,
+) error

pkg/recovery/recovery.go

@@ -0,0 +1,40 @@
+package recovery
+
+import (
+	"archive/tar"
+
+	"github.com/pojntfx/stfs/pkg/config"
+)
+
+func Fetch(
+	state config.StateConfig,
+	pipes config.PipeConfig,
+	crypto config.CryptoConfig,
+
+	recordSize int,
+	record int,
+	block int,
+	to string,
+	preview string,
+) error
+
+func Index(
+	state config.StateConfig,
+	pipes config.PipeConfig,
+	crypto config.CryptoConfig,
+
+	recordSize int,
+	record int,
+	block int,
+	overwrite bool,
+) error
+
+func Query(
+	state config.StateConfig,
+	pipes config.PipeConfig,
+	crypto config.CryptoConfig,
+
+	recordSize int,
+	record int,
+	block int,
+) ([]*tar.Header, error)

pkg/utility/utility.go

@@ -0,0 +1,8 @@
+package utility
+
+import "github.com/pojntfx/stfs/pkg/config"
+
+func Keygen(
+	pipes config.PipeConfig,
+	crypto config.CryptoConfig,
+) (privkey []byte, pubkey []byte, err error)