@carbonorm/carbonnode 3.8.4 → 3.9.0

package/README.md

@@ -116,7 +116,7 @@ CREATE TABLE `carbon_users` (
 ```
 3) **Profit**
   - C6 will produce 1-1 constants.
-```typescript  
+```typescript
 export interface iUsers {
     'user_username'?: string;
     'user_password'?: string;
@@ -147,6 +147,53 @@ export interface iUsers {
     'user_creation_date'?: string | null;
 }
 
+### Derived table joins
+
+The C6 query builder now supports joining derived tables (subselects) so you can project
+single-row lookups and reuse their fields elsewhere in the query. Wrap the derived table
+definition with `derivedTable(...)` to register it, then reference it inside the JOIN tree:
+
+```ts
+import { C6C } from "@carbonorm/carbonnode";
+import { derivedTable, F } from "@carbonorm/carbonnode/api/orm/queryHelpers";
+
+const puTarget = derivedTable({
+  [C6C.SUBSELECT]: {
+    [C6C.SELECT]: [Property_Units.LOCATION],
+    [C6C.FROM]: Property_Units.TABLE_NAME,
+    [C6C.WHERE]: { [Property_Units.UNIT_ID]: [C6C.EQUAL, unitIdParam] },
+    [C6C.LIMIT]: 1,
+  },
+  [C6C.AS]: 'pu_target',
+});
+
+const query = {
+  [C6C.SELECT]: [
+    Property_Units.UNIT_ID,
+    Property_Units.LOCATION,
+    F(Property_Units.LOCATION, 'pu_target'),
+  ],
+  [C6C.JOIN]: {
+    [C6C.INNER]: {
+      'parcel_sales ps': { 'ps.parcel_id': [C6C.EQUAL, Property_Units.PARCEL_ID] },
+      [puTarget as any]: {},
+    },
+  },
+  [C6C.PAGINATION]: {
+    [C6C.ORDER]: {
+      [C6C.ST_DISTANCE_SPHERE]: [
+        Property_Units.LOCATION,
+        F(Property_Units.LOCATION, 'pu_target'),
+      ],
+    },
+  },
+};
+```
+
+Parameters from the subselect are hoisted ahead of the outer query’s bindings and the alias
+(`pu_target` in the example above) is available to `F(...)`, WHERE, ORDER BY, and other
+expressions.
+
 interface iDefineUsers {
     'USER_USERNAME': string;
     'USER_PASSWORD': string;

package/dist/api/C6Constants.d.ts

@@ -50,6 +50,7 @@ export declare const C6Constants: {
     INNER: string;
     INTERVAL: string;
     JOIN: string;
+    FROM: string;
     LEFT: string;
     LEFT_OUTER: string;
     LESS_THAN: string;
@@ -81,6 +82,7 @@ export declare const C6Constants: {
     SECOND: string;
     SECOND_MICROSECOND: string;
     SELECT: string;
+    SUBSELECT: string;
     ST_AREA: string;
     ST_ASBINARY: string;
     ST_ASTEXT: string;
@@ -206,6 +208,7 @@ export declare const C6C: {
     INNER: string;
     INTERVAL: string;
     JOIN: string;
+    FROM: string;
     LEFT: string;
     LEFT_OUTER: string;
     LESS_THAN: string;
@@ -237,6 +240,7 @@ export declare const C6C: {
     SECOND: string;
     SECOND_MICROSECOND: string;
     SELECT: string;
+    SUBSELECT: string;
     ST_AREA: string;
     ST_ASBINARY: string;
     ST_ASTEXT: string;

package/dist/api/orm/builders/AggregateBuilder.d.ts

@@ -2,5 +2,6 @@ import { Executor } from "../../executors/Executor";
 import { OrmGenerics } from "../../types/ormGenerics";
 export declare abstract class AggregateBuilder<G extends OrmGenerics> extends Executor<G> {
     protected selectAliases: Set<string>;
-    buildAggregateField(field: string | any[]): string;
+    protected assertValidIdentifier(_identifier: string, _context: string): void;
+    buildAggregateField(field: string | any[], params?: any[] | Record<string, any>): string;
 }

package/dist/api/orm/builders/ConditionBuilder.d.ts

@@ -4,7 +4,10 @@ import { SqlBuilderResult } from "../utils/sqlUtils";
 import { AggregateBuilder } from "./AggregateBuilder";
 export declare abstract class ConditionBuilder<G extends OrmGenerics> extends AggregateBuilder<G> {
     protected aliasMap: Record<string, string>;
+    protected derivedAliases: Set<string>;
     protected initAlias(baseTable: string, joins?: any): void;
+    protected registerAlias(alias: string, table: string): void;
+    protected assertValidIdentifier(identifier: string, context: string): void;
     protected isColumnRef(ref: string): boolean;
     abstract build(table: string): SqlBuilderResult;
     execute(): Promise<DetermineResponseDataType<G['RequestMethod'], G['RestTableInterface']>>;

package/dist/api/orm/builders/JoinBuilder.d.ts

@@ -1,5 +1,13 @@
 import { OrmGenerics } from "../../types/ormGenerics";
 import { ConditionBuilder } from "./ConditionBuilder";
 export declare abstract class JoinBuilder<G extends OrmGenerics> extends ConditionBuilder<G> {
+    protected createSelectBuilder(_request: any): {
+        build(table: string, isSubSelect: boolean): {
+            sql: string;
+            params: any[] | Record<string, any>;
+        };
+    };
     buildJoinClauses(joinArgs: any, params: any[] | Record<string, any>): string;
+    protected integrateSubSelectParams(subSql: string, subParams: any[] | Record<string, any>, target: any[] | Record<string, any>): string;
+    protected buildScalarSubSelect(subRequest: any, params: any[] | Record<string, any>): string;
 }

package/dist/api/orm/builders/PaginationBuilder.d.ts

@@ -14,5 +14,5 @@ export declare abstract class PaginationBuilder<G extends OrmGenerics> extends J
      * }
      * ```
      */
-    buildPaginationClause(pagination: any): string;
+    buildPaginationClause(pagination: any, params?: any[] | Record<string, any>): string;
 }

