@liminalfunctions/framework 1.0.44 → 1.0.47

package/src/F_Collection_Registry.ts

@@ -23,7 +23,7 @@ export class F_Collection_Registry<Collections = {}> {
 
     compile(app: Router, api_prefix: string) {
         for(let collection of Object.values(this.collections)){
-            compile(app, collection, api_prefix)
+            compile(app, collection, api_prefix, this)
         }
     }
 }

package/src/F_Compile.ts

@@ -6,20 +6,51 @@ import { F_Collection } from "./F_Collection.js";
 import { F_Security_Model, Authenticated_Request } from "./F_Security_Models/F_Security_Model.js";
 import { convert_null, query_object_to_mongodb_limits, query_object_to_mongodb_query } from "./utils/query_object_to_mongodb_query.js";
 import { z_mongodb_id } from "./utils/mongoose_from_zod.js";
+import { F_Collection_Registry } from "./F_Collection_Registry.js";
 
 /*process.on('unhandledRejection', (reason, promise) => {
     console.log(`CAUGHT UNHANDLED REJECTION`)
     console.log(reason)
 })*/
 
-export function compile<Collection_ID extends string, ZodSchema extends z.ZodObject>(app: Router, collection: F_Collection<Collection_ID, ZodSchema>, api_prefix: string){
+export function compile<Collection_ID extends string, ZodSchema extends z.ZodObject>(
+    app: Router,
+    collection: F_Collection<Collection_ID, ZodSchema>,
+    api_prefix: string,
+    collection_registry: F_Collection_Registry<any>){
     /*app.use((req, res, next) => {
         console.log(`${req.method} ${req.originalUrl}`)
         next();
     })*/
+
+    
+    for(let access_layers of collection.access_layers){
+        for(let layer of access_layers.layers){
+            // verify that the collection is not in its own layers
+            if(layer === collection.collection_id){
+                throw new Error(`Error compiling collection ${collection.collection_id}: a collection cannot be a member of it's own layer. Remove "${collection.collection_id}" from the collection's layers.`)
+            }
+
+            // verify that each layer has a corresponding collection
+            if(!collection_registry.collections[layer]){ 
+                throw new Error(`Error compiling collection ${collection.collection_id}: collection registry does not have a collection with the ID "${layer}". Each layer must be a valid collection ID.`)
+            }
+
+            if(!Object.hasOwn(collection.validator._zod.def.shape, `${layer}_id`)) {
+                throw new Error(`Error compiling collection ${collection.collection_id}: collection does not have a field "${layer}_id. Either remove ${layer} from the collection's layers, or add a field ${layer}_id`)
+            }
+
+            let layer_id_is_mongodb_id = collection.validator._zod.def.shape[`${layer}_id`].meta()?.framework_override_type === 'mongodb_id';
+            if(!layer_id_is_mongodb_id){
+                throw new Error(`Error compiling collection ${collection.collection_id}:  ${layer}_id must be a mongodb ID. use the z_mongodb_id, z_mongodb_id_nullable, or z_mongodb_id_optional special fields.`)
+            }
+        }
+    }
     
+    // set up the Express endpoints
     for(let access_layers of collection.access_layers){
         let base_layers_path_components = access_layers.layers.flatMap(ele => [ele, ':' + ele]);
+        
 
         let get_one_path = [
             api_prefix,

package/src/utils/mongoose_from_zod.ts

@@ -2,14 +2,16 @@ import { z } from "zod/v4"
 import mongoose, { Schema } from "mongoose";
 
 import { find_loops, validator_group } from './zod_loop_seperator.js'
-import { required } from "zod/mini";
+import { complex_query_map, query_meta_map } from "./query_object_to_mongodb_query.js";
 
-//export const z_mongodb_id = z.string().length(24).describe('F_Mongodb_ID');
-//export const mongodb_id = () => z_mongodb_id;
 const underlying_mongodb_id_validator = z.string().length(24);
 const underlying_mongodb_id_validator_optional = underlying_mongodb_id_validator.optional();
 const underlying_mongodb_id_validator_nullable = underlying_mongodb_id_validator.nullable();
 
+const forbidden_prefixes = ['$'];
+const forbidden_keys = [...Object.keys(query_meta_map)]
+const forbidden_suffixes = [...Object.keys(complex_query_map)]
+
 export const z_mongodb_id = z.custom<string>((val) => {
     if(!val){ return false; }
     let parsed = underlying_mongodb_id_validator.safeParse(val);
@@ -149,6 +151,23 @@ function parse_object(def: z.core.$ZodObjectDef, loop_detector: Map<any, validat
 
     let retval = {} as any;
     for(let [key, value] of Object.entries(def.shape)){
+        for(let forbidden_key of forbidden_keys){
+            if(key.toLowerCase() === forbidden_key){
+                throw new Error(`"${forbidden_key}" is a forbidden field name because it's used in query parameters. Please check your validators and replace this key with something else.`)
+            }
+        }
+
+        for(let forbidden_prefix of forbidden_prefixes){
+            if(key.toLowerCase().startsWith(forbidden_prefix)){
+                throw new Error(`"${key}" is not a valid field name because it begins with "${forbidden_prefix}". Please check your validators and replace this key with something else.`)
+            }
+        }
+
+        for(let forbidden_suffix of forbidden_suffixes){
+            if(key.toLowerCase().endsWith(forbidden_suffix)){
+                throw new Error(`"${key}" is not a valid field name because it ends with "${forbidden_suffix}". Please check your validators and replace this key with something else.`)
+            }
+        }
         //@ts-ignore
         retval[key] = schema_entry_from_zod(value, loop_detector);
     }

package/src/utils/query_object_to_mongodb_query.ts

@@ -1,6 +1,6 @@
 import { QueryWithHelpers } from "mongoose";
 
-let complex_query_map = {
+export let complex_query_map = {
     '_gt': '$gt',
     '_lt': '$lt',
     '_gte': '$gte',
@@ -15,7 +15,7 @@ let complex_query_map = {
     '_in': '$in'
 }
 
-let query_meta_map = {
+export let query_meta_map = {
     'limit': true,
     'cursor': true,
     'sort': true,

package/test/0_1_mongoose_from_zod.test.ts

@@ -277,4 +277,41 @@ describe('Mongoose from Zod', function () {
             c: { mongoose_type: { name: { mongoose_type: String, required: true } }, required: true },
         }, mongooseSchema)
     })
+
+    /*
+        forbidden keys
+    */
+    it(`should error if a key starts with $`, function () {
+        let zodSchema = z.object({
+            $where: z.string()
+        })
+
+        assert.throws(() => {
+            let mongooseSchema = schema_from_zod(zodSchema);
+        })
+    });
+
+    for(let key of ['limit', 'cursor', 'sort', 'sort_order']){
+        it(`should error if a key is ${key}`, function () {
+            let zodSchema = z.object({
+                [key]: z.string()
+            })
+
+            assert.throws(() => {
+                let mongooseSchema = schema_from_zod(zodSchema);
+            })
+        });
+    }
+
+    for(let key of ['_gt', '_lt', '_gte', '_lte', '_in']){
+        it(`should error if a key ends with ${key}`, function () {
+            let zodSchema = z.object({
+                [`id${key}`]: z.string()
+            })
+
+            assert.throws(() => {
+                let mongooseSchema = schema_from_zod(zodSchema);
+            })
+        });
+    }
 });

package/test/2_0_client_library_basic_type_generation.test.ts

@@ -38,7 +38,9 @@ describe('Client Library Generation: Basic Types', function () {
     })
 
     it(`should be able to generate a plain object`, async function () {
-        const validate_test_collection = z.object({});
+        const validate_test_collection = z.object({
+            _id: z_mongodb_id
+        });
 
         let test_collection = new F_Collection('test_collection', 'test_collection', validate_test_collection);
 
@@ -49,12 +51,13 @@ describe('Client Library Generation: Basic Types', function () {
 
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
-            remove_whitespace(`export type test_collection = {}`)
+            remove_whitespace(`export type test_collection = {"_id": string}`)
         )
     });
 
     it(`should be able to generate a plain object containing a string`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.string(),
         });
 
@@ -68,6 +71,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": string
                 }`)
         )
@@ -75,6 +79,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain object containing a number`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.number(),
         });
 
@@ -88,6 +93,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": number
                 }`)
         )
@@ -95,6 +101,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain object containing a boolean`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.boolean(),
         });
 
@@ -108,6 +115,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": boolean
                 }`)
         )
@@ -115,6 +123,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain object containing a date`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.date(),
         });
 
