wdevs/ResolveSpec
3
0
Fork 0
mirror of https://github.com/bitechdev/ResolveSpec.git synced 2026-02-16 05:16:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor(headerspec): improve code formatting and consistency

Browse Source
This commit is contained in:
Warky
2026-02-15 19:49:29 +02:00
parent dc85008d7f
commit b76dae5991
1 changed files with 265 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

177
resolvespec-js/src/headerspec/client.ts
View File

@@ -1,21 +1,21 @@
import type {
ClientConfig,
APIResponse,
Options,
FilterOption,
SortOption,
PreloadOption,
ClientConfig,
CustomOperator,
} from '../common/types';
FilterOption,
Options,
PreloadOption,
SortOption,
} from "../common/types";
/**
* Encode a value with base64 and ZIP_ prefix for complex header values.
*/
export function encodeHeaderValue(value: string): string {
if (typeof btoa === 'function') {
return 'ZIP_' + btoa(value);
if (typeof btoa === "function") {
return "ZIP_" + btoa(value);
}
return 'ZIP_' + Buffer.from(value, 'utf-8').toString('base64');
return "ZIP_" + Buffer.from(value, "utf-8").toString("base64");
}
/**
@@ -24,16 +24,16 @@ export function encodeHeaderValue(value: string): string {
export function decodeHeaderValue(value: string): string {
let code = value;
if (code.startsWith('ZIP_')) {
code = code.slice(4).replace(/[\n\r ]/g, '');
if (code.startsWith("ZIP_")) {
code = code.slice(4).replace(/[\n\r ]/g, "");
code = decodeBase64(code);
} else if (code.startsWith('__')) {
code = code.slice(2).replace(/[\n\r ]/g, '');
} else if (code.startsWith("__")) {
code = code.slice(2).replace(/[\n\r ]/g, "");
code = decodeBase64(code);
}
// Handle nested encoding
if (code.startsWith('ZIP_') || code.startsWith('__')) {
if (code.startsWith("ZIP_") || code.startsWith("__")) {
code = decodeHeaderValue(code);
}
@@ -41,10 +41,10 @@ export function decodeHeaderValue(value: string): string {
}
function decodeBase64(str: string): string {
if (typeof atob === 'function') {
if (typeof atob === "function") {
return atob(str);
}
return Buffer.from(str, 'base64').toString('utf-8');
return Buffer.from(str, "base64").toString("utf-8");
}
/**
@@ -69,24 +69,24 @@ export function buildHeaders(options: Options): Record<string, string> {
// Column selection
if (options.columns?.length) {
headers['X-Select-Fields'] = options.columns.join(',');
headers["X-Select-Fields"] = options.columns.join(",");
}
if (options.omit_columns?.length) {
headers['X-Not-Select-Fields'] = options.omit_columns.join(',');
headers["X-Not-Select-Fields"] = options.omit_columns.join(",");
}
// Filters
if (options.filters?.length) {
for (const filter of options.filters) {
const logicOp = filter.logic_operator ?? 'AND';
const logicOp = filter.logic_operator ?? "AND";
const op = mapOperatorToHeaderOp(filter.operator);
const valueStr = formatFilterValue(filter);
if (filter.operator === 'eq' && logicOp === 'AND') {
if (filter.operator === "eq" && logicOp === "AND") {
// Simple field filter shorthand
headers[`X-FieldFilter-${filter.column}`] = valueStr;
} else if (logicOp === 'OR') {
} else if (logicOp === "OR") {
headers[`X-SearchOr-${op}-${filter.column}`] = valueStr;
} else {
headers[`X-SearchOp-${op}-${filter.column}`] = valueStr;
@@ -98,41 +98,41 @@ export function buildHeaders(options: Options): Record<string, string> {
if (options.sort?.length) {
const sortParts = options.sort.map((s: SortOption) => {
const dir = s.direction.toUpperCase();
return dir === 'DESC' ? `-${s.column}` : `+${s.column}`;
return dir === "DESC" ? `-${s.column}` : `+${s.column}`;
});
headers['X-Sort'] = sortParts.join(',');
headers["X-Sort"] = sortParts.join(",");
}
// Pagination
if (options.limit !== undefined) {
headers['X-Limit'] = String(options.limit);
headers["X-Limit"] = String(options.limit);
}
if (options.offset !== undefined) {
headers['X-Offset'] = String(options.offset);
headers["X-Offset"] = String(options.offset);
}
// Cursor pagination
if (options.cursor_forward) {
headers['X-Cursor-Forward'] = options.cursor_forward;
headers["X-Cursor-Forward"] = options.cursor_forward;
}
if (options.cursor_backward) {
headers['X-Cursor-Backward'] = options.cursor_backward;
headers["X-Cursor-Backward"] = options.cursor_backward;
}
// Preload
if (options.preload?.length) {
const parts = options.preload.map((p: PreloadOption) => {
if (p.columns?.length) {
return `${p.relation}:${p.columns.join(',')}`;
return `${p.relation}:${p.columns.join(",")}`;
}
return p.relation;
});
headers['X-Preload'] = parts.join('|');
headers["X-Preload"] = parts.join("|");
}
// Fetch row number
if (options.fetch_row_number) {
headers['X-Fetch-RowNumber'] = options.fetch_row_number;
headers["X-Fetch-RowNumber"] = options.fetch_row_number;
}
// Computed columns
@@ -144,8 +144,10 @@ export function buildHeaders(options: Options): Record<string, string> {
// Custom operators -> X-Custom-SQL-W
if (options.customOperators?.length) {
const sqlParts = options.customOperators.map((co: CustomOperator) => co.sql);
headers['X-Custom-SQL-W'] = sqlParts.join(' AND ');
const sqlParts = options.customOperators.map(
(co: CustomOperator) => co.sql,
);
headers["X-Custom-SQL-W"] = sqlParts.join(" AND ");
}
return headers;
@@ -153,32 +155,47 @@ export function buildHeaders(options: Options): Record<string, string> {
function mapOperatorToHeaderOp(operator: string): string {
switch (operator) {
case 'eq': return 'equals';
case 'neq': return 'notequals';
case 'gt': return 'greaterthan';
case 'gte': return 'greaterthanorequal';
case 'lt': return 'lessthan';
case 'lte': return 'lessthanorequal';
case 'like':
case 'ilike':
case 'contains': return 'contains';
case 'startswith': return 'beginswith';
case 'endswith': return 'endswith';
case 'in': return 'in';
case 'between': return 'between';
case 'between_inclusive': return 'betweeninclusive';
case 'is_null': return 'empty';
case 'is_not_null': return 'notempty';
default: return operator;
case "eq":
return "equals";
case "neq":
return "notequals";
case "gt":
return "greaterthan";
case "gte":
return "greaterthanorequal";
case "lt":
return "lessthan";
case "lte":
return "lessthanorequal";
case "like":
case "ilike":
case "contains":
return "contains";
case "startswith":
return "beginswith";
case "endswith":
return "endswith";
case "in":
return "in";
case "between":
return "between";
case "between_inclusive":
return "betweeninclusive";
case "is_null":
return "empty";
case "is_not_null":
return "notempty";
default:
return operator;
}
}
function formatFilterValue(filter: FilterOption): string {
if (filter.value === null || filter.value === undefined) {
return '';
return "";
}
if (Array.isArray(filter.value)) {
return filter.value.join(',');
return filter.value.join(",");
}
return String(filter.value);
}
@@ -218,35 +235,67 @@ export class HeaderSpecClient {
private baseHeaders(): Record<string, string> {
const headers: Record<string, string> = {
'Content-Type': 'application/json',
"Content-Type": "application/json",
};
if (this.config.token) {
headers['Authorization'] = `Bearer ${this.config.token}`;
headers["Authorization"] = `Bearer ${this.config.token}`;
}
return headers;
}
private async fetchWithError<T>(url: string, init: RequestInit): Promise<APIResponse<T>> {
private async fetchWithError<T>(
url: string,
init: RequestInit,
): Promise<APIResponse<T>> {
const response = await fetch(url, init);
const data = await response.json();
if (!response.ok) {
throw new Error(data.error?.message || 'An error occurred');
throw new Error(
data.error?.message ||
`${response.statusText} ` + `(${response.status})`,
);
}
return data;
return {
data: data,
success: true,
error: data.error ? data.error : undefined,
metadata: {
count: response.headers.get("content-range")
? Number(response.headers.get("content-range")?.split("/")[1])
: 0,
total: response.headers.get("content-range")
? Number(response.headers.get("content-range")?.split("/")[1])
: 0,
filtered: response.headers.get("content-range")
? Number(response.headers.get("content-range")?.split("/")[1])
: 0,
offset: response.headers.get("content-range")
? Number(
response.headers
.get("content-range")
?.split("/")[0]
.split("-")[0],
)
: 0,
limit: response.headers.get("x-limit")
? Number(response.headers.get("x-limit"))
: 0,
},
};
}
async read<T = any>(
schema: string,
entity: string,
id?: string,
options?: Options
options?: Options,
): Promise<APIResponse<T>> {
const url = this.buildUrl(schema, entity, id);
const optHeaders = options ? buildHeaders(options) : {};
return this.fetchWithError<T>(url, {
method: 'GET',
method: "GET",
headers: { ...this.baseHeaders(), ...optHeaders },
});
}
@@ -255,12 +304,12 @@ export class HeaderSpecClient {
schema: string,
entity: string,
data: any,
options?: Options
options?: Options,
): Promise<APIResponse<T>> {
const url = this.buildUrl(schema, entity);
const optHeaders = options ? buildHeaders(options) : {};
return this.fetchWithError<T>(url, {
method: 'POST',
method: "POST",
headers: { ...this.baseHeaders(), ...optHeaders },
body: JSON.stringify(data),
});
@@ -271,12 +320,12 @@ export class HeaderSpecClient {
entity: string,
id: string,
data: any,
options?: Options
options?: Options,
): Promise<APIResponse<T>> {
const url = this.buildUrl(schema, entity, id);
const optHeaders = options ? buildHeaders(options) : {};
return this.fetchWithError<T>(url, {
method: 'PUT',
method: "PUT",
headers: { ...this.baseHeaders(), ...optHeaders },
body: JSON.stringify(data),
});
@@ -285,11 +334,11 @@ export class HeaderSpecClient {
async delete(
schema: string,
entity: string,
id: string
id: string,
): Promise<APIResponse<void>> {
const url = this.buildUrl(schema, entity, id);
return this.fetchWithError<void>(url, {
method: 'DELETE',
method: "DELETE",
headers: this.baseHeaders(),
});
}