package/dist/api/orm/queries/DeleteQueryBuilder.d.ts

@@ -1,6 +1,8 @@
 import { OrmGenerics } from "../../types/ormGenerics";
 import { SqlBuilderResult } from "../utils/sqlUtils";
 import { JoinBuilder } from "../builders/JoinBuilder";
+import { SelectQueryBuilder } from "./SelectQueryBuilder";
 export declare class DeleteQueryBuilder<G extends OrmGenerics> extends JoinBuilder<G> {
+    protected createSelectBuilder(request: any): SelectQueryBuilder<OrmGenerics>;
     build(table: string): SqlBuilderResult;
 }

package/dist/api/orm/queries/SelectQueryBuilder.d.ts

@@ -2,5 +2,6 @@ import { OrmGenerics } from "../../types/ormGenerics";
 import { PaginationBuilder } from "../builders/PaginationBuilder";
 import { SqlBuilderResult } from "../utils/sqlUtils";
 export declare class SelectQueryBuilder<G extends OrmGenerics> extends PaginationBuilder<G> {
+    protected createSelectBuilder(request: any): SelectQueryBuilder<OrmGenerics>;
     build(table: string, isSubSelect?: boolean): SqlBuilderResult;
 }

package/dist/api/orm/queries/UpdateQueryBuilder.d.ts

@@ -1,7 +1,9 @@
 import { OrmGenerics } from "../../types/ormGenerics";
 import { PaginationBuilder } from '../builders/PaginationBuilder';
 import { SqlBuilderResult } from "../utils/sqlUtils";
+import { SelectQueryBuilder } from "./SelectQueryBuilder";
 export declare class UpdateQueryBuilder<G extends OrmGenerics> extends PaginationBuilder<G> {
+    protected createSelectBuilder(request: any): SelectQueryBuilder<OrmGenerics>;
     private trimTablePrefix;
     build(table: string): SqlBuilderResult;
 }

package/dist/api/orm/queryHelpers.d.ts

@@ -1,6 +1,11 @@
+type DerivedTableSpec = Record<string, any> & {};
+export declare const isDerivedTableKey: (key: string) => boolean;
+export declare const resolveDerivedTable: (key: string) => DerivedTableSpec | undefined;
+export declare const derivedTable: <T extends DerivedTableSpec>(spec: T) => T;
 export declare const A: (tableName: string, alias: string) => string;
 export declare const F: (qualifiedCol: string, alias: string) => string;
 export declare const fieldEq: (leftCol: string, rightCol: string, leftAlias: string, rightAlias: string) => Record<string, string>;
 export declare const distSphere: (fromCol: string, toCol: string, fromAlias: string, toAlias: string) => any[];
 export declare const bbox: (minLng: number, minLat: number, maxLng: number, maxLat: number) => any[];
 export declare const stContains: (envelope: string, shape: string) => any[];
+export {};