postgrest-parser 0.1.0 → 0.1.2

package/pkg/postgrest_parser_bg.wasm.d.ts

@@ -0,0 +1,27 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const __wbg_wasmqueryresult_free: (a: number, b: number) => void;
+export const buildFilterClause: (a: number, b: number) => void;
+export const initSchemaFromDb: (a: number) => number;
+export const parseDelete: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+export const parseInsert: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
+export const parseOnly: (a: number, b: number, c: number) => void;
+export const parseQueryString: (a: number, b: number, c: number, d: number, e: number) => void;
+export const parseRequest: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number) => void;
+export const parseRpc: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
+export const parseUpdate: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
+export const wasmqueryresult_params: (a: number) => number;
+export const wasmqueryresult_query: (a: number, b: number) => void;
+export const wasmqueryresult_tables: (a: number) => number;
+export const wasmqueryresult_toJSON: (a: number) => number;
+export const init_panic_hook: () => void;
+export const __wasm_bindgen_func_elem_344: (a: number, b: number) => void;
+export const __wasm_bindgen_func_elem_345: (a: number, b: number, c: number, d: number) => void;
+export const __wasm_bindgen_func_elem_416: (a: number, b: number, c: number, d: number) => void;
+export const __wbindgen_export: (a: number, b: number) => number;
+export const __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+export const __wbindgen_export3: (a: number) => void;
+export const __wbindgen_export4: (a: number, b: number, c: number) => void;
+export const __wbindgen_add_to_stack_pointer: (a: number) => number;
+export const __wbindgen_start: () => void;

package/pkg/tsconfig.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM"],
+    "moduleResolution": "bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationMap": false,
+    "sourceMap": false,
+    "outDir": ".",
+    "rootDir": ".",
+    "noEmit": false,
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": [
+    "types.ts",
+    "client.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}

package/pkg/types.d.ts