@@ -128,6 +137,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": Date
                 }`)
         )
@@ -135,6 +145,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain object containing an objectID`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z_mongodb_id,
         });
 
@@ -148,6 +159,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": string
                 }`)
         )
@@ -155,6 +167,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain object containing a nullable string`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.nullable(z.string()),
         });
 
@@ -168,6 +181,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": string | null
                 }`)
         )
@@ -175,6 +189,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain object containing union types`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.string().or(z.number()),
         });
 
@@ -188,6 +203,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": string | number
                 }`)
         )
@@ -195,6 +211,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain object containing union types wrapped in nullable`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.nullable(z.string().or(z.number())),
         });
 
@@ -208,6 +225,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": string | number | null
                 }`)
         )
@@ -215,6 +233,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain object containing union of object types`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.object({
                 sub: z.string()
             }).or(z.object({
@@ -232,6 +251,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": {"sub": string} | {"sub2": number}
                 }`)
         )
@@ -239,6 +259,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate an enum`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.enum(["red", "green", "blue"]),
         });
 
@@ -252,6 +273,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": ("red" | "green" | "blue")
                 }`)
         )
@@ -259,6 +281,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate an array of enum`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.array(z.enum(["red", "green", "blue"])),
         });
 
@@ -272,6 +295,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": ("red" | "green" | "blue")[]
                 }`)
         )
@@ -279,6 +303,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain nested object`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.object({
             }),
         });
