@snowtop/ent 0.1.0-alpha63 → 0.1.0-alpha65

package/core/base.d.ts

@@ -72,6 +72,7 @@ export interface QueryDataOptions {
     orderby?: string;
     groupby?: string;
     limit?: number;
+    disableTransformations?: boolean;
 }
 export interface LoadRowOptions extends QueryableDataOptions {
 }
@@ -85,13 +86,20 @@ export interface EditRowOptions extends CreateRowOptions {
     whereClause: clause.Clause;
 }
 interface LoadableEntOptions<TEnt extends Ent, TViewer extends Viewer = Viewer> {
-    loaderFactory: LoaderFactory<any, Data | null>;
+    loaderFactory: LoaderFactoryWithOptions;
     ent: EntConstructor<TEnt, TViewer>;
 }
+interface LoaderFactoryWithOptions extends LoaderFactory<any, Data | null> {
+    options?: SelectDataOptions;
+}
 export interface LoadEntOptions<TEnt extends Ent, TViewer extends Viewer = Viewer> extends LoadableEntOptions<TEnt, TViewer>, SelectBaseDataOptions {
     fieldPrivacy?: Map<string, PrivacyPolicy>;
 }
-export interface LoadCustomEntOptions<TEnt extends Ent, TViewer extends Viewer = Viewer> extends SelectBaseDataOptions {
+export interface SelectCustomDataOptions extends SelectBaseDataOptions {
+    clause?: clause.Clause;
+    loaderFactory?: LoaderFactoryWithOptions;
+}
+export interface LoadCustomEntOptions<TEnt extends Ent, TViewer extends Viewer = Viewer> extends SelectCustomDataOptions {
     ent: EntConstructor<TEnt, TViewer>;
     fieldPrivacy?: Map<string, PrivacyPolicy>;
 }

package/core/ent.d.ts

@@ -1,5 +1,5 @@
 import { Queryer, SyncQueryer } from "./db";
-import { Viewer, Ent, ID, LoadRowsOptions, LoadRowOptions, Data, DataOptions, QueryableDataOptions, EditRowOptions, LoadEntOptions, LoadCustomEntOptions, EdgeQueryableDataOptions, Context, SelectBaseDataOptions, CreateRowOptions, QueryDataOptions } from "./base";
+import { Viewer, Ent, ID, LoadRowsOptions, LoadRowOptions, Data, DataOptions, QueryableDataOptions, EditRowOptions, LoadEntOptions, LoadCustomEntOptions, EdgeQueryableDataOptions, Context, CreateRowOptions, QueryDataOptions, SelectCustomDataOptions } from "./base";
 import { Executor } from "../action/action";
 import * as clause from "./clause";
 import { Builder } from "../action";
@@ -15,13 +15,37 @@ export declare function loadEnts<TEnt extends Ent<TViewer>, TViewer extends View
 export declare function loadEntsList<TEnt extends Ent<TViewer>, TViewer extends Viewer>(viewer: TViewer, options: LoadEntOptions<TEnt, TViewer>, ...ids: ID[]): Promise<TEnt[]>;
 export declare function loadEntsFromClause<TEnt extends Ent<TViewer>, TViewer extends Viewer>(viewer: TViewer, clause: clause.Clause, options: LoadEntOptions<TEnt, TViewer>): Promise<Map<ID, TEnt>>;
 export declare function loadCustomEnts<TEnt extends Ent<TViewer>, TViewer extends Viewer>(viewer: TViewer, options: LoadCustomEntOptions<TEnt, TViewer>, query: CustomQuery): Promise<TEnt[]>;
-interface rawQueryOptions {
+interface parameterizedQueryOptions {
     query: string;
     values?: any[];
     logValues?: any[];
 }
-export declare type CustomQuery = string | rawQueryOptions | clause.Clause | QueryDataOptions;
-export declare function loadCustomData(options: SelectBaseDataOptions, query: CustomQuery, context: Context | undefined): Promise<Data[]>;
+export declare type CustomQuery = string | parameterizedQueryOptions | clause.Clause | QueryDataOptions;
+/**
+ * Note that if there's default read transformations (e.g. soft delete) and a clause is passed in
+ * either as Clause or QueryDataOptions without {disableTransformations: true}, the default transformation
+ * (e.g. soft delete) is applied.
+ *
+ * Passing a full SQL string or Paramterized SQL string doesn't apply it and the given string is sent to the
+ * database as written.
+ *
+ * e.g.
+ * Foo.loadCustom(opts, 'SELECT * FROM foo') // doesn't change the query
+ * Foo.loadCustom(opts, { query: 'SELECT * FROM foo WHERE id = ?', values: [1]}) // doesn't change the query
+ * Foo.loadCustom(opts, query.Eq('time', Date.now())) // changes the query
+ * Foo.loadCustom(opts, {
+ *   clause:  query.LessEq('time', Date.now()),
+ *   limit: 100,
+ *   orderby: 'time',
+ *  }) // changes the query
+ * Foo.loadCustom(opts, {
+ *   clause:  query.LessEq('time', Date.now()),
+ *   limit: 100,
+ *   orderby: 'time',
+ *   disableTransformations: false
+ *  }) // doesn't change the query
+ */
+export declare function loadCustomData(options: SelectCustomDataOptions, query: CustomQuery, context: Context | undefined): Promise<Data[]>;
 export declare function loadDerivedEnt<TEnt extends Ent<TViewer>, TViewer extends Viewer>(viewer: TViewer, data: Data, loader: new (viewer: TViewer, data: Data) => TEnt): Promise<TEnt | null>;
 export declare function loadDerivedEntX<TEnt extends Ent<TViewer>, TViewer extends Viewer>(viewer: TViewer, data: Data, loader: new (viewer: TViewer, data: Data) => TEnt): Promise<TEnt>;
 export declare function loadRowX(options: LoadRowOptions): Promise<Data>;

package/core/ent.js

@@ -226,32 +226,77 @@ function isClause(opts) {
     const cls = opts;
     return cls.clause !== undefined && cls.values !== undefined;
 }
-function isRawQuery(opts) {
+function isParameterizedQuery(opts) {
     return opts.query !== undefined;
 }
+/**
+ * Note that if there's default read transformations (e.g. soft delete) and a clause is passed in
+ * either as Clause or QueryDataOptions without {disableTransformations: true}, the default transformation
+ * (e.g. soft delete) is applied.
+ *
+ * Passing a full SQL string or Paramterized SQL string doesn't apply it and the given string is sent to the
+ * database as written.
+ *
+ * e.g.
+ * Foo.loadCustom(opts, 'SELECT * FROM foo') // doesn't change the query
+ * Foo.loadCustom(opts, { query: 'SELECT * FROM foo WHERE id = ?', values: [1]}) // doesn't change the query
+ * Foo.loadCustom(opts, query.Eq('time', Date.now())) // changes the query
+ * Foo.loadCustom(opts, {
+ *   clause:  query.LessEq('time', Date.now()),
+ *   limit: 100,
+ *   orderby: 'time',
+ *  }) // changes the query
+ * Foo.loadCustom(opts, {
+ *   clause:  query.LessEq('time', Date.now()),
+ *   limit: 100,
+ *   orderby: 'time',
+ *   disableTransformations: false
+ *  }) // doesn't change the query
+ */
 async function loadCustomData(options, query, context) {
+    //loaderFactory not here...
+    //  options.
+    function getClause(cls) {
+        let optClause = options.clause || options.loaderFactory?.options?.clause;
+        if (typeof optClause === "function") {
+            optClause = optClause();
+        }
+        if (!optClause) {
+            return cls;
+        }
+        return clause.And(cls, optClause);
+    }
     if (typeof query === "string") {
         // no caching, perform raw query
         return await performRawQuery(query, [], []);
     }
     else if (isClause(query)) {
+        // if a Clause is passed in and we have a default clause
+        // associated with the query, pass that in
+        // if we want to disableTransformations, need to indicate that with
+        // disableTransformations option
         // this will have rudimentary caching but nothing crazy
         return await loadRows({
             ...options,
-            clause: query,
+            clause: getClause(query),
             context: context,
         });
     }
-    else if (isRawQuery(query)) {
+    else if (isParameterizedQuery(query)) {
         // no caching, perform raw query
         return await performRawQuery(query.query, query.values || [], query.logValues);
     }
     else {
+        let cls = query.clause;
+        if (!query.disableTransformations) {
+            cls = getClause(cls);
+        }
         // this will have rudimentary caching but nothing crazy
         return await loadRows({
             ...query,
             ...options,
             context: context,
+            clause: cls,
         });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snowtop/ent",
-  "version": "0.1.0-alpha63",
+  "version": "0.1.0-alpha65",
   "description": "snowtop ent framework",
   "main": "index.js",
   "types": "index.d.ts",

package/testutils/db/temp_db.js

@@ -527,6 +527,7 @@ function setupSqlite(connString, tables, opts) {
     afterAll(async () => {
         await tdb.afterAll();
         fs.rmSync(tdb.getSqliteClient().name);
+        delete process.env.DB_CONNECTION_STRING;
     });
     return tdb;
 }

package/testutils/parse_sql.d.ts

@@ -9,6 +9,12 @@ export declare class EqOp {
     constructor(col: string, value: any);
     apply(data: Data): boolean;
 }
+export declare class NotEqOp {
+    private col;
+    private value;
+    constructor(col: string, value: any);
+    apply(data: Data): boolean;
+}
 export declare class GreaterOp {
     private col;
     private value;

package/testutils/parse_sql.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.performQuery = exports.OrOp = exports.AndOp = exports.InOp = exports.LessEqOp = exports.GreaterEqOp = exports.LessOp = exports.GreaterOp = exports.EqOp = exports.getDataToReturn = void 0;
+exports.performQuery = exports.OrOp = exports.AndOp = exports.InOp = exports.LessEqOp = exports.GreaterEqOp = exports.LessOp = exports.GreaterOp = exports.NotEqOp = exports.EqOp = exports.getDataToReturn = void 0;
 const node_sql_parser_1 = require("node-sql-parser");
 function getTableName(table) {
     if (Array.isArray(table)) {
@@ -184,6 +184,16 @@ class EqOp {
     }
 }
 exports.EqOp = EqOp;
+class NotEqOp {
+    constructor(col, value) {
+        this.col = col;
+        this.value = value;
+    }
+    apply(data) {
+        return data[this.col] !== this.value;
+    }
+}
+exports.NotEqOp = NotEqOp;
 class GreaterOp {
     constructor(col, value) {
         this.col = col;
@@ -308,11 +318,11 @@ function getOp(where, values) {
         case "OR":
             return new OrOp([getOp(where.left, values), getOp(where.right, values)]);
         case "IS":
-            if (where.right?.value === null) {
-                return new EqOp(getColumnFromRef(where.left), null);
-            }
+            return new EqOp(getColumnFromRef(where.left), where.right?.value);
+        case "IS NOT":
+            return new NotEqOp(getColumnFromRef(where.left), where.right?.value);
         default:
-            console.log(where);
+            console.debug(where);
             throw new Error(`unsupported op ${where.operator}`);
     }
 }