@restura/core 1.3.0 → 1.5.0

package/dist/index.d.ts

@@ -984,6 +984,7 @@ declare class ResturaEngine {
     private responseValidator;
     private authenticationHandler;
     private customTypeValidation;
+    private standardTypeValidation;
     private psqlConnectionPool;
     private psqlEngine;
     /**
@@ -992,7 +993,7 @@ declare class ResturaEngine {
      * @param app - The Express application instance to initialize with Restura.
      * @returns A promise that resolves when the initialization is complete.
      */
-    init(app: express.Application, authenticationHandler: AuthenticateHandler, psqlConnectionPool: PsqlPool): Promise<void>;
+    init(app: express.Express, authenticationHandler: AuthenticateHandler, psqlConnectionPool: PsqlPool): Promise<void>;
     /**
      * Determines if a given endpoint is public based on the HTTP method and full URL. This
      * is determined on whether the endpoint in the schema has no roles or scopes assigned to it.
@@ -1116,6 +1117,16 @@ declare class PsqlEngine extends SqlEngine {
     protected createNestedSelect(req: RsRequest<unknown>, schema: ResturaSchema, item: ResponseData, routeData: StandardRouteData, sqlParams: string[]): string;
     protected executeCreateRequest(req: RsRequest<unknown>, routeData: StandardRouteData, schema: ResturaSchema): Promise<DynamicObject>;
     protected executeGetRequest(req: RsRequest<unknown>, routeData: StandardRouteData, schema: ResturaSchema): Promise<DynamicObject | any[]>;
+    /**
+     * Executes an update request. The request will pull out the id and baseSyncVersion from the request body.
+     * (If Present) The baseSyncVersion is used to check if the record has been modified since the last sync.
+     * If the update fails because the baseSyncVersion has changed, a conflict error will be thrown.
+     * IDs can not be updated using this method.
+     * @param req - The request object.
+     * @param routeData - The route data object.
+     * @param schema - The schema object.
+     * @returns The response object.
+     */
     protected executeUpdateRequest(req: RsRequest<unknown>, routeData: StandardRouteData, schema: ResturaSchema): Promise<DynamicObject>;
     protected executeDeleteRequest(req: RsRequest<unknown>, routeData: StandardRouteData, schema: ResturaSchema): Promise<boolean>;
     protected generateJoinStatements(req: RsRequest<unknown>, joins: JoinData[], baseTable: string, routeData: StandardRouteData | CustomRouteData, schema: ResturaSchema, sqlParams: string[]): string;
@@ -1171,9 +1182,10 @@ declare function insertObjectQuery(table: string, obj: DynamicObject): string;
  * @param table Table name to update the object in
  * @param obj Data to update in the table
  * @param whereStatement Where clause to determine which rows to update
+ * @param incrementSyncVersion Whether to increment the syncVersion column
  * @returns the query to update the object in the table
  */
-declare function updateObjectQuery(table: string, obj: DynamicObject, whereStatement: string): string;
+declare function updateObjectQuery(table: string, obj: DynamicObject, whereStatement: string, incrementSyncVersion?: boolean): string;
 declare function isValueNumber(value: unknown): value is number;
 /**
  * This method is used to format a query and escape user input.