@@ -293,6 +318,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": {}
                 }`)
         )
@@ -300,6 +326,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain nested with basic fields`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.object({
                 field_string: z.string(),
                 field_number: z.number(),
@@ -321,6 +348,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": {
                         "field_string": string
                         "field_number": number
@@ -336,6 +364,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate arrays of primitive fields`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             field_string: z.array(z.string()),
             field_number: z.array(z.number()),
             field_boolean: z.array(z.boolean()),
@@ -352,6 +381,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "field_string": string[]
                     "field_number": number[]
                     "field_boolean": boolean[]
@@ -362,6 +392,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate arrays of objects containing primitive fields`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             field_array: z.array(z.object({
                 field_string: z.array(z.string()),
                 field_number: z.array(z.number()),
@@ -381,6 +412,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                "_id": string
                 "field_array": {
                         "field_string": string[]
                         "field_number": number[]
@@ -393,6 +425,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate nested arrays`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             field_array: z.array(
                 z.array(z.object({
                     field_string: z.array(z.string()),
@@ -413,6 +446,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                "_id": string
                 "field_array": {
                         "field_string": string[]
                         "field_number": number[]
@@ -425,6 +459,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain object containing a primitive with a default`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.string().default('ezikiel snograss'),
         });
 
@@ -438,6 +473,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test"?: string
                 }`)
         )
@@ -445,6 +481,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain object containing an optional primitive`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.string().optional(),
         });
 
@@ -458,6 +495,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test"?: string
                 }`)
         )
@@ -465,6 +503,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain object containing a record`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.record(z.string(), z.string())
         });
 
@@ -478,6 +517,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": {[key: string]: string}
                 }`)
         )
@@ -486,6 +526,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain object containing an object record`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.record(z.string(), z.object({
                 test_2: z.string()
             }))
@@ -501,6 +542,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": {[key: string]: { "test_2": string }}
                 }`)
         )
@@ -508,6 +550,7 @@ describe('Client Library Generation: Basic Types', function () {
 
     it(`should be able to generate a plain object containing an array record`, async function () {
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: z.record(z.string(), z.array(z.string()))
         });
 
@@ -521,6 +564,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": {[key: string]: string[]}
                 }`)
         )
@@ -535,6 +579,7 @@ describe('Client Library Generation: Basic Types', function () {
         }).meta({id: 'test_recursive_object'})
 
         const validate_test_collection = z.object({
+            _id: z_mongodb_id,
             test: recursive
         });
 
@@ -548,6 +593,7 @@ describe('Client Library Generation: Basic Types', function () {
         assert.equal(
             remove_whitespace(await readFile('./test/tmp/src/types/test_collection.ts', { encoding: 'utf-8' })),
             remove_whitespace(`export type test_collection = {
+                    "_id": string
                     "test": type_test_recursive_object
                 }
                 type type_test_recursive_object = {