@restura/core 1.6.0 → 1.8.0

package/dist/index.d.ts

@@ -40,6 +40,10 @@ declare const loggerConfigSchema: z.ZodObject<{
 }, z.core.$strip>;
 type LoggerConfigSchema = z.infer<typeof loggerConfigSchema>;
 
+/**
+ * @deprecated This is used for passing around until we finally get to the sending externally
+ * // TODO: Remove once backwards compatibility is no longer needed
+ */
 interface RsErrorInternalData<T extends Record<string, unknown> = Record<string, unknown>> {
     err: ErrorCode;
     msg: string;
@@ -70,13 +74,13 @@ declare enum HtmlStatusCodes {
     NETWORK_CONNECT_TIMEOUT = 599
 }
 type ErrorCode = 'BAD_REQUEST' | 'UNAUTHORIZED' | 'PAYMENT_REQUIRED' | 'FORBIDDEN' | 'NOT_FOUND' | 'METHOD_NOT_ALLOWED' | 'REQUEST_TIMEOUT' | 'CONFLICT' | 'GONE' | 'PAYLOAD_TOO_LARGE' | 'UNSUPPORTED_MEDIA_TYPE' | 'UPGRADE_REQUIRED' | 'UNPROCESSABLE_ENTITY' | 'TOO_MANY_REQUESTS' | 'SERVER_ERROR' | 'NOT_IMPLEMENTED' | 'BAD_GATEWAY' | 'SERVICE_UNAVAILABLE' | 'GATEWAY_TIMEOUT' | 'NETWORK_CONNECT_TIMEOUT' | 'UNKNOWN_ERROR' | 'RATE_LIMIT_EXCEEDED' | 'INVALID_TOKEN' | 'INCORRECT_EMAIL_OR_PASSWORD' | 'DUPLICATE' | 'CONNECTION_ERROR' | 'SCHEMA_ERROR' | 'DATABASE_ERROR';
-declare class RsError<T extends Record<string, unknown> = Record<string, unknown>> {
+declare class RsError<T extends Record<string, unknown> = Record<string, unknown>> extends Error {
     err: ErrorCode;
     msg: string;
     options?: T;
     status?: number;
-    stack: string;
     constructor(errCode: ErrorCode, message?: string, options?: T);
+    toJSON(): Record<string, unknown>;
     static htmlStatus(code: ErrorCode): number;
     static isRsError(error: unknown): error is RsError;
 }
@@ -168,7 +172,7 @@ declare const responseDataSchema: z.ZodObject<{
                 OR: "OR";
             }>>;
         }, z.core.$strict>>;
-        properties: z.ZodArray<z.ZodObject<any, z.core.$strict>>;
+        properties: z.ZodArray<z.ZodObject</*elided*/ any, z.core.$strict>>;
         groupBy: z.ZodOptional<z.ZodObject<{
             columnName: z.ZodString;
             tableName: z.ZodString;
@@ -311,7 +315,7 @@ declare const standardRouteSchema: z.ZodObject<{
                     OR: "OR";
                 }>>;
             }, z.core.$strict>>;
-            properties: z.ZodArray<z.ZodObject<any, z.core.$strict>>;
+            properties: z.ZodArray<z.ZodObject</*elided*/ any, z.core.$strict>>;
             groupBy: z.ZodOptional<z.ZodObject<{
                 columnName: z.ZodString;
                 tableName: z.ZodString;
@@ -736,7 +740,7 @@ declare const resturaSchema: z.ZodObject<{
                             OR: "OR";
                         }>>;
                     }, z.core.$strict>>;
-                    properties: z.ZodArray<z.ZodObject<any, z.core.$strict>>;
+                    properties: z.ZodArray<z.ZodObject</*elided*/ any, z.core.$strict>>;
                     groupBy: z.ZodOptional<z.ZodObject<{
                         columnName: z.ZodString;
                         tableName: z.ZodString;
@@ -1193,10 +1197,16 @@ declare function questionMarksToOrderedParams(query: string): string;
 /**
  * Creates a query to insert an object into a table.
  * @param table Table name to insert the object into
- * @param obj  Data to insert into the table
- * @returns the query to insert the object into the table
+ * @param obj Data to insert into the table
+ * @param options.customSelect Optional custom SELECT clause that wraps the INSERT in a CTE.
+ *        When provided, the INSERT is wrapped in `WITH inserted AS (INSERT ... RETURNING *)`,
+ *        and your customSelect should reference the `inserted` alias.
+ *        Example: `{ customSelect: 'SELECT i.*, u.email FROM inserted i JOIN "user" u ON i."userId" = u.id' }`
+ * @returns The query to insert the object into the table
  */
-declare function insertObjectQuery(table: string, obj: DynamicObject): string;
+declare function insertObjectQuery(table: string, obj: DynamicObject, options?: {
+    customSelect?: string;
+}): string;
 /**
  * Creates a query to update an object in a table.
  * @param table Table name to update the object in
@@ -1216,5 +1226,18 @@ declare function isValueNumber(value: unknown): value is number;
  * @returns An escaped query with user input
  */
 declare function SQL(strings: TemplateStringsArray, ...values: unknown[]): string;
+/**
+ * Converts a JavaScript value to its PostgreSQL literal representation.
+ * Used for debug logging of SQL queries — NOT for building actual queries
+ * (use parameterized queries for that).
+ *
+ * @example
+ * toSqlLiteral('hello')     // "'hello'"
+ * toSqlLiteral(42)          // "42"
+ * toSqlLiteral(true)        // "TRUE"
+ * toSqlLiteral(null)        // "NULL"
+ * toSqlLiteral([1, 2])      // "ARRAY[1, 2]"
+ */
+declare function toSqlLiteral(value: unknown): string;
 
-export { type ActionColumnChangeData, type ActionColumnChangeFilter, type ActionRowDeleteData, type ActionRowDeleteFilter, type ActionRowInsertData, type ActionRowInsertFilter, type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticatedRequesterDetails, type ConjunctionTypes, type DatabaseActionData, type DynamicObject, type ErrorCode, type EventType, HtmlStatusCodes, type LoggerConfigSchema, type MatchTypes, type MutationType, type OnValidAuthenticationCallback, type PageQuery, PsqlConnection, PsqlEngine, PsqlPool, PsqlTransaction, type QueryMetadata, type RequesterDetails, type ResturaConfigSchema, type ResturaSchema, RsError, type RsErrorData, type RsErrorInternalData, type RsHeaders, type RsPagedResponseData, type RsRequest, type RsResponse, type RsResponseData, type RsRouteHandler, SQL, type SchemaChangeValue, type SchemaPreview, type SqlMutationData, type StandardOrderTypes, type TriggerResult, apiGenerator, escapeColumnName, eventManager, filterPsqlParser, insertObjectQuery, isSchemaValid, isValueNumber, logger, modelGenerator, questionMarksToOrderedParams, restura, resturaGlobalTypesGenerator, resturaSchema, updateObjectQuery };
+export { type ActionColumnChangeData, type ActionColumnChangeFilter, type ActionRowDeleteData, type ActionRowDeleteFilter, type ActionRowInsertData, type ActionRowInsertFilter, type ApiMethod, type AsyncExpressApplication, type AuthenticateHandler, type AuthenticatedRequesterDetails, type ConjunctionTypes, type DatabaseActionData, type DynamicObject, type ErrorCode, type EventType, HtmlStatusCodes, type LoggerConfigSchema, type MatchTypes, type MutationType, type OnValidAuthenticationCallback, type PageQuery, PsqlConnection, PsqlEngine, PsqlPool, PsqlTransaction, type QueryMetadata, type RequesterDetails, type ResturaConfigSchema, type ResturaSchema, RsError, type RsErrorData, type RsErrorInternalData, type RsHeaders, type RsPagedResponseData, type RsRequest, type RsResponse, type RsResponseData, type RsRouteHandler, SQL, type SchemaChangeValue, type SchemaPreview, type SqlMutationData, type StandardOrderTypes, type TriggerResult, apiGenerator, escapeColumnName, eventManager, filterPsqlParser, insertObjectQuery, isSchemaValid, isValueNumber, logger, modelGenerator, questionMarksToOrderedParams, restura, resturaGlobalTypesGenerator, resturaSchema, toSqlLiteral, updateObjectQuery };