@@ -0,0 +1,174 @@
+/**
+ * Type-safe TypeScript definitions for PostgREST Parser
+ *
+ * This file provides strongly-typed interfaces that replace the `any` types
+ * in the auto-generated wasm bindings, improving TypeScript developer experience.
+ */
+/**
+ * Supported HTTP methods for PostgREST operations
+ */
+export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+/**
+ * SQL parameter value types
+ */
+export type SqlValue = string | number | boolean | null;
+/**
+ * Array of SQL parameter values (can include arrays for IN operator)
+ */
+export type SqlParam = SqlValue | string[];
+/**
+ * Query result containing SQL query, parameters, and affected tables
+ */
+export interface QueryResult {
+    /** The generated SQL query string */
+    query: string;
+    /** Parameterized values for the query ($1, $2, etc.) */
+    params: SqlParam[];
+    /** List of tables referenced in the query */
+    tables: string[];
+}
+/**
+ * PostgREST filter operators
+ */
+export type FilterOperator = "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "like" | "ilike" | "match" | "imatch" | "in" | "is" | "fts" | "plfts" | "phfts" | "wfts" | "cs" | "cd" | "ov" | "sl" | "sr" | "nxr" | "nxl" | "adj";
+/**
+ * Single filter condition
+ */
+export interface Filter {
+    column: string;
+    operator: FilterOperator;
+    value: string | string[];
+    negate?: boolean;
+}
+/**
+ * Logic tree for complex filters (AND/OR/NOT)
+ */
+export interface LogicCondition {
+    operator: "and" | "or" | "not";
+    conditions: (Filter | LogicCondition)[];
+}
+/**
+ * Order direction
+ */
+export type OrderDirection = "asc" | "desc";
+/**
+ * Nulls position in ordering
+ */
+export type NullsPosition = "first" | "last";
+/**
+ * Single order clause
+ */
+export interface OrderBy {
+    column: string;
+    direction: OrderDirection;
+    nulls?: NullsPosition;
+}
+/**
+ * Parsed query parameters
+ */
+export interface ParsedQuery {
+    select?: string[];
+    filters?: (Filter | LogicCondition)[];
+    order?: OrderBy[];
+    limit?: number;
+    offset?: number;
+    on_conflict?: string[];
+    returning?: string[];
+}
+/**
+ * PostgREST Prefer header options
+ */
+export interface PreferOptions {
+    /** Return representation: "minimal" | "representation" | "headers-only" */
+    return?: "minimal" | "representation" | "headers-only";
+    /** Resolution for conflicts: "merge-duplicates" | "ignore-duplicates" */
+    resolution?: "merge-duplicates" | "ignore-duplicates";
+    /** Missing columns behavior: "default" | "null" */
+    missing?: "default" | "null";
+    /** Count algorithm: "exact" | "planned" | "estimated" */
+    count?: "exact" | "planned" | "estimated";
+}
+/**
+ * Request headers (type-safe alternative to JSON string)
+ */
+export interface RequestHeaders {
+    Prefer?: string;
+    [key: string]: string | undefined;
+}
+/**
+ * Query options for SELECT operations
+ */
+export interface SelectOptions {
+    /** Columns to select (comma-separated or array) */
+    select?: string | string[];
+    /** Filter conditions */
+    filters?: Record<string, string>;
+    /** Order by clauses */
+    order?: string | string[];
+    /** Limit number of results */
+    limit?: number;
+    /** Offset for pagination */
+    offset?: number;
+    /** Count total rows */
+    count?: "exact" | "planned" | "estimated";
+}
+/**
+ * Insert options
+ */
+export interface InsertOptions {
+    /** Columns to return (default: "*") */
+    returning?: string | string[];
+    /** Columns to use for conflict resolution */
+    onConflict?: string | string[];
+    /** Prefer header options */
+    prefer?: PreferOptions;
+}
+/**
+ * Update options
+ */
+export interface UpdateOptions {
+    /** Columns to return */
+    returning?: string | string[];
+    /** Prefer header options */
+    prefer?: PreferOptions;
+}
+/**
+ * Delete options
+ */
+export interface DeleteOptions {
+    /** Columns to return */
+    returning?: string | string[];
+    /** Prefer header options */
+    prefer?: PreferOptions;
+}
+/**
+ * RPC function options
+ */
+export interface RpcOptions {
+    /** Columns to select from function result */
+    select?: string | string[];
+    /** Filter function results */
+    filters?: Record<string, string>;
+    /** Order function results */
+    order?: string | string[];
+    /** Limit function results */
+    limit?: number;
+    /** Offset for pagination */
+    offset?: number;
+}
+/**
+ * Error thrown by the parser
+ */
+export declare class PostgRESTParserError extends Error {
+    readonly kind: "parse" | "sql_generation" | "invalid_input";
+    constructor(message: string, kind: "parse" | "sql_generation" | "invalid_input");
+}
+/**
+ * Filter clause result
+ */
+export interface FilterClause {
+    /** WHERE clause SQL string */
+    clause: string;
+    /** Parameter values for the clause */
+    params: SqlParam[];
+}

package/pkg/types.js

@@ -0,0 +1,16 @@
+/**
+ * Type-safe TypeScript definitions for PostgREST Parser
+ *
+ * This file provides strongly-typed interfaces that replace the `any` types
+ * in the auto-generated wasm bindings, improving TypeScript developer experience.
+ */
+/**
+ * Error thrown by the parser
+ */
+export class PostgRESTParserError extends Error {
+    constructor(message, kind) {
+        super(message);
+        this.kind = kind;
+        this.name = "PostgRESTParserError";
+    }
+}

package/pkg/types.ts

