Compare commits

..
4 Commits
Author SHA1 Message Date
warkanum e8fbbede7e chore: update version to 1.0.2 and changelog
Tests / Unit Tests (push) Failing after 25s
Tests / Integration Tests (push) Failing after 26s
Build , Vet Test, and Lint / Build (push) Successful in 1m9s
Build , Vet Test, and Lint / Lint Code (push) Successful in 1m29s
Build , Vet Test, and Lint / Run Vet Tests (1.24.x) (push) Successful in 1m32s
Build , Vet Test, and Lint / Run Vet Tests (1.23.x) (push) Successful in 1m33s
2026-09-23 20:58:18 +02:00
warkanum 7f8982fa35 feat(headerspec): add UTF-8 encoding/decoding support
* Implement round-trip encoding/decoding for UTF-8 values in header functions.
* Update encodeHeaderValue and decodeHeaderValue to use base64 utility functions.
* Add tests for UTF-8 header value handling.
* Update Vite config to externalize base64 utility.
2026-09-23 20:57:50 +02:00
warkanum b587cbd3c4 feat(headers): add support for custom HTTP headers in clients
* Introduced `headers` property in `ClientConfig` interface.
* Updated `HeaderSpecClient` and `ResolveSpecClient` to utilize custom headers.
* Implemented `mergeHeaders` function to handle case-insensitive header merging.
* Added tests for custom header functionality in clients.
2026-09-23 19:47:05 +02:00
Hein a220338eea feat(spectypes): add CIString, LCString, and UCString types with tests
Tests / Unit Tests (push) Failing after 28s
Tests / Integration Tests (push) Failing after 30s
Build , Vet Test, and Lint / Build (push) Successful in 1m8s
Build , Vet Test, and Lint / Lint Code (push) Successful in 1m18s
Build , Vet Test, and Lint / Run Vet Tests (1.23.x) (push) Successful in 1m35s
Build , Vet Test, and Lint / Run Vet Tests (1.24.x) (push) Successful in 1m36s
2026-09-21 14:06:33 +02:00
17 changed files with 2444 additions and 2168 deletions
+177
View File
@@ -0,0 +1,177 @@
package spectypes
import (
"database/sql/driver"
"encoding/json"
"fmt"
"strings"
)
// CIString is a string that stores, scans, and returns its value exactly as
// given (no case normalization), but compares case-insensitively via Equal
// and EqualString. Use it as a bun model field type for columns (e.g.
// citext, or codes matched case-insensitively) where you want Go-side
// case-insensitive comparisons without forcing the stored/returned value to
// a particular case.
type CIString string
// Value implements driver.Valuer. The value is passed through unchanged.
func (s CIString) Value() (driver.Value, error) {
return string(s), nil
}
// Scan implements sql.Scanner. The value is stored unchanged.
func (s *CIString) Scan(value any) error {
switch v := value.(type) {
case string:
*s = CIString(v)
case []byte:
*s = CIString(v)
case nil:
*s = ""
default:
return fmt.Errorf("cannot scan %T into CIString", value)
}
return nil
}
// String implements fmt.Stringer.
func (s CIString) String() string { return string(s) }
// Equal reports whether s and other are equal, ignoring case.
func (s CIString) Equal(other CIString) bool {
return strings.EqualFold(string(s), string(other))
}
// EqualString reports whether s equals other, ignoring case.
func (s CIString) EqualString(other string) bool {
return strings.EqualFold(string(s), other)
}
// Compare returns -1, 0, or +1 if s is less than, equal to, or greater than
// other, ignoring case. Useful with slices.SortFunc or similar.
func (s CIString) Compare(other CIString) int {
return strings.Compare(strings.ToLower(string(s)), strings.ToLower(string(other)))
}
// Less reports whether s sorts before other, ignoring case. Suitable for
// sort.Slice or slices.SortFunc comparisons.
func (s CIString) Less(other CIString) bool {
return s.Compare(other) < 0
}
// LCString is a string that always stores, scans, and returns as lowercase.
// Use it as a bun model field type for columns that must be normalized to
// lowercase (e.g. codes, slugs, emails) rather than merely compared
// case-insensitively; see CIString if the original case must be preserved.
type LCString string
// Value implements driver.Valuer, always lowercase.
func (s LCString) Value() (driver.Value, error) {
return strings.ToLower(string(s)), nil
}
// Scan implements sql.Scanner, always lowercase.
func (s *LCString) Scan(value any) error {
switch v := value.(type) {
case string:
*s = LCString(strings.ToLower(v))
case []byte:
*s = LCString(strings.ToLower(string(v)))
case nil:
*s = ""
default:
return fmt.Errorf("cannot scan %T into LCString", value)
}
return nil
}
// String implements fmt.Stringer, always lowercase.
func (s LCString) String() string { return strings.ToLower(string(s)) }
// Equal reports whether s and other are equal (case-insensitively, since
// both normalize to lowercase).
func (s LCString) Equal(other LCString) bool {
return s.String() == other.String()
}
// EqualString reports whether s equals other, ignoring case.
func (s LCString) EqualString(other string) bool {
return s.String() == strings.ToLower(other)
}
// MarshalJSON implements json.Marshaler, always lowercase. Needed because
// encoding/json marshals a bare string-kind type as-is and does not call
// Value/String, so a value constructed directly (not scanned from the DB)
// would otherwise serialize with its original case.
func (s LCString) MarshalJSON() ([]byte, error) {
return json.Marshal(strings.ToLower(string(s)))
}
// UnmarshalJSON implements json.Unmarshaler, always lowercase.
func (s *LCString) UnmarshalJSON(b []byte) error {
var str string
if err := json.Unmarshal(b, &str); err != nil {
return err
}
*s = LCString(strings.ToLower(str))
return nil
}
// UCString is a string that always stores, scans, and returns as uppercase.
// Use it as a bun model field type for columns that must be normalized to
// uppercase (e.g. table prefix codes) rather than merely compared
// case-insensitively; see CIString if the original case must be preserved.
type UCString string
// Value implements driver.Valuer, always uppercase.
func (s UCString) Value() (driver.Value, error) {
return strings.ToUpper(string(s)), nil
}
// Scan implements sql.Scanner, always uppercase.
func (s *UCString) Scan(value any) error {
switch v := value.(type) {
case string:
*s = UCString(strings.ToUpper(v))
case []byte:
*s = UCString(strings.ToUpper(string(v)))
case nil:
*s = ""
default:
return fmt.Errorf("cannot scan %T into UCString", value)
}
return nil
}
// String implements fmt.Stringer, always uppercase.
func (s UCString) String() string { return strings.ToUpper(string(s)) }
// Equal reports whether s and other are equal (case-insensitively, since
// both normalize to uppercase).
func (s UCString) Equal(other UCString) bool {
return s.String() == other.String()
}
// EqualString reports whether s equals other, ignoring case.
func (s UCString) EqualString(other string) bool {
return s.String() == strings.ToUpper(other)
}
// MarshalJSON implements json.Marshaler, always uppercase. Needed because
// encoding/json marshals a bare string-kind type as-is and does not call
// Value/String, so a value constructed directly (not scanned from the DB)
// would otherwise serialize with its original case.
func (s UCString) MarshalJSON() ([]byte, error) {
return json.Marshal(strings.ToUpper(string(s)))
}
// UnmarshalJSON implements json.Unmarshaler, always uppercase.
func (s *UCString) UnmarshalJSON(b []byte) error {
var str string
if err := json.Unmarshal(b, &str); err != nil {
return err
}
*s = UCString(strings.ToUpper(str))
return nil
}
+379
View File
@@ -0,0 +1,379 @@
package spectypes
import (
"encoding/json"
"sort"
"testing"
)
func TestCIString_Scan(t *testing.T) {
tests := []struct {
name string
input interface{}
expected CIString
}{
{name: "plain string", input: "MixedCase", expected: "MixedCase"},
{name: "bytes as string", input: []byte("FromBytes"), expected: "FromBytes"},
{name: "nil value", input: nil, expected: ""},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var s CIString
if err := s.Scan(tt.input); err != nil {
t.Fatalf("Scan failed: %v", err)
}
if s != tt.expected {
t.Errorf("expected %q, got %q", tt.expected, s)
}
})
}
}
func TestCIString_Scan_InvalidType(t *testing.T) {
var s CIString
if err := s.Scan(123); err == nil {
t.Fatal("expected error scanning int into CIString, got nil")
}
}
func TestCIString_Value(t *testing.T) {
s := CIString("MixedCase")
v, err := s.Value()
if err != nil {
t.Fatalf("Value failed: %v", err)
}
if v != "MixedCase" {
t.Errorf("expected %q, got %q (case must be preserved)", "MixedCase", v)
}
}
func TestCIString_String(t *testing.T) {
s := CIString("MixedCase")
if s.String() != "MixedCase" {
t.Errorf("expected %q, got %q", "MixedCase", s.String())
}
}
func TestCIString_Equal(t *testing.T) {
tests := []struct {
name string
a, b CIString
expected bool
}{
{name: "same case", a: "ABC", b: "ABC", expected: true},
{name: "different case", a: "ABC", b: "abc", expected: true},
{name: "mixed case", a: "AbC", b: "aBc", expected: true},
{name: "not equal", a: "ABC", b: "XYZ", expected: false},
{name: "both empty", a: "", b: "", expected: true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := tt.a.Equal(tt.b); got != tt.expected {
t.Errorf("Equal(%q, %q) = %v, want %v", tt.a, tt.b, got, tt.expected)
}
})
}
}
func TestCIString_EqualString(t *testing.T) {
s := CIString("ABC")
if !s.EqualString("abc") {
t.Error("expected EqualString to match case-insensitively")
}
if s.EqualString("xyz") {
t.Error("expected EqualString to not match different strings")
}
}
func TestCIString_Compare(t *testing.T) {
tests := []struct {
name string
a, b CIString
expected int
}{
{name: "equal same case", a: "abc", b: "abc", expected: 0},
{name: "equal different case", a: "ABC", b: "abc", expected: 0},
{name: "less", a: "abc", b: "xyz", expected: -1},
{name: "less different case", a: "ABC", b: "xyz", expected: -1},
{name: "greater", a: "xyz", b: "abc", expected: 1},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := tt.a.Compare(tt.b); got != tt.expected {
t.Errorf("Compare(%q, %q) = %v, want %v", tt.a, tt.b, got, tt.expected)
}
})
}
}
func TestCIString_Less(t *testing.T) {
if !CIString("abc").Less("xyz") {
t.Error("expected abc < xyz")
}
if CIString("xyz").Less("abc") {
t.Error("expected xyz not < abc")
}
if CIString("ABC").Less("abc") {
t.Error("expected ABC not < abc (equal ignoring case)")
}
}
func TestCIString_Sort(t *testing.T) {
vals := []CIString{"banana", "Apple", "cherry", "apple"}
sort.Slice(vals, func(i, j int) bool { return vals[i].Less(vals[j]) })
// After a case-insensitive sort, "Apple"/"apple" must be adjacent and first,
// followed by banana then cherry.
if !vals[0].EqualString("apple") || !vals[1].EqualString("apple") {
t.Errorf("expected the two apple variants first, got %v", vals)
}
if !vals[2].EqualString("banana") {
t.Errorf("expected banana third, got %v", vals)
}
if !vals[3].EqualString("cherry") {
t.Errorf("expected cherry fourth, got %v", vals)
}
}
func TestLCString_Scan(t *testing.T) {
tests := []struct {
name string
input interface{}
expected LCString
}{
{name: "mixed case string", input: "MixedCase", expected: "mixedcase"},
{name: "bytes mixed case", input: []byte("FromBytes"), expected: "frombytes"},
{name: "nil value", input: nil, expected: ""},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var s LCString
if err := s.Scan(tt.input); err != nil {
t.Fatalf("Scan failed: %v", err)
}
if s != tt.expected {
t.Errorf("expected %q, got %q", tt.expected, s)
}
})
}
}
func TestLCString_Scan_InvalidType(t *testing.T) {
var s LCString
if err := s.Scan(123); err == nil {
t.Fatal("expected error scanning int into LCString, got nil")
}
}
func TestLCString_Value(t *testing.T) {
s := LCString("MixedCase")
v, err := s.Value()
if err != nil {
t.Fatalf("Value failed: %v", err)
}
if v != "mixedcase" {
t.Errorf("expected %q, got %q", "mixedcase", v)
}
}
func TestLCString_String(t *testing.T) {
s := LCString("MixedCase")
if s.String() != "mixedcase" {
t.Errorf("expected %q, got %q", "mixedcase", s.String())
}
}
func TestLCString_Equal(t *testing.T) {
if !LCString("ABC").Equal(LCString("abc")) {
t.Error("expected ABC and abc to be equal")
}
if LCString("ABC").Equal(LCString("xyz")) {
t.Error("expected ABC and xyz to not be equal")
}
}
func TestLCString_EqualString(t *testing.T) {
if !LCString("ABC").EqualString("abc") {
t.Error("expected EqualString to match case-insensitively")
}
}
func TestUCString_Scan(t *testing.T) {
tests := []struct {
name string
input interface{}
expected UCString
}{
{name: "mixed case string", input: "MixedCase", expected: "MIXEDCASE"},
{name: "bytes mixed case", input: []byte("FromBytes"), expected: "FROMBYTES"},
{name: "nil value", input: nil, expected: ""},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var s UCString
if err := s.Scan(tt.input); err != nil {
t.Fatalf("Scan failed: %v", err)
}
if s != tt.expected {
t.Errorf("expected %q, got %q", tt.expected, s)
}
})
}
}
func TestUCString_Scan_InvalidType(t *testing.T) {
var s UCString
if err := s.Scan(123); err == nil {
t.Fatal("expected error scanning int into UCString, got nil")
}
}
func TestUCString_Value(t *testing.T) {
s := UCString("MixedCase")
v, err := s.Value()
if err != nil {
t.Fatalf("Value failed: %v", err)
}
if v != "MIXEDCASE" {
t.Errorf("expected %q, got %q", "MIXEDCASE", v)
}
}
func TestUCString_String(t *testing.T) {
s := UCString("MixedCase")
if s.String() != "MIXEDCASE" {
t.Errorf("expected %q, got %q", "MIXEDCASE", s.String())
}
}
func TestUCString_Equal(t *testing.T) {
if !UCString("ABC").Equal(UCString("abc")) {
t.Error("expected ABC and abc to be equal")
}
if UCString("ABC").Equal(UCString("xyz")) {
t.Error("expected ABC and xyz to not be equal")
}
}
func TestUCString_EqualString(t *testing.T) {
if !UCString("ABC").EqualString("abc") {
t.Error("expected EqualString to match case-insensitively")
}
}
// TestLCString_MarshalJSON_NotFromDB verifies a value constructed directly
// in Go (never passed through Scan) still normalizes on JSON marshal.
func TestLCString_MarshalJSON_NotFromDB(t *testing.T) {
s := LCString("MixedCase")
b, err := json.Marshal(s)
if err != nil {
t.Fatalf("Marshal failed: %v", err)
}
if string(b) != `"mixedcase"` {
t.Errorf("expected %s, got %s", `"mixedcase"`, b)
}
}
func TestLCString_UnmarshalJSON(t *testing.T) {
var s LCString
if err := json.Unmarshal([]byte(`"MixedCase"`), &s); err != nil {
t.Fatalf("Unmarshal failed: %v", err)
}
if s != "mixedcase" {
t.Errorf("expected %q, got %q", "mixedcase", s)
}
}
func TestLCString_JSON_StructField(t *testing.T) {
type wrapper struct {
Code LCString `json:"code"`
}
in := wrapper{Code: "MixedCase"}
b, err := json.Marshal(in)
if err != nil {
t.Fatalf("Marshal failed: %v", err)
}
if string(b) != `{"code":"mixedcase"}` {
t.Errorf("expected %s, got %s", `{"code":"mixedcase"}`, b)
}
var out wrapper
if err := json.Unmarshal([]byte(`{"code":"AnotherMixedCase"}`), &out); err != nil {
t.Fatalf("Unmarshal failed: %v", err)
}
if out.Code != "anothermixedcase" {
t.Errorf("expected %q, got %q", "anothermixedcase", out.Code)
}
}
// TestUCString_MarshalJSON_NotFromDB verifies a value constructed directly
// in Go (never passed through Scan) still normalizes on JSON marshal.
func TestUCString_MarshalJSON_NotFromDB(t *testing.T) {
s := UCString("MixedCase")
b, err := json.Marshal(s)
if err != nil {
t.Fatalf("Marshal failed: %v", err)
}
if string(b) != `"MIXEDCASE"` {
t.Errorf("expected %s, got %s", `"MIXEDCASE"`, b)
}
}
func TestUCString_UnmarshalJSON(t *testing.T) {
var s UCString
if err := json.Unmarshal([]byte(`"MixedCase"`), &s); err != nil {
t.Fatalf("Unmarshal failed: %v", err)
}
if s != "MIXEDCASE" {
t.Errorf("expected %q, got %q", "MIXEDCASE", s)
}
}
func TestUCString_JSON_StructField(t *testing.T) {
type wrapper struct {
Code UCString `json:"code"`
}
in := wrapper{Code: "MixedCase"}
b, err := json.Marshal(in)
if err != nil {
t.Fatalf("Marshal failed: %v", err)
}
if string(b) != `{"code":"MIXEDCASE"}` {
t.Errorf("expected %s, got %s", `{"code":"MIXEDCASE"}`, b)
}
var out wrapper
if err := json.Unmarshal([]byte(`{"code":"AnotherMixedCase"}`), &out); err != nil {
t.Fatalf("Unmarshal failed: %v", err)
}
if out.Code != "ANOTHERMIXEDCASE" {
t.Errorf("expected %q, got %q", "ANOTHERMIXEDCASE", out.Code)
}
}
// TestCIString_JSON_PreservesCase confirms CIString needs no custom JSON
// methods: it should never normalize case, only its DB Value/Scan and the
// Equal/EqualString comparisons apply case-insensitivity.
func TestCIString_JSON_PreservesCase(t *testing.T) {
s := CIString("MixedCase")
b, err := json.Marshal(s)
if err != nil {
t.Fatalf("Marshal failed: %v", err)
}
if string(b) != `"MixedCase"` {
t.Errorf("expected %s, got %s", `"MixedCase"`, b)
}
var out CIString
if err := json.Unmarshal([]byte(`"AnotherMixedCase"`), &out); err != nil {
t.Fatalf("Unmarshal failed: %v", err)
}
if out != "AnotherMixedCase" {
t.Errorf("expected case to be preserved, got %q", out)
}
}
+7
View File
@@ -1,5 +1,12 @@
# @warkypublic/resolvespec-js # @warkypublic/resolvespec-js
## 1.0.2
### Patch Changes
- b587cbd: Forward custom ClientConfig headers on every ResolveSpec and HeaderSpec request. Merge headers case-insensitively and isolate cached clients by URL and effective headers, including authentication and tenant headers.
- 7f8982f: fix: added headers and few fixes
## 1.0.1 ## 1.0.1
### Patch Changes ### Patch Changes
+23 -1
View File
@@ -28,7 +28,7 @@ import { ResolveSpecClient, getResolveSpecClient } from '@warkypublic/resolvespe
// Class instantiation // Class instantiation
const client = new ResolveSpecClient({ baseUrl: 'http://localhost:3000', token: 'your-token' }); const client = new ResolveSpecClient({ baseUrl: 'http://localhost:3000', token: 'your-token' });
// Or singleton factory (returns cached instance per baseUrl) // Or singleton factory (returns cached instance per baseUrl and effective headers)
const client = getResolveSpecClient({ baseUrl: 'http://localhost:3000', token: 'your-token' }); const client = getResolveSpecClient({ baseUrl: 'http://localhost:3000', token: 'your-token' });
// Read with filters, sort, pagination // Read with filters, sort, pagination
@@ -211,3 +211,25 @@ pnpm run lint # eslint
## License ## License
MIT MIT
### Custom HTTP headers
Both `ResolveSpecClient` and `HeaderSpecClient` (including their factory functions)
accept `headers` in `ClientConfig` and send them on every HTTP request:
```typescript
const client = new ResolveSpecClient({
baseUrl: 'http://localhost:3000',
token: 'your-token',
headers: { 'X-Tenant': 'acme' },
});
```
Header names are merged case-insensitively. Custom headers override the default
`Content-Type`; a supplied `token` overrides custom `Authorization`, and HeaderSpec
query options override matching custom query headers. Without a token, custom
`Authorization` is preserved. Configuration is copied at construction; create or
retrieve a client with new configuration to change headers. Factory clients are
cached by URL and effective headers, keeping different tenants and tokens separate.
Grid adapters must forward `dataSourceOptions.headers` to this `headers` option.
+1 -1
View File
File diff suppressed because one or more lines are too long
+5 -366
View File
@@ -1,366 +1,5 @@
export declare interface APIError { export * from './common';
code: string; export * from './resolvespec';
message: string; export * from './websocketspec';
details?: any; export * from './headerspec';
detail?: string; //# sourceMappingURL=index.d.ts.map
}
export declare interface APIResponse<T = any> {
success: boolean;
data: T;
metadata?: Metadata;
error?: APIError;
}
/**
* Build HTTP headers from Options, matching Go's restheadspec handler conventions.
*
* Header mapping:
* - X-Select-Fields: comma-separated columns
* - X-Not-Select-Fields: comma-separated omit_columns
* - X-FieldFilter-{col}: exact match (eq)
* - X-SearchOp-{operator}-{col}: AND filter
* - X-SearchOr-{operator}-{col}: OR filter
* - X-Sort: +col (asc), -col (desc)
* - X-Limit, X-Offset: pagination
* - X-Cursor-Forward, X-Cursor-Backward: cursor pagination
* - X-Preload: RelationName:field1,field2 pipe-separated
* - X-Fetch-RowNumber: row number fetch
* - X-CQL-SEL-{col}: computed columns
* - X-Custom-SQL-W: custom operators (AND)
*/
export declare function buildHeaders(options: Options): Record<string, string>;
export declare interface ClientConfig {
baseUrl: string;
token?: string;
}
export declare interface Column {
name: string;
type: string;
is_nullable: boolean;
is_primary: boolean;
is_unique: boolean;
has_index: boolean;
}
export declare interface ComputedColumn {
name: string;
expression: string;
}
export declare type ConnectionState = 'connecting' | 'connected' | 'disconnecting' | 'disconnected' | 'reconnecting';
export declare interface CustomOperator {
name: string;
sql: string;
}
/**
* Decode a header value that may be base64 encoded with ZIP_ or __ prefix.
*/
export declare function decodeHeaderValue(value: string): string;
/**
* Encode a value with base64 and ZIP_ prefix for complex header values.
*/
export declare function encodeHeaderValue(value: string): string;
export declare interface FilterOption {
column: string;
operator: Operator | string;
value: any;
logic_operator?: 'AND' | 'OR';
}
export declare function getHeaderSpecClient(config: ClientConfig): HeaderSpecClient;
export declare function getResolveSpecClient(config: ClientConfig): ResolveSpecClient;
export declare function getWebSocketClient(config: WebSocketClientConfig): WebSocketClient;
/**
* HeaderSpec REST client.
* Sends query options via HTTP headers instead of request body, matching the Go restheadspec handler.
*
* HTTP methods: GET=read, POST=create, PUT=update, DELETE=delete
*/
export declare class HeaderSpecClient {
private config;
constructor(config: ClientConfig);
private buildUrl;
private baseHeaders;
private fetchWithError;
read<T = any>(schema: string, entity: string, id?: string, options?: Options): Promise<APIResponse<T>>;
create<T = any>(schema: string, entity: string, data: any, options?: Options): Promise<APIResponse<T>>;
update<T = any>(schema: string, entity: string, id: string, data: any, options?: Options): Promise<APIResponse<T>>;
delete(schema: string, entity: string, id: string): Promise<APIResponse<void>>;
}
export declare type MessageType = 'request' | 'response' | 'notification' | 'subscription' | 'error' | 'ping' | 'pong';
export declare interface Metadata {
total: number;
count: number;
filtered: number;
limit: number;
offset: number;
row_number?: number;
}
export declare type Operation = 'read' | 'create' | 'update' | 'delete';
export declare type Operator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'like' | 'ilike' | 'in' | 'contains' | 'startswith' | 'endswith' | 'between' | 'between_inclusive' | 'is_null' | 'is_not_null';
export declare interface Options {
preload?: PreloadOption[];
columns?: string[];
omit_columns?: string[];
filters?: FilterOption[];
sort?: SortOption[];
limit?: number;
offset?: number;
customOperators?: CustomOperator[];
computedColumns?: ComputedColumn[];
parameters?: Parameter[];
cursor_forward?: string;
cursor_backward?: string;
fetch_row_number?: string;
}
export declare interface Parameter {
name: string;
value: string;
sequence?: number;
}
export declare interface PreloadOption {
relation: string;
table_name?: string;
columns?: string[];
omit_columns?: string[];
sort?: SortOption[];
filters?: FilterOption[];
where?: string;
limit?: number;
offset?: number;
updatable?: boolean;
computed_ql?: Record<string, string>;
recursive?: boolean;
primary_key?: string;
related_key?: string;
foreign_key?: string;
recursive_child_key?: string;
sql_joins?: string[];
join_aliases?: string[];
}
export declare interface RequestBody {
operation: Operation;
id?: number | string | string[];
data?: any | any[];
options?: Options;
}
export declare class ResolveSpecClient {
private config;
constructor(config: ClientConfig);
private buildUrl;
private baseHeaders;
private fetchWithError;
getMetadata(schema: string, entity: string): Promise<APIResponse<TableMetadata>>;
read<T = any>(schema: string, entity: string, id?: number | string | string[], options?: Options): Promise<APIResponse<T>>;
create<T = any>(schema: string, entity: string, data: any | any[], options?: Options): Promise<APIResponse<T>>;
update<T = any>(schema: string, entity: string, data: any | any[], id?: number | string | string[], options?: Options): Promise<APIResponse<T>>;
delete(schema: string, entity: string, id: number | string): Promise<APIResponse<void>>;
}
export declare type SortDirection = 'asc' | 'desc' | 'ASC' | 'DESC';
export declare interface SortOption {
column: string;
direction: SortDirection;
}
export declare interface Subscription {
id: string;
entity: string;
schema?: string;
options?: WSOptions;
callback?: (notification: WSNotificationMessage) => void;
}
export declare interface SubscriptionOptions {
filters?: FilterOption[];
onNotification?: (notification: WSNotificationMessage) => void;
}
export declare interface TableMetadata {
schema: string;
table: string;
columns: Column[];
relations: string[];
}
export declare class WebSocketClient {
private ws;
private config;
private messageHandlers;
private subscriptions;
private eventListeners;
private state;
private reconnectAttempts;
private reconnectTimer;
private heartbeatTimer;
private isManualClose;
constructor(config: WebSocketClientConfig);
connect(): Promise<void>;
disconnect(): void;
request<T = any>(operation: WSOperation, entity: string, options?: {
schema?: string;
record_id?: string;
data?: any;
options?: WSOptions;
}): Promise<T>;
read<T = any>(entity: string, options?: {
schema?: string;
record_id?: string;
filters?: FilterOption[];
columns?: string[];
sort?: SortOption[];
preload?: PreloadOption[];
limit?: number;
offset?: number;
}): Promise<T>;
create<T = any>(entity: string, data: any, options?: {
schema?: string;
}): Promise<T>;
update<T = any>(entity: string, id: string, data: any, options?: {
schema?: string;
}): Promise<T>;
delete(entity: string, id: string, options?: {
schema?: string;
}): Promise<void>;
meta<T = any>(entity: string, options?: {
schema?: string;
}): Promise<T>;
subscribe(entity: string, callback: (notification: WSNotificationMessage) => void, options?: {
schema?: string;
filters?: FilterOption[];
}): Promise<string>;
unsubscribe(subscriptionId: string): Promise<void>;
getSubscriptions(): Subscription[];
getState(): ConnectionState;
isConnected(): boolean;
on<K extends keyof WebSocketClientEvents>(event: K, callback: WebSocketClientEvents[K]): void;
off<K extends keyof WebSocketClientEvents>(event: K): void;
private handleMessage;
private handleResponse;
private handleNotification;
private send;
private startHeartbeat;
private stopHeartbeat;
private setState;
private ensureConnected;
private emit;
private log;
}
export declare interface WebSocketClientConfig {
url: string;
reconnect?: boolean;
reconnectInterval?: number;
maxReconnectAttempts?: number;
heartbeatInterval?: number;
debug?: boolean;
}
export declare interface WebSocketClientEvents {
connect: () => void;
disconnect: (event: CloseEvent) => void;
error: (error: Error) => void;
message: (message: WSMessage) => void;
stateChange: (state: ConnectionState) => void;
}
export declare interface WSErrorInfo {
code: string;
message: string;
details?: Record<string, any>;
}
export declare interface WSMessage {
id?: string;
type: MessageType;
operation?: WSOperation;
schema?: string;
entity?: string;
record_id?: string;
data?: any;
options?: WSOptions;
subscription_id?: string;
success?: boolean;
error?: WSErrorInfo;
metadata?: Record<string, any>;
timestamp?: string;
}
export declare interface WSNotificationMessage {
type: 'notification';
operation: WSOperation;
subscription_id: string;
schema?: string;
entity: string;
data: any;
timestamp: string;
}
export declare type WSOperation = 'read' | 'create' | 'update' | 'delete' | 'subscribe' | 'unsubscribe' | 'meta';
export declare interface WSOptions {
filters?: FilterOption[];
columns?: string[];
omit_columns?: string[];
preload?: PreloadOption[];
sort?: SortOption[];
limit?: number;
offset?: number;
parameters?: Parameter[];
cursor_forward?: string;
cursor_backward?: string;
fetch_row_number?: string;
}
export declare interface WSRequestMessage {
id: string;
type: 'request';
operation: WSOperation;
schema?: string;
entity: string;
record_id?: string;
data?: any;
options?: WSOptions;
}
export declare interface WSResponseMessage {
id: string;
type: 'response';
success: boolean;
data?: any;
error?: WSErrorInfo;
metadata?: Record<string, any>;
timestamp: string;
}
export declare interface WSSubscriptionMessage {
id: string;
type: 'subscription';
operation: 'subscribe' | 'unsubscribe';
schema?: string;
entity: string;
options?: WSOptions;
subscription_id?: string;
}
export { }
+223 -260
View File
@@ -1,53 +1,75 @@
import { v4 as l } from "uuid"; import { v4 as e } from "uuid";
const d = /* @__PURE__ */ new Map(); import { b64DecodeUnicode as t, b64EncodeUnicode as n } from "@warkypublic/artemis-kit/base64";
function E(n) { //#region src/common/http.ts
const e = n.baseUrl; function r(...e) {
let t = d.get(e); let t = {};
return t || (t = new g(n), d.set(e, t)), t; for (let n of e) for (let [e, r] of Object.entries(n)) {
} for (let n of Object.keys(t)) n.toLowerCase() === e.toLowerCase() && delete t[n];
class g { Object.defineProperty(t, e, {
constructor(e) { value: r,
this.config = e; enumerable: !0,
configurable: !0,
writable: !0
});
} }
buildUrl(e, t, s) { return t;
}
function i(e) {
return r({ "Content-Type": "application/json" }, e.headers ?? {}, e.token ? { Authorization: `Bearer ${e.token}` } : {});
}
function a(e) {
let t = Object.entries(i(e)).map(([e, t]) => [e.toLowerCase(), t]).sort(([e], [t]) => e.localeCompare(t));
return JSON.stringify([e.baseUrl, t]);
}
//#endregion
//#region src/resolvespec/client.ts
var o = /* @__PURE__ */ new Map();
function s(e) {
let t = a(e), n = o.get(t);
return n || (n = new c(e), o.set(t, n)), n;
}
var c = class {
constructor(e) {
this.config = {
...e,
headers: { ...e.headers }
};
}
buildUrl(e, t, n) {
let r = `${this.config.baseUrl}/${e}/${t}`; let r = `${this.config.baseUrl}/${e}/${t}`;
return s && (r += `/${s}`), r; return n && (r += `/${n}`), r;
} }
baseHeaders() { baseHeaders() {
const e = { return i(this.config);
"Content-Type": "application/json"
};
return this.config.token && (e.Authorization = `Bearer ${this.config.token}`), e;
} }
async fetchWithError(e, t) { async fetchWithError(e, t) {
const s = await fetch(e, t), r = await s.json(); let n = await fetch(e, t), r = await n.json();
if (!s.ok) if (!n.ok) throw Error(r.error?.message || "An error occurred");
throw new Error(r.error?.message || "An error occurred");
return r; return r;
} }
async getMetadata(e, t) { async getMetadata(e, t) {
const s = this.buildUrl(e, t); let n = this.buildUrl(e, t);
return this.fetchWithError(s, { return this.fetchWithError(n, {
method: "GET", method: "GET",
headers: this.baseHeaders() headers: this.baseHeaders()
}); });
} }
async read(e, t, s, r) { async read(e, t, n, r) {
const i = typeof s == "number" || typeof s == "string" ? String(s) : void 0, a = this.buildUrl(e, t, i), c = { let i = typeof n == "number" || typeof n == "string" ? String(n) : void 0, a = this.buildUrl(e, t, i), o = {
operation: "read", operation: "read",
id: Array.isArray(s) ? s : void 0, id: Array.isArray(n) ? n : void 0,
options: r options: r
}; };
return this.fetchWithError(a, { return this.fetchWithError(a, {
method: "POST", method: "POST",
headers: this.baseHeaders(), headers: this.baseHeaders(),
body: JSON.stringify(c) body: JSON.stringify(o)
}); });
} }
async create(e, t, s, r) { async create(e, t, n, r) {
const i = this.buildUrl(e, t), a = { let i = this.buildUrl(e, t), a = {
operation: "create", operation: "create",
data: s, data: n,
options: r options: r
}; };
return this.fetchWithError(i, { return this.fetchWithError(i, {
@@ -56,37 +78,33 @@ class g {
body: JSON.stringify(a) body: JSON.stringify(a)
}); });
} }
async update(e, t, s, r, i) { async update(e, t, n, r, i) {
const a = typeof r == "number" || typeof r == "string" ? String(r) : void 0, c = this.buildUrl(e, t, a), o = { let a = typeof r == "number" || typeof r == "string" ? String(r) : void 0, o = this.buildUrl(e, t, a), s = {
operation: "update", operation: "update",
id: Array.isArray(r) ? r : void 0, id: Array.isArray(r) ? r : void 0,
data: s, data: n,
options: i options: i
}; };
return this.fetchWithError(c, { return this.fetchWithError(o, {
method: "POST", method: "POST",
headers: this.baseHeaders(), headers: this.baseHeaders(),
body: JSON.stringify(o) body: JSON.stringify(s)
}); });
} }
async delete(e, t, s) { async delete(e, t, n) {
const r = this.buildUrl(e, t, String(s)), i = { let r = this.buildUrl(e, t, String(n));
operation: "delete"
};
return this.fetchWithError(r, { return this.fetchWithError(r, {
method: "POST", method: "POST",
headers: this.baseHeaders(), headers: this.baseHeaders(),
body: JSON.stringify(i) body: JSON.stringify({ operation: "delete" })
}); });
} }
}, l = /* @__PURE__ */ new Map();
function u(e) {
let t = e.url, n = l.get(t);
return n || (n = new d(e), l.set(t, n)), n;
} }
const f = /* @__PURE__ */ new Map(); var d = class {
function _(n) {
const e = n.url;
let t = f.get(e);
return t || (t = new p(n), f.set(e, t)), t;
}
class p {
constructor(e) { constructor(e) {
this.ws = null, this.messageHandlers = /* @__PURE__ */ new Map(), this.subscriptions = /* @__PURE__ */ new Map(), this.eventListeners = {}, this.state = "disconnected", this.reconnectAttempts = 0, this.reconnectTimer = null, this.heartbeatTimer = null, this.isManualClose = !1, this.config = { this.ws = null, this.messageHandlers = /* @__PURE__ */ new Map(), this.subscriptions = /* @__PURE__ */ new Map(), this.eventListeners = {}, this.state = "disconnected", this.reconnectAttempts = 0, this.reconnectTimer = null, this.heartbeatTimer = null, this.isManualClose = !1, this.config = {
url: e.url, url: e.url,
@@ -106,44 +124,44 @@ class p {
try { try {
this.ws = new WebSocket(this.config.url), this.ws.onopen = () => { this.ws = new WebSocket(this.config.url), this.ws.onopen = () => {
this.log("Connected to WebSocket server"), this.setState("connected"), this.reconnectAttempts = 0, this.startHeartbeat(), this.emit("connect"), e(); this.log("Connected to WebSocket server"), this.setState("connected"), this.reconnectAttempts = 0, this.startHeartbeat(), this.emit("connect"), e();
}, this.ws.onmessage = (s) => { }, this.ws.onmessage = (e) => {
this.handleMessage(s.data); this.handleMessage(e.data);
}, this.ws.onerror = (s) => { }, this.ws.onerror = (e) => {
this.log("WebSocket error:", s); this.log("WebSocket error:", e);
const r = new Error("WebSocket connection error"); let n = /* @__PURE__ */ Error("WebSocket connection error");
this.emit("error", r), t(r); this.emit("error", n), t(n);
}, this.ws.onclose = (s) => { }, this.ws.onclose = (e) => {
this.log("WebSocket closed:", s.code, s.reason), this.stopHeartbeat(), this.setState("disconnected"), this.emit("disconnect", s), this.config.reconnect && !this.isManualClose && this.reconnectAttempts < this.config.maxReconnectAttempts && (this.reconnectAttempts++, this.log(`Reconnection attempt ${this.reconnectAttempts}/${this.config.maxReconnectAttempts}`), this.setState("reconnecting"), this.reconnectTimer = setTimeout(() => { this.log("WebSocket closed:", e.code, e.reason), this.stopHeartbeat(), this.setState("disconnected"), this.emit("disconnect", e), this.config.reconnect && !this.isManualClose && this.reconnectAttempts < this.config.maxReconnectAttempts && (this.reconnectAttempts++, this.log(`Reconnection attempt ${this.reconnectAttempts}/${this.config.maxReconnectAttempts}`), this.setState("reconnecting"), this.reconnectTimer = setTimeout(() => {
this.connect().catch((r) => { this.connect().catch((e) => {
this.log("Reconnection failed:", r); this.log("Reconnection failed:", e);
}); });
}, this.config.reconnectInterval)); }, this.config.reconnectInterval));
}; };
} catch (s) { } catch (e) {
t(s); t(e);
} }
}); });
} }
disconnect() { disconnect() {
this.isManualClose = !0, this.reconnectTimer && (clearTimeout(this.reconnectTimer), this.reconnectTimer = null), this.stopHeartbeat(), this.ws && (this.setState("disconnecting"), this.ws.close(), this.ws = null), this.setState("disconnected"), this.messageHandlers.clear(); this.isManualClose = !0, this.reconnectTimer &&= (clearTimeout(this.reconnectTimer), null), this.stopHeartbeat(), this.ws &&= (this.setState("disconnecting"), this.ws.close(), null), this.setState("disconnected"), this.messageHandlers.clear();
} }
async request(e, t, s) { async request(t, n, r) {
this.ensureConnected(); this.ensureConnected();
const r = l(), i = { let i = e(), a = {
id: r, id: i,
type: "request", type: "request",
operation: e, operation: t,
entity: t, entity: n,
schema: s?.schema, schema: r?.schema,
record_id: s?.record_id, record_id: r?.record_id,
data: s?.data, data: r?.data,
options: s?.options options: r?.options
}; };
return new Promise((a, c) => { return new Promise((e, t) => {
this.messageHandlers.set(r, (o) => { this.messageHandlers.set(i, (n) => {
o.success ? a(o.data) : c(new Error(o.error?.message || "Request failed")); n.success ? e(n.data) : t(Error(n.error?.message || "Request failed"));
}), this.send(i), setTimeout(() => { }), this.send(a), setTimeout(() => {
this.messageHandlers.has(r) && (this.messageHandlers.delete(r), c(new Error("Request timeout"))); this.messageHandlers.has(i) && (this.messageHandlers.delete(i), t(/* @__PURE__ */ Error("Request timeout")));
}, 3e4); }, 3e4);
}); });
} }
@@ -161,73 +179,68 @@ class p {
} }
}); });
} }
async create(e, t, s) { async create(e, t, n) {
return this.request("create", e, { return this.request("create", e, {
schema: s?.schema, schema: n?.schema,
data: t data: t
}); });
} }
async update(e, t, s, r) { async update(e, t, n, r) {
return this.request("update", e, { return this.request("update", e, {
schema: r?.schema, schema: r?.schema,
record_id: t, record_id: t,
data: s data: n
}); });
} }
async delete(e, t, s) { async delete(e, t, n) {
await this.request("delete", e, { await this.request("delete", e, {
schema: s?.schema, schema: n?.schema,
record_id: t record_id: t
}); });
} }
async meta(e, t) { async meta(e, t) {
return this.request("meta", e, { return this.request("meta", e, { schema: t?.schema });
schema: t?.schema
});
} }
async subscribe(e, t, s) { async subscribe(t, n, r) {
this.ensureConnected(); this.ensureConnected();
const r = l(), i = { let i = e(), a = {
id: r, id: i,
type: "subscription", type: "subscription",
operation: "subscribe", operation: "subscribe",
entity: e, entity: t,
schema: s?.schema, schema: r?.schema,
options: { options: { filters: r?.filters }
filters: s?.filters
}
}; };
return new Promise((a, c) => { return new Promise((e, o) => {
this.messageHandlers.set(r, (o) => { this.messageHandlers.set(i, (i) => {
if (o.success && o.data?.subscription_id) { if (i.success && i.data?.subscription_id) {
const h = o.data.subscription_id; let a = i.data.subscription_id;
this.subscriptions.set(h, { this.subscriptions.set(a, {
id: h, id: a,
entity: e, entity: t,
schema: s?.schema, schema: r?.schema,
options: { filters: s?.filters }, options: { filters: r?.filters },
callback: t callback: n
}), this.log(`Subscribed to ${e} with ID: ${h}`), a(h); }), this.log(`Subscribed to ${t} with ID: ${a}`), e(a);
} else } else o(Error(i.error?.message || "Subscription failed"));
c(new Error(o.error?.message || "Subscription failed")); }), this.send(a), setTimeout(() => {
}), this.send(i), setTimeout(() => { this.messageHandlers.has(i) && (this.messageHandlers.delete(i), o(/* @__PURE__ */ Error("Subscription timeout")));
this.messageHandlers.has(r) && (this.messageHandlers.delete(r), c(new Error("Subscription timeout")));
}, 1e4); }, 1e4);
}); });
} }
async unsubscribe(e) { async unsubscribe(t) {
this.ensureConnected(); this.ensureConnected();
const t = l(), s = { let n = e(), r = {
id: t, id: n,
type: "subscription", type: "subscription",
operation: "unsubscribe", operation: "unsubscribe",
subscription_id: e subscription_id: t
}; };
return new Promise((r, i) => { return new Promise((e, i) => {
this.messageHandlers.set(t, (a) => { this.messageHandlers.set(n, (n) => {
a.success ? (this.subscriptions.delete(e), this.log(`Unsubscribed from ${e}`), r()) : i(new Error(a.error?.message || "Unsubscribe failed")); n.success ? (this.subscriptions.delete(t), this.log(`Unsubscribed from ${t}`), e()) : i(Error(n.error?.message || "Unsubscribe failed"));
}), this.send(s), setTimeout(() => { }), this.send(r), setTimeout(() => {
this.messageHandlers.has(t) && (this.messageHandlers.delete(t), i(new Error("Unsubscribe timeout"))); this.messageHandlers.has(n) && (this.messageHandlers.delete(n), i(/* @__PURE__ */ Error("Unsubscribe timeout")));
}, 1e4); }, 1e4);
}); });
} }
@@ -246,10 +259,9 @@ class p {
off(e) { off(e) {
delete this.eventListeners[e]; delete this.eventListeners[e];
} }
// Private methods
handleMessage(e) { handleMessage(e) {
try { try {
const t = JSON.parse(e); let t = JSON.parse(e);
switch (this.log("Received message:", t), this.emit("message", t), t.type) { switch (this.log("Received message:", t), this.emit("message", t), t.type) {
case "response": case "response":
this.handleResponse(t); this.handleResponse(t);
@@ -257,213 +269,164 @@ class p {
case "notification": case "notification":
this.handleNotification(t); this.handleNotification(t);
break; break;
case "pong": case "pong": break;
break; default: this.log("Unknown message type:", t.type);
default:
this.log("Unknown message type:", t.type);
} }
} catch (t) { } catch (e) {
this.log("Error parsing message:", t); this.log("Error parsing message:", e);
} }
} }
handleResponse(e) { handleResponse(e) {
const t = this.messageHandlers.get(e.id); let t = this.messageHandlers.get(e.id);
t && (t(e), this.messageHandlers.delete(e.id)); t && (t(e), this.messageHandlers.delete(e.id));
} }
handleNotification(e) { handleNotification(e) {
const t = this.subscriptions.get(e.subscription_id); let t = this.subscriptions.get(e.subscription_id);
t?.callback && t.callback(e); t?.callback && t.callback(e);
} }
send(e) { send(e) {
if (!this.ws || this.ws.readyState !== WebSocket.OPEN) if (!this.ws || this.ws.readyState !== WebSocket.OPEN) throw Error("WebSocket is not connected");
throw new Error("WebSocket is not connected"); let t = JSON.stringify(e);
const t = JSON.stringify(e);
this.log("Sending message:", e), this.ws.send(t); this.log("Sending message:", e), this.ws.send(t);
} }
startHeartbeat() { startHeartbeat() {
this.heartbeatTimer || (this.heartbeatTimer = setInterval(() => { this.heartbeatTimer ||= setInterval(() => {
if (this.isConnected()) { if (this.isConnected()) {
const e = { let t = {
id: l(), id: e(),
type: "ping" type: "ping"
}; };
this.send(e); this.send(t);
} }
}, this.config.heartbeatInterval)); }, this.config.heartbeatInterval);
} }
stopHeartbeat() { stopHeartbeat() {
this.heartbeatTimer && (clearInterval(this.heartbeatTimer), this.heartbeatTimer = null); this.heartbeatTimer &&= (clearInterval(this.heartbeatTimer), null);
} }
setState(e) { setState(e) {
this.state !== e && (this.state = e, this.emit("stateChange", e)); this.state !== e && (this.state = e, this.emit("stateChange", e));
} }
ensureConnected() { ensureConnected() {
if (!this.isConnected()) if (!this.isConnected()) throw Error("WebSocket is not connected. Call connect() first.");
throw new Error("WebSocket is not connected. Call connect() first.");
} }
emit(e, ...t) { emit(e, ...t) {
const s = this.eventListeners[e]; let n = this.eventListeners[e];
s && s(...t); n && n(...t);
} }
log(...e) { log(...e) {
this.config.debug && console.log("[WebSocketClient]", ...e); this.config.debug && console.log("[WebSocketClient]", ...e);
} }
};
//#endregion
//#region src/headerspec/client.ts
function f(e) {
return "ZIP_" + n(e);
} }
function v(n) { function p(e) {
return typeof btoa == "function" ? "ZIP_" + btoa(n) : "ZIP_" + Buffer.from(n, "utf-8").toString("base64"); let t = e;
return t.startsWith("ZIP_") ? (t = t.slice(4).replace(/[\n\r ]/g, ""), t = m(t)) : t.startsWith("__") && (t = t.slice(2).replace(/[\n\r ]/g, ""), t = m(t)), (t.startsWith("ZIP_") || t.startsWith("__")) && (t = p(t)), t;
} }
function w(n) { function m(e) {
let e = n; return t(e);
return e.startsWith("ZIP_") ? (e = e.slice(4).replace(/[\n\r ]/g, ""), e = m(e)) : e.startsWith("__") && (e = e.slice(2).replace(/[\n\r ]/g, ""), e = m(e)), (e.startsWith("ZIP_") || e.startsWith("__")) && (e = w(e)), e;
} }
function m(n) { function h(e) {
return typeof atob == "function" ? atob(n) : Buffer.from(n, "base64").toString("utf-8"); let t = {};
} if (e.columns?.length && (t["X-Select-Fields"] = e.columns.join(",")), e.omit_columns?.length && (t["X-Not-Select-Fields"] = e.omit_columns.join(",")), e.filters?.length) for (let n of e.filters) {
function u(n) { let e = n.logic_operator ?? "AND", r = g(n.operator), i = _(n);
const e = {}; n.operator === "eq" && e === "AND" ? t[`X-FieldFilter-${n.column}`] = i : e === "OR" ? t[`X-SearchOr-${r}-${n.column}`] = i : t[`X-SearchOp-${r}-${n.column}`] = i;
if (n.columns?.length && (e["X-Select-Fields"] = n.columns.join(",")), n.omit_columns?.length && (e["X-Not-Select-Fields"] = n.omit_columns.join(",")), n.filters?.length)
for (const t of n.filters) {
const s = t.logic_operator ?? "AND", r = y(t.operator), i = S(t);
t.operator === "eq" && s === "AND" ? e[`X-FieldFilter-${t.column}`] = i : s === "OR" ? e[`X-SearchOr-${r}-${t.column}`] = i : e[`X-SearchOp-${r}-${t.column}`] = i;
} }
if (n.sort?.length) { if (e.sort?.length && (t["X-Sort"] = e.sort.map((e) => e.direction.toUpperCase() === "DESC" ? `-${e.column}` : `+${e.column}`).join(",")), e.limit !== void 0 && (t["X-Limit"] = String(e.limit)), e.offset !== void 0 && (t["X-Offset"] = String(e.offset)), e.cursor_forward && (t["X-Cursor-Forward"] = e.cursor_forward), e.cursor_backward && (t["X-Cursor-Backward"] = e.cursor_backward), e.preload?.length && (t["X-Preload"] = e.preload.map((e) => e.columns?.length ? `${e.relation}:${e.columns.join(",")}` : e.relation).join("|")), e.fetch_row_number && (t["X-Fetch-RowNumber"] = e.fetch_row_number), e.computedColumns?.length) for (let n of e.computedColumns) t[`X-CQL-SEL-${n.name}`] = n.expression;
const t = n.sort.map((s) => s.direction.toUpperCase() === "DESC" ? `-${s.column}` : `+${s.column}`); return e.customOperators?.length && (t["X-Custom-SQL-W"] = e.customOperators.map((e) => e.sql).join(" AND ")), t;
e["X-Sort"] = t.join(",");
}
if (n.limit !== void 0 && (e["X-Limit"] = String(n.limit)), n.offset !== void 0 && (e["X-Offset"] = String(n.offset)), n.cursor_forward && (e["X-Cursor-Forward"] = n.cursor_forward), n.cursor_backward && (e["X-Cursor-Backward"] = n.cursor_backward), n.preload?.length) {
const t = n.preload.map((s) => s.columns?.length ? `${s.relation}:${s.columns.join(",")}` : s.relation);
e["X-Preload"] = t.join("|");
}
if (n.fetch_row_number && (e["X-Fetch-RowNumber"] = n.fetch_row_number), n.computedColumns?.length)
for (const t of n.computedColumns)
e[`X-CQL-SEL-${t.name}`] = t.expression;
if (n.customOperators?.length) {
const t = n.customOperators.map(
(s) => s.sql
);
e["X-Custom-SQL-W"] = t.join(" AND ");
}
return e;
} }
function y(n) { function g(e) {
switch (n) { switch (e) {
case "eq": case "eq": return "equals";
return "equals"; case "neq": return "notequals";
case "neq": case "gt": return "greaterthan";
return "notequals"; case "gte": return "greaterthanorequal";
case "gt": case "lt": return "lessthan";
return "greaterthan"; case "lte": return "lessthanorequal";
case "gte":
return "greaterthanorequal";
case "lt":
return "lessthan";
case "lte":
return "lessthanorequal";
case "like": case "like":
case "ilike": case "ilike":
case "contains": case "contains": return "contains";
return "contains"; case "startswith": return "beginswith";
case "startswith": case "endswith": return "endswith";
return "beginswith"; case "in": return "in";
case "endswith": case "between": return "between";
return "endswith"; case "between_inclusive": return "betweeninclusive";
case "in": case "is_null": return "empty";
return "in"; case "is_not_null": return "notempty";
case "between": default: return e;
return "between";
case "between_inclusive":
return "betweeninclusive";
case "is_null":
return "empty";
case "is_not_null":
return "notempty";
default:
return n;
} }
} }
function S(n) { function _(e) {
return n.value === null || n.value === void 0 ? "" : Array.isArray(n.value) ? n.value.join(",") : String(n.value); return e.value === null || e.value === void 0 ? "" : Array.isArray(e.value) ? e.value.join(",") : String(e.value);
} }
const b = /* @__PURE__ */ new Map(); var v = /* @__PURE__ */ new Map();
function C(n) { function y(e) {
const e = n.baseUrl; let t = a(e), n = v.get(t);
let t = b.get(e); return n || (n = new b(e), v.set(t, n)), n;
return t || (t = new H(n), b.set(e, t)), t;
} }
class H { var b = class {
constructor(e) { constructor(e) {
this.config = e; this.config = {
...e,
headers: { ...e.headers }
};
} }
buildUrl(e, t, s) { buildUrl(e, t, n) {
let r = `${this.config.baseUrl}/${e}/${t}`; let r = `${this.config.baseUrl}/${e}/${t}`;
return s && (r += `/${s}`), r; return n && (r += `/${n}`), r;
} }
baseHeaders() { baseHeaders() {
const e = { return i(this.config);
"Content-Type": "application/json"
};
return this.config.token && (e.Authorization = `Bearer ${this.config.token}`), e;
} }
async fetchWithError(e, t) { async fetchWithError(e, t) {
const s = await fetch(e, t), r = await s.json(); let n = await fetch(e, t), r = await n.json();
if (!s.ok) if (!n.ok) throw Error(r.error?.message || `${n.statusText} (${n.status})`);
throw new Error(
r.error?.message || `${s.statusText} (${s.status})`
);
return { return {
data: r, data: r,
success: !0, success: !0,
error: r.error ? r.error : void 0, error: r.error ? r.error : void 0,
metadata: { metadata: {
count: s.headers.get("content-range") ? Number(s.headers.get("content-range")?.split("/")[1]) : 0, count: n.headers.get("content-range") ? Number(n.headers.get("content-range")?.split("/")[1]) : 0,
total: s.headers.get("content-range") ? Number(s.headers.get("content-range")?.split("/")[1]) : 0, total: n.headers.get("content-range") ? Number(n.headers.get("content-range")?.split("/")[1]) : 0,
filtered: s.headers.get("content-range") ? Number(s.headers.get("content-range")?.split("/")[1]) : 0, filtered: n.headers.get("content-range") ? Number(n.headers.get("content-range")?.split("/")[1]) : 0,
offset: s.headers.get("content-range") ? Number( offset: n.headers.get("content-range") ? Number(n.headers.get("content-range")?.split("/")[0].split("-")[0]) : 0,
s.headers.get("content-range")?.split("/")[0].split("-")[0] limit: n.headers.get("x-limit") ? Number(n.headers.get("x-limit")) : 0
) : 0,
limit: s.headers.get("x-limit") ? Number(s.headers.get("x-limit")) : 0
} }
}; };
} }
async read(e, t, s, r) { async read(e, t, n, i) {
const i = this.buildUrl(e, t, s), a = r ? u(r) : {}; let a = this.buildUrl(e, t, n), o = i ? h(i) : {};
return this.fetchWithError(i, {
method: "GET",
headers: { ...this.baseHeaders(), ...a }
});
}
async create(e, t, s, r) {
const i = this.buildUrl(e, t), a = r ? u(r) : {};
return this.fetchWithError(i, {
method: "POST",
headers: { ...this.baseHeaders(), ...a },
body: JSON.stringify(s)
});
}
async update(e, t, s, r, i) {
const a = this.buildUrl(e, t, s), c = i ? u(i) : {};
return this.fetchWithError(a, { return this.fetchWithError(a, {
method: "PUT", method: "GET",
headers: { ...this.baseHeaders(), ...c }, headers: r(this.baseHeaders(), o)
body: JSON.stringify(r)
}); });
} }
async delete(e, t, s) { async create(e, t, n, i) {
const r = this.buildUrl(e, t, s); let a = this.buildUrl(e, t), o = i ? h(i) : {};
return this.fetchWithError(a, {
method: "POST",
headers: r(this.baseHeaders(), o),
body: JSON.stringify(n)
});
}
async update(e, t, n, i, a) {
let o = this.buildUrl(e, t, n), s = a ? h(a) : {};
return this.fetchWithError(o, {
method: "PUT",
headers: r(this.baseHeaders(), s),
body: JSON.stringify(i)
});
}
async delete(e, t, n) {
let r = this.buildUrl(e, t, n);
return this.fetchWithError(r, { return this.fetchWithError(r, {
method: "DELETE", method: "DELETE",
headers: this.baseHeaders() headers: this.baseHeaders()
}); });
} }
}
export {
H as HeaderSpecClient,
g as ResolveSpecClient,
p as WebSocketClient,
u as buildHeaders,
w as decodeHeaderValue,
v as encodeHeaderValue,
C as getHeaderSpecClient,
E as getResolveSpecClient,
_ as getWebSocketClient
}; };
//#endregion
export { b as HeaderSpecClient, c as ResolveSpecClient, d as WebSocketClient, h as buildHeaders, p as decodeHeaderValue, f as encodeHeaderValue, y as getHeaderSpecClient, s as getResolveSpecClient, u as getWebSocketClient };
+14 -12
View File
@@ -1,6 +1,6 @@
{ {
"name": "@warkypublic/resolvespec-js", "name": "@warkypublic/resolvespec-js",
"version": "1.0.1", "version": "1.0.2",
"description": "TypeScript client library for ResolveSpec REST, HeaderSpec, and WebSocket APIs", "description": "TypeScript client library for ResolveSpec REST, HeaderSpec, and WebSocket APIs",
"type": "module", "type": "module",
"main": "./dist/index.cjs", "main": "./dist/index.cjs",
@@ -38,20 +38,22 @@
"author": "Hein (Warkanum) Puth", "author": "Hein (Warkanum) Puth",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"uuid": "^13.0.0" "@warkypublic/artemis-kit": "^1.0.10",
"uuid": "^14.0.2"
}, },
"devDependencies": { "devDependencies": {
"@changesets/cli": "^2.29.8", "@changesets/cli": "^3.0.3",
"@eslint/js": "^10.0.1", "@eslint/js": "^10.0.1",
"@types/jsdom": "^27.0.0", "@types/jsdom": "^30.0.0",
"eslint": "^10.0.0", "@types/node": "^26.6.2",
"globals": "^17.3.0", "eslint": "^10.11.0",
"jsdom": "^28.1.0", "globals": "^17.12.0",
"typescript": "^5.9.3", "jsdom": "^30.1.1",
"typescript-eslint": "^8.55.0", "typescript": "^6.0.3",
"vite": "^7.3.1", "typescript-eslint": "^8.70.1",
"vite-plugin-dts": "^4.5.4", "vite": "^8.3.0",
"vitest": "^4.0.18" "vite-plugin-dts": "^5.1.1",
"vitest": "^5.0.1"
}, },
"engines": { "engines": {
"node": ">=18" "node": ">=18"
+1283 -1293
View File
File diff suppressed because it is too large Load Diff
+5
View File
@@ -0,0 +1,5 @@
packages:
- '.'
allowBuilds:
esbuild: true
@@ -0,0 +1,65 @@
import { afterEach, describe, expect, it, vi } from 'vitest';
import { ResolveSpecClient, getResolveSpecClient } from '../resolvespec/client';
import { HeaderSpecClient, getHeaderSpecClient } from '../headerspec/client';
afterEach(() => vi.unstubAllGlobals());
for (const [name, Client, factory] of [
['ResolveSpec', ResolveSpecClient, getResolveSpecClient],
['HeaderSpec', HeaderSpecClient, getHeaderSpecClient],
] as const) {
describe(`${name} custom headers`, () => {
it('sends tenant headers on every operation and resolves collisions case-insensitively', async () => {
const fetchMock = vi.fn().mockResolvedValue({
ok: true, headers: new Headers(), json: async () => ({ success: true, data: [] }),
});
vi.stubGlobal('fetch', fetchMock);
const headers = { 'X-Tenant': 'acme', authorization: 'Basic ignored', 'content-type': 'application/custom+json', 'x-limit': '99' };
const client = new Client({ baseUrl: 'http://localhost:3000', token: 'tok', headers });
await client.read('public', 'users', undefined, { limit: 10 });
await client.create('public', 'users', {});
if (client instanceof ResolveSpecClient) {
await client.update('public', 'users', {}, '1');
await client.getMetadata('public', 'users');
} else {
await client.update('public', 'users', '1', {});
}
await client.delete('public', 'users', '1');
for (const [, init] of fetchMock.mock.calls) {
const sent = new Headers(init.headers);
expect(sent.get('x-tenant')).toBe('acme');
expect(sent.get('authorization')).toBe('Bearer tok');
expect(sent.get('content-type')).toBe('application/custom+json');
}
if (client instanceof HeaderSpecClient) {
expect(new Headers(fetchMock.mock.calls[0][1].headers).get('x-limit')).toBe('10');
}
expect(headers.authorization).toBe('Basic ignored');
expect(headers['x-limit']).toBe('99');
});
it('supports custom authentication without a token', async () => {
const fetchMock = vi.fn().mockResolvedValue({
ok: true, headers: new Headers(), json: async () => ({ success: true, data: [] }),
});
vi.stubGlobal('fetch', fetchMock);
await new Client({ baseUrl: 'http://localhost:3000', headers: { Authorization: 'Basic custom' } }).read('public', 'users');
expect(new Headers(fetchMock.mock.calls[0][1].headers).get('authorization')).toBe('Basic custom');
});
it('isolates cached clients by headers and token, and snapshots configuration', async () => {
const config = { baseUrl: 'http://tenant-cache', token: 'one', headers: { 'X-Tenant': 'acme', 'X-App': 'grid' } };
const first = factory(config);
expect(factory({ ...config, headers: { 'x-app': 'grid', 'x-tenant': 'acme' } })).toBe(first);
expect(factory({ ...config, token: 'two' })).not.toBe(first);
config.headers['X-Tenant'] = 'other';
expect(factory(config)).not.toBe(first);
const fetchMock = vi.fn().mockResolvedValue({
ok: true, headers: new Headers(), json: async () => ({ success: true, data: [] }),
});
vi.stubGlobal('fetch', fetchMock);
await first.read('public', 'users');
expect(new Headers(fetchMock.mock.calls[0][1].headers).get('x-tenant')).toBe('acme');
});
});
}
@@ -126,11 +126,22 @@ describe('encodeHeaderValue / decodeHeaderValue', () => {
expect(decoded).toBe(original); expect(decoded).toBe(original);
}); });
it('should round-trip UTF-8 values', () => {
const original = 'café ☕ 你好';
expect(decodeHeaderValue(encodeHeaderValue(original))).toBe(original);
});
it('should decode __ prefixed values', () => { it('should decode __ prefixed values', () => {
const encoded = '__' + btoa('hello'); const encoded = '__' + btoa('hello');
expect(decodeHeaderValue(encoded)).toBe('hello'); expect(decodeHeaderValue(encoded)).toBe('hello');
}); });
it('should decode UTF-8 values with the __ prefix', () => {
const bytes = new TextEncoder().encode('café ☕');
const binary = Array.from(bytes, (byte) => String.fromCharCode(byte)).join('');
expect(decodeHeaderValue('__' + btoa(binary))).toBe('café ☕');
});
it('should return plain values as-is', () => { it('should return plain values as-is', () => {
expect(decodeHeaderValue('plain')).toBe('plain'); expect(decodeHeaderValue('plain')).toBe('plain');
}); });
@@ -142,6 +153,7 @@ describe('HeaderSpecClient', () => {
function mockFetch<T>(data: APIResponse<T>, ok = true) { function mockFetch<T>(data: APIResponse<T>, ok = true) {
return vi.fn().mockResolvedValue({ return vi.fn().mockResolvedValue({
ok, ok,
headers: new Headers(),
json: () => Promise.resolve(data), json: () => Promise.resolve(data),
}); });
} }
+30
View File
@@ -0,0 +1,30 @@
import type { ClientConfig } from './types';
/** Merge HTTP headers case-insensitively, preserving the winning spelling. */
export function mergeHeaders(...sources: Record<string, string>[]): Record<string, string> {
const result: Record<string, string> = {};
for (const source of sources) {
for (const [name, value] of Object.entries(source)) {
for (const existing of Object.keys(result)) {
if (existing.toLowerCase() === name.toLowerCase()) delete result[existing];
}
Object.defineProperty(result, name, { value, enumerable: true, configurable: true, writable: true });
}
}
return result;
}
export function clientHeaders(config: ClientConfig): Record<string, string> {
return mergeHeaders(
{ 'Content-Type': 'application/json' },
config.headers ?? {},
config.token ? { Authorization: `Bearer ${config.token}` } : {},
);
}
export function clientCacheKey(config: ClientConfig): string {
const headers = Object.entries(clientHeaders(config))
.map(([name, value]) => [name.toLowerCase(), value])
.sort(([a], [b]) => a.localeCompare(b));
return JSON.stringify([config.baseUrl, headers]);
}
+2
View File
@@ -126,4 +126,6 @@ export interface TableMetadata {
export interface ClientConfig { export interface ClientConfig {
baseUrl: string; baseUrl: string;
token?: string; token?: string;
/** Custom HTTP headers. Token and HeaderSpec query options take precedence. */
headers?: Record<string, string>;
} }
+10 -20
View File
@@ -1,3 +1,5 @@
import { clientCacheKey, clientHeaders, mergeHeaders } from '../common/http';
import { b64DecodeUnicode, b64EncodeUnicode } from '@warkypublic/artemis-kit/base64';
import type { import type {
APIResponse, APIResponse,
ClientConfig, ClientConfig,
@@ -12,10 +14,7 @@ import type {
* Encode a value with base64 and ZIP_ prefix for complex header values. * Encode a value with base64 and ZIP_ prefix for complex header values.
*/ */
export function encodeHeaderValue(value: string): string { export function encodeHeaderValue(value: string): string {
if (typeof btoa === "function") { return "ZIP_" + b64EncodeUnicode(value);
return "ZIP_" + btoa(value);
}
return "ZIP_" + Buffer.from(value, "utf-8").toString("base64");
} }
/** /**
@@ -41,10 +40,7 @@ export function decodeHeaderValue(value: string): string {
} }
function decodeBase64(str: string): string { function decodeBase64(str: string): string {
if (typeof atob === "function") { return b64DecodeUnicode(str);
return atob(str);
}
return Buffer.from(str, "base64").toString("utf-8");
} }
/** /**
@@ -203,7 +199,7 @@ function formatFilterValue(filter: FilterOption): string {
const instances = new Map<string, HeaderSpecClient>(); const instances = new Map<string, HeaderSpecClient>();
export function getHeaderSpecClient(config: ClientConfig): HeaderSpecClient { export function getHeaderSpecClient(config: ClientConfig): HeaderSpecClient {
const key = config.baseUrl; const key = clientCacheKey(config);
let instance = instances.get(key); let instance = instances.get(key);
if (!instance) { if (!instance) {
instance = new HeaderSpecClient(config); instance = new HeaderSpecClient(config);
@@ -222,7 +218,7 @@ export class HeaderSpecClient {
private config: ClientConfig; private config: ClientConfig;
constructor(config: ClientConfig) { constructor(config: ClientConfig) {
this.config = config; this.config = { ...config, headers: { ...config.headers } };
} }
private buildUrl(schema: string, entity: string, id?: string): string { private buildUrl(schema: string, entity: string, id?: string): string {
@@ -234,13 +230,7 @@ export class HeaderSpecClient {
} }
private baseHeaders(): Record<string, string> { private baseHeaders(): Record<string, string> {
const headers: Record<string, string> = { return clientHeaders(this.config);
"Content-Type": "application/json",
};
if (this.config.token) {
headers["Authorization"] = `Bearer ${this.config.token}`;
}
return headers;
} }
private async fetchWithError<T>( private async fetchWithError<T>(
@@ -296,7 +286,7 @@ export class HeaderSpecClient {
const optHeaders = options ? buildHeaders(options) : {}; const optHeaders = options ? buildHeaders(options) : {};
return this.fetchWithError<T>(url, { return this.fetchWithError<T>(url, {
method: "GET", method: "GET",
headers: { ...this.baseHeaders(), ...optHeaders }, headers: mergeHeaders(this.baseHeaders(), optHeaders),
}); });
} }
@@ -310,7 +300,7 @@ export class HeaderSpecClient {
const optHeaders = options ? buildHeaders(options) : {}; const optHeaders = options ? buildHeaders(options) : {};
return this.fetchWithError<T>(url, { return this.fetchWithError<T>(url, {
method: "POST", method: "POST",
headers: { ...this.baseHeaders(), ...optHeaders }, headers: mergeHeaders(this.baseHeaders(), optHeaders),
body: JSON.stringify(data), body: JSON.stringify(data),
}); });
} }
@@ -326,7 +316,7 @@ export class HeaderSpecClient {
const optHeaders = options ? buildHeaders(options) : {}; const optHeaders = options ? buildHeaders(options) : {};
return this.fetchWithError<T>(url, { return this.fetchWithError<T>(url, {
method: "PUT", method: "PUT",
headers: { ...this.baseHeaders(), ...optHeaders }, headers: mergeHeaders(this.baseHeaders(), optHeaders),
body: JSON.stringify(data), body: JSON.stringify(data),
}); });
} }
+4 -11
View File
@@ -1,9 +1,10 @@
import { clientCacheKey, clientHeaders } from '../common/http';
import type { ClientConfig, APIResponse, TableMetadata, Options, RequestBody } from '../common/types'; import type { ClientConfig, APIResponse, TableMetadata, Options, RequestBody } from '../common/types';
const instances = new Map<string, ResolveSpecClient>(); const instances = new Map<string, ResolveSpecClient>();
export function getResolveSpecClient(config: ClientConfig): ResolveSpecClient { export function getResolveSpecClient(config: ClientConfig): ResolveSpecClient {
const key = config.baseUrl; const key = clientCacheKey(config);
let instance = instances.get(key); let instance = instances.get(key);
if (!instance) { if (!instance) {
instance = new ResolveSpecClient(config); instance = new ResolveSpecClient(config);
@@ -16,7 +17,7 @@ export class ResolveSpecClient {
private config: ClientConfig; private config: ClientConfig;
constructor(config: ClientConfig) { constructor(config: ClientConfig) {
this.config = config; this.config = { ...config, headers: { ...config.headers } };
} }
private buildUrl(schema: string, entity: string, id?: string): string { private buildUrl(schema: string, entity: string, id?: string): string {
@@ -28,15 +29,7 @@ export class ResolveSpecClient {
} }
private baseHeaders(): HeadersInit { private baseHeaders(): HeadersInit {
const headers: Record<string, string> = { return clientHeaders(this.config);
'Content-Type': 'application/json',
};
if (this.config.token) {
headers['Authorization'] = `Bearer ${this.config.token}`;
}
return headers;
} }
private async fetchWithError<T>(url: string, options: RequestInit): Promise<APIResponse<T>> { private async fetchWithError<T>(url: string, options: RequestInit): Promise<APIResponse<T>> {
+1 -1
View File
@@ -14,7 +14,7 @@ export default defineConfig({
fileName: (format) => `index.${format === 'es' ? 'js' : 'cjs'}`, fileName: (format) => `index.${format === 'es' ? 'js' : 'cjs'}`,
}, },
rollupOptions: { rollupOptions: {
external: ['uuid', 'semver'], external: ['uuid', 'semver', '@warkypublic/artemis-kit/base64'],
}, },
}, },
}); });