@snowtop/ent 0.0.40-alpha5 → 0.0.40-alpha6

package/action/orchestrator.d.ts

@@ -57,9 +57,11 @@ export declare class Orchestrator<T extends Ent> {
     private getEdgeOperation;
     private buildEdgeOps;
     private throwError;
-    private getEntForPrivacyPolicy;
+    private getEntForPrivacyPolicyImpl;
     private getSQLStatementOperation;
     private getWriteOpForSQLStamentOp;
+    getPossibleUnsafeEntForPrivacy(): Promise<T | undefined>;
+    private getFieldsInfo;
     private validate;
     private triggers;
     private validators;

package/action/orchestrator.js

@@ -234,7 +234,7 @@ class Orchestrator {
         }
         return new EntCannotDeleteEntError(privacyPolicy, action, this.existingEnt);
     }
-    getEntForPrivacyPolicy(editedData) {
+    getEntForPrivacyPolicyImpl(editedData) {
         if (this.actualOperation !== action_1.WriteOperation.Insert) {
             return this.existingEnt;
         }
@@ -263,6 +263,24 @@ class Orchestrator {
                 throw new Error("invalid path");
         }
     }
+    // if you're doing custom privacy within an action and want to
+    // get either the unsafe ent or the existing ent that's being edited
+    async getPossibleUnsafeEntForPrivacy() {
+        if (this.actualOperation !== action_1.WriteOperation.Insert) {
+            return this.existingEnt;
+        }
+        const { editedData } = await this.getFieldsInfo();
+        return this.getEntForPrivacyPolicyImpl(editedData);
+    }
+    async getFieldsInfo() {
+        const action = this.options.action;
+        const builder = this.options.builder;
+        // future optimization: can get schemaFields to memoize based on different values
+        const schemaFields = (0, schema_1.getFields)(this.options.schema);
+        const editedFields = await this.options.editedFields();
+        let editedData = await this.getFieldsWithDefaultValues(builder, schemaFields, editedFields, action);
+        return { editedData, editedFields, schemaFields };
+    }
     async validate() {
         // existing ent required for edit or delete operations
         switch (this.actualOperation) {
@@ -272,12 +290,9 @@ class Orchestrator {
                     throw new Error(`existing ent required with operation ${this.actualOperation}`);
                 }
         }
+        const { schemaFields, editedData } = await this.getFieldsInfo();
         const action = this.options.action;
         const builder = this.options.builder;
-        // future optimization: can get schemaFields to memoize based on different values
-        const schemaFields = (0, schema_1.getFields)(this.options.schema);
-        const editedFields = await this.options.editedFields();
-        let editedData = await this.getFieldsWithDefaultValues(builder, schemaFields, editedFields, action);
         // this runs in following phases:
         // * set default fields and pass to builder so the value can be checked by triggers/observers/validators
         // * privacy policy (use unsafe ent if we have it)
@@ -285,7 +300,7 @@ class Orchestrator {
         // * validators
         let privacyPolicy = action?.getPrivacyPolicy();
         if (privacyPolicy) {
-            await (0, privacy_1.applyPrivacyPolicyX)(this.options.viewer, privacyPolicy, this.getEntForPrivacyPolicy(editedData), this.throwError.bind(this));
+            await (0, privacy_1.applyPrivacyPolicyX)(this.options.viewer, privacyPolicy, this.getEntForPrivacyPolicyImpl(editedData), this.throwError.bind(this));
         }
         // have to run triggers which update fields first before field and other validators
         // so running this first to build things up
@@ -295,7 +310,7 @@ class Orchestrator {
         }
         let validators = action?.validators || [];
         // not ideal we're calling this twice. fix...
-        // needed for now. may need to write somet of this?
+        // needed for now. may need to rewrite some of this?
         const editedFields2 = await this.options.editedFields();
         await Promise.all([
             this.formatAndValidateFields(schemaFields, editedFields2),

package/core/ent.js

@@ -287,6 +287,11 @@ async function doFieldPrivacy(viewer, ent, data, options) {
     let somethingChanged = false;
     for (const [k, policy] of options.fieldPrivacy) {
         promises.push((async () => {
+            // don't do anything if key is null or for some reason missing
+            const curr = data[k];
+            if (curr === null || curr === undefined) {
+                return;
+            }
             const r = await (0, privacy_1.applyPrivacyPolicy)(viewer, policy, ent);
             if (!r) {
                 data[k] = null;

package/core/viewer.d.ts

@@ -17,6 +17,7 @@ export declare class IDViewer implements Viewer {
     context?: Context;
     constructor(viewerID: ID, opts?: Partial<IDViewerOptions>);
     constructor(opts: IDViewerOptions);
+    setContext(ctx: Context): this;
     viewer(): Promise<Ent | null>;
     instanceKey(): string;
 }

package/core/viewer.js

@@ -27,6 +27,10 @@ class IDViewer {
         this.ent = opts?.ent || null;
         this.context = opts?.context;
     }
+    setContext(ctx) {
+        this.context = ctx;
+        return this;
+    }
     async viewer() {
         return this.ent;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snowtop/ent",
-  "version": "0.0.40-alpha5",
+  "version": "0.0.40-alpha6",
   "description": "snowtop ent framework",
   "main": "index.js",
   "types": "index.d.ts",

package/schema/index.d.ts

@@ -1,6 +1,6 @@
 import Schema from "./schema";
 export { Schema };
-export { Field, AssocEdge, AssocEdgeGroup, InverseAssocEdge, Edge, Pattern, DBType, Type, FieldOptions, SchemaConstructor, SchemaInputType, getFields, getFieldsWithPrivacy, ActionOperation, Action, EdgeAction, NoFields, Constraint, Index, ConstraintType, ForeignKeyInfo, requiredField, optionalField, UpdateOperation, TransformedUpdateOperation, SQLStatementOperation, getTransformedReadClause, getObjectLoaderProperties, } from "./schema";
+export { Field, AssocEdge, AssocEdgeGroup, InverseAssocEdge, Edge, Pattern, DBType, Type, FieldOptions, SchemaConstructor, SchemaInputType, getFields, getFieldsWithPrivacy, getStorageKey, ActionOperation, Action, EdgeAction, NoFields, Constraint, Index, ConstraintType, ForeignKeyInfo, requiredField, optionalField, UpdateOperation, TransformedUpdateOperation, SQLStatementOperation, getTransformedReadClause, getObjectLoaderProperties, } from "./schema";
 export { Timestamps, Node, BaseEntSchema, BaseEntSchemaWithTZ, } from "./base_schema";
 export * from "./field";
 export * from "./json_field";

package/schema/index.js

@@ -10,11 +10,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseEntSchemaWithTZ = exports.BaseEntSchema = exports.Node = exports.Timestamps = exports.getObjectLoaderProperties = exports.getTransformedReadClause = exports.SQLStatementOperation = exports.optionalField = exports.requiredField = exports.ConstraintType = exports.NoFields = exports.ActionOperation = exports.getFieldsWithPrivacy = exports.getFields = exports.DBType = void 0;
+exports.BaseEntSchemaWithTZ = exports.BaseEntSchema = exports.Node = exports.Timestamps = exports.getObjectLoaderProperties = exports.getTransformedReadClause = exports.SQLStatementOperation = exports.optionalField = exports.requiredField = exports.ConstraintType = exports.NoFields = exports.ActionOperation = exports.getStorageKey = exports.getFieldsWithPrivacy = exports.getFields = exports.DBType = void 0;
 var schema_1 = require("./schema");
 Object.defineProperty(exports, "DBType", { enumerable: true, get: function () { return schema_1.DBType; } });
 Object.defineProperty(exports, "getFields", { enumerable: true, get: function () { return schema_1.getFields; } });
 Object.defineProperty(exports, "getFieldsWithPrivacy", { enumerable: true, get: function () { return schema_1.getFieldsWithPrivacy; } });
+Object.defineProperty(exports, "getStorageKey", { enumerable: true, get: function () { return schema_1.getStorageKey; } });
 Object.defineProperty(exports, "ActionOperation", { enumerable: true, get: function () { return schema_1.ActionOperation; } });
 Object.defineProperty(exports, "NoFields", { enumerable: true, get: function () { return schema_1.NoFields; } });
 Object.defineProperty(exports, "ConstraintType", { enumerable: true, get: function () { return schema_1.ConstraintType; } });

package/testutils/builder.js

@@ -142,6 +142,7 @@ class SimpleBuilder {
                 ent: schema.ent,
                 tableName: tableName,
                 fields: [],
+                fieldPrivacy: (0, schema_1.getFieldsWithPrivacy)(schema),
             },
             builder: this,
             action: action,

package/testutils/context/test_context.d.ts

@@ -1,8 +1,8 @@
 import { Context, Viewer } from "../../core/base";
 import { ContextCache } from "../../core/context";
-import { LoggedOutViewer } from "../../core/viewer";
 export declare class TestContext implements Context {
+    constructor(viewer?: Viewer);
     cache: ContextCache;
-    viewer: LoggedOutViewer;
+    viewer: Viewer;
     getViewer(): Viewer;
 }

package/testutils/context/test_context.js

@@ -4,9 +4,15 @@ exports.TestContext = void 0;
 const context_1 = require("../../core/context");
 const viewer_1 = require("../../core/viewer");
 class TestContext {
-    constructor() {
+    constructor(viewer) {
         this.cache = new context_1.ContextCache();
         this.viewer = new viewer_1.LoggedOutViewer(this);
+        if (viewer) {
+            this.viewer = viewer;
+            if (viewer.setContext !== undefined) {
+                viewer.setContext(this);
+            }
+        }
     }
     getViewer() {
         return this.viewer;