@@ -0,0 +1,203 @@
+/**
+ * Type-safe TypeScript definitions for PostgREST Parser
+ *
+ * This file provides strongly-typed interfaces that replace the `any` types
+ * in the auto-generated wasm bindings, improving TypeScript developer experience.
+ */
+
+/**
+ * Supported HTTP methods for PostgREST operations
+ */
+export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+
+/**
+ * SQL parameter value types
+ */
+export type SqlValue = string | number | boolean | null;
+
+/**
+ * Array of SQL parameter values (can include arrays for IN operator)
+ */
+export type SqlParam = SqlValue | string[];
+
+/**
+ * Query result containing SQL query, parameters, and affected tables
+ */
+export interface QueryResult {
+  /** The generated SQL query string */
+  query: string;
+  /** Parameterized values for the query ($1, $2, etc.) */
+  params: SqlParam[];
+  /** List of tables referenced in the query */
+  tables: string[];
+}
+
+/**
+ * PostgREST filter operators
+ */
+export type FilterOperator =
+  | "eq" | "neq" | "gt" | "gte" | "lt" | "lte"
+  | "like" | "ilike" | "match" | "imatch"
+  | "in" | "is" | "fts" | "plfts" | "phfts" | "wfts"
+  | "cs" | "cd" | "ov" | "sl" | "sr" | "nxr" | "nxl" | "adj";
+
+/**
+ * Single filter condition
+ */
+export interface Filter {
+  column: string;
+  operator: FilterOperator;
+  value: string | string[];
+  negate?: boolean;
+}
+
+/**
+ * Logic tree for complex filters (AND/OR/NOT)
+ */
+export interface LogicCondition {
+  operator: "and" | "or" | "not";
+  conditions: (Filter | LogicCondition)[];
+}
+
+/**
+ * Order direction
+ */
+export type OrderDirection = "asc" | "desc";
+
+/**
+ * Nulls position in ordering
+ */
+export type NullsPosition = "first" | "last";
+
+/**
+ * Single order clause
+ */
+export interface OrderBy {
+  column: string;
+  direction: OrderDirection;
+  nulls?: NullsPosition;
+}
+
+/**
+ * Parsed query parameters
+ */
+export interface ParsedQuery {
+  select?: string[];
+  filters?: (Filter | LogicCondition)[];
+  order?: OrderBy[];
+  limit?: number;
+  offset?: number;
+  on_conflict?: string[];
+  returning?: string[];
+}
+
+/**
+ * PostgREST Prefer header options
+ */
+export interface PreferOptions {
+  /** Return representation: "minimal" | "representation" | "headers-only" */
+  return?: "minimal" | "representation" | "headers-only";
+  /** Resolution for conflicts: "merge-duplicates" | "ignore-duplicates" */
+  resolution?: "merge-duplicates" | "ignore-duplicates";
+  /** Missing columns behavior: "default" | "null" */
+  missing?: "default" | "null";
+  /** Count algorithm: "exact" | "planned" | "estimated" */
+  count?: "exact" | "planned" | "estimated";
+}
+
+/**
+ * Request headers (type-safe alternative to JSON string)
+ */
+export interface RequestHeaders {
+  Prefer?: string;
+  [key: string]: string | undefined;
+}
+
+/**
+ * Query options for SELECT operations
+ */
+export interface SelectOptions {
+  /** Columns to select (comma-separated or array) */
+  select?: string | string[];
+  /** Filter conditions */
+  filters?: Record<string, string>;
+  /** Order by clauses */
+  order?: string | string[];
+  /** Limit number of results */
+  limit?: number;
+  /** Offset for pagination */
+  offset?: number;
+  /** Count total rows */
+  count?: "exact" | "planned" | "estimated";
+}
+
+/**
+ * Insert options
+ */
+export interface InsertOptions {
+  /** Columns to return (default: "*") */
+  returning?: string | string[];
+  /** Columns to use for conflict resolution */
+  onConflict?: string | string[];
+  /** Prefer header options */
+  prefer?: PreferOptions;
+}
+
+/**
+ * Update options
+ */
+export interface UpdateOptions {
+  /** Columns to return */
+  returning?: string | string[];
+  /** Prefer header options */
+  prefer?: PreferOptions;
+}
+
+/**
+ * Delete options
+ */
+export interface DeleteOptions {
+  /** Columns to return */
+  returning?: string | string[];
+  /** Prefer header options */
+  prefer?: PreferOptions;
+}
+
+/**
+ * RPC function options
+ */
+export interface RpcOptions {
+  /** Columns to select from function result */
+  select?: string | string[];
+  /** Filter function results */
+  filters?: Record<string, string>;
+  /** Order function results */
+  order?: string | string[];
+  /** Limit function results */
+  limit?: number;
+  /** Offset for pagination */
+  offset?: number;
+}
+
+/**
+ * Error thrown by the parser
+ */
+export class PostgRESTParserError extends Error {
+  constructor(
+    message: string,
+    public readonly kind: "parse" | "sql_generation" | "invalid_input"
+  ) {
+    super(message);
+    this.name = "PostgRESTParserError";
+  }
+}
+
+/**
+ * Filter clause result
+ */
+export interface FilterClause {
+  /** WHERE clause SQL string */
+  clause: string;
+  /** Parameter values for the clause */
+  params: SqlParam[];
+}