@carbonorm/carbonnode 3.6.7 → 3.7.0

package/src/api/orm/builders/ConditionBuilder.ts

@@ -52,7 +52,16 @@ export abstract class ConditionBuilder<
         C6C.IS, C6C.IS_NOT,
         C6C.BETWEEN, 'NOT BETWEEN',
         C6C.MATCH_AGAINST,
-        C6C.ST_DISTANCE_SPHERE
+        C6C.ST_DISTANCE_SPHERE,
+        // spatial predicates
+        C6C.ST_CONTAINS,
+        C6C.ST_INTERSECTS,
+        C6C.ST_WITHIN,
+        C6C.ST_CROSSES,
+        C6C.ST_DISJOINT,
+        C6C.ST_EQUALS,
+        C6C.ST_OVERLAPS,
+        C6C.ST_TOUCHES
     ]);
 
     private isTableReference(val: any): boolean {
@@ -113,6 +122,19 @@ export abstract class ConditionBuilder<
                     const threshold = Array.isArray(value) ? value[0] : value;
                     return `ST_Distance_Sphere(${col1}, ${col2}) < ${this.addParam(params, '', threshold)}`;
                 }
+                if ([
+                    C6C.ST_CONTAINS,
+                    C6C.ST_INTERSECTS,
+                    C6C.ST_WITHIN,
+                    C6C.ST_CROSSES,
+                    C6C.ST_DISJOINT,
+                    C6C.ST_EQUALS,
+                    C6C.ST_OVERLAPS,
+                    C6C.ST_TOUCHES
+                ].includes(column)) {
+                    const [geom1, geom2] = op;
+                    return `${column}(${geom1}, ${geom2})`;
+                }
             }
 
             const leftIsCol = this.isColumnRef(column);

package/src/api/orm/queryHelpers.ts

@@ -16,3 +16,19 @@ export const fieldEq = (leftCol: string, rightCol: string, leftAlias: string, ri
 // ST_Distance_Sphere for aliased fields
 export const distSphere = (fromCol: string, toCol: string, fromAlias: string, toAlias: string): any[] =>
     [C6C.ST_DISTANCE_SPHERE, F(fromCol, fromAlias), F(toCol, toAlias)];
+
+// Build a bounding-box expression.
+//
+// Arguments must be provided in `(minLng, minLat, maxLng, maxLat)` order. The
+// helper does not attempt to swap or validate coordinates; if a minimum value
+// is greater than its corresponding maximum value, MySQL's `ST_MakeEnvelope`
+// returns `NULL`.
+export const bbox = (minLng: number, minLat: number, maxLng: number, maxLat: number): any[] =>
+    [C6C.ST_SRID, [C6C.ST_MAKEENVELOPE,
+        [C6C.ST_POINT, minLng, minLat],
+        [C6C.ST_POINT, maxLng, maxLat]], 4326];
+
+// ST_Contains for map envelope/shape queries
+export const stContains = (envelope: string, shape: string): any[] =>
+    [C6C.ST_CONTAINS, envelope, shape];
+

package/src/api/types/ormInterfaces.ts

@@ -7,6 +7,7 @@ import {Modify} from "./modifyTypes";
 import {JoinType, OrderDirection, SQLComparisonOperator, SQLFunction} from "./mysqlTypes";
 import {CarbonReact} from "@carbonorm/carbonreact";
 import {OrmGenerics} from "./ormGenerics";
+import {restOrm} from "../restOrm";
 
 export type iRestMethods = 'GET' | 'POST' | 'PUT' | 'DELETE';
 export const POST = 'POST';
@@ -255,8 +256,11 @@ export interface iC6Object<
         [K in Extract<keyof RestTableInterfaces, string>]: C6RestfulModel<K, RestTableInterfaces[K], keyof RestTableInterfaces[K] & string>;
     };
     PREFIX: string;
-    IMPORT: (tableName: string) => Promise<iDynamicApiImport>;
-
+    ORM: {
+        [K in Extract<keyof RestTableInterfaces, string>]:
+        C6RestfulModel<K, RestTableInterfaces[K], keyof RestTableInterfaces[K] & string>
+        & ReturnType<typeof restOrm<OrmGenerics<any>>>
+    }[]
     [key: string]: any;
 }