@liminalfunctions/framework 1.0.0

package/test/tmp/src/Client.ts

@@ -0,0 +1,106 @@
+import ky from "ky";
+import { encode_search_params, Response, Response_Multiple } from "./utils/utils.js";
+
+import { Collection_Project } from "./Project.js"
+import { Collection_Brief_News_Category } from "./Brief_News_Category.js"
+
+import { client } from "./types/client.js";
+import { client_query } from "./types/client_query.js";
+import { client_put } from "./types/client_put.js";
+import { client_post } from "./types/client_post.js";
+
+export class Collection_Client {
+    path: string[]
+    get_auth: () => Promise<any>
+
+    constructor(path: string[], get_auth: () => Promise<any>) {
+        this.path = path;
+        this.get_auth = get_auth;
+    }
+
+    
+    async query(query: client_query): Promise<client[]>{
+        try {
+            let result = await ky.get(this.path.join('/'), {
+                headers: {
+                    authorization: await this.get_auth()
+                },
+                searchParams: encode_search_params(query)
+            }).json() as Response_Multiple<client>;
+            return result.data;
+        } catch(err){
+            return Promise.reject(err)
+        }
+    }
+
+    async post(document: client_post): Promise<client>{
+        try {
+            let result = await ky.post(this.path.join('/'), {
+                headers: {
+                    authorization: await this.get_auth()
+                },
+                json: document
+            }).json() as Response<client>;
+            return result.data;
+        } catch(err){
+            return Promise.reject(err)
+        }
+    }
+
+    document(document_id: string) {
+        let path = this.path;
+        let get_auth = this.get_auth;
+        return {
+            async get(): Promise<client>{
+                try {
+                    let result = await ky.get([...path, document_id].join('/'), {
+                        headers: {
+                            authorization: await get_auth()
+                        },
+                    }).json() as Response<client>;
+                    return result.data;
+                } catch(err){
+                    return Promise.reject(err)
+                }
+            },
+
+            async put(update: client_put): Promise<client>{
+                try {
+                    let result = await ky.put([...path, document_id].join('/'), {
+                        headers: {
+                            authorization: await get_auth()
+                        },
+                        json: update
+                    }).json() as Response<client>;
+                    return result.data;
+                } catch(err){
+                    return Promise.reject(err)
+                }
+            },
+            
+            async remove(): Promise<client>{
+                try {
+                    let result = await ky.delete([...path, document_id].join('/'), {
+                        headers: {
+                            authorization: await get_auth()
+                        },
+                    }).json() as Response<client>;
+                    return result.data;
+                } catch(err){
+                    return Promise.reject(err)
+                }
+            },
+
+            collection(collection_id: "project" | "brief_news_category") {
+                switch(collection_id) {
+                    case "project":
+                        return new Collection_Project([...path, document_id, "project"], get_auth);
+                    case "brief_news_category":
+                        return new Collection_Brief_News_Category([...path, document_id, "brief_news_category"], get_auth);
+                    default:
+                        throw new Error(`Api does not have the collection ${collection_id}`)
+                }
+            }
+        }
+    }
+}

package/test/tmp/src/Institution.ts

@@ -0,0 +1,103 @@
+import ky from "ky";
+import { encode_search_params, Response, Response_Multiple } from "./utils/utils.js";
+
+import { Collection_Client } from "./Client.js"
+
+import { institution } from "./types/institution.js";
+import { institution_query } from "./types/institution_query.js";
+import { institution_put } from "./types/institution_put.js";
+import { institution_post } from "./types/institution_post.js";
+
+export class Collection_Institution {
+    path: string[]
+    get_auth: () => Promise<any>
+
+    constructor(path: string[], get_auth: () => Promise<any>) {
+        this.path = path;
+        this.get_auth = get_auth;
+    }
+
+    
+    async query(query: institution_query): Promise<institution[]>{
+        try {
+            let result = await ky.get(this.path.join('/'), {
+                headers: {
+                    authorization: await this.get_auth()
+                },
+                searchParams: encode_search_params(query)
+            }).json() as Response_Multiple<institution>;
+            return result.data;
+        } catch(err){
+            return Promise.reject(err)
+        }
+    }
+
+    async post(document: institution_post): Promise<institution>{
+        try {
+            let result = await ky.post(this.path.join('/'), {
+                headers: {
+                    authorization: await this.get_auth()
+                },
+                json: document
+            }).json() as Response<institution>;
+            return result.data;
+        } catch(err){
+            return Promise.reject(err)
+        }
+    }
+
+    document(document_id: string) {
+        let path = this.path;
+        let get_auth = this.get_auth;
+        return {
+            async get(): Promise<institution>{
+                try {
+                    let result = await ky.get([...path, document_id].join('/'), {
+                        headers: {
+                            authorization: await get_auth()
+                        },
+                    }).json() as Response<institution>;
+                    return result.data;
+                } catch(err){
+                    return Promise.reject(err)
+                }
+            },
+
+            async put(update: institution_put): Promise<institution>{
+                try {
+                    let result = await ky.put([...path, document_id].join('/'), {
+                        headers: {
+                            authorization: await get_auth()
+                        },
+                        json: update
+                    }).json() as Response<institution>;
+                    return result.data;
+                } catch(err){
+                    return Promise.reject(err)
+                }
+            },
+            
+            async remove(): Promise<institution>{
+                try {
+                    let result = await ky.delete([...path, document_id].join('/'), {
+                        headers: {
+                            authorization: await get_auth()
+                        },
+                    }).json() as Response<institution>;
+                    return result.data;
+                } catch(err){
+                    return Promise.reject(err)
+                }
+            },
+
+            collection(collection_id: "client") {
+                switch(collection_id) {
+                    case "client":
+                        return new Collection_Client([...path, document_id, "client"], get_auth);
+                    default:
+                        throw new Error(`Api does not have the collection ${collection_id}`)
+                }
+            }
+        }
+    }
+}

package/test/tmp/src/Project.ts

@@ -0,0 +1,94 @@
+import ky from "ky";
+import { encode_search_params, Response, Response_Multiple } from "./utils/utils.js";
+
+
+import { project } from "./types/project.js";
+import { project_query } from "./types/project_query.js";
+import { project_put } from "./types/project_put.js";
+import { project_post } from "./types/project_post.js";
+
+export class Collection_Project {
+    path: string[]
+    get_auth: () => Promise<any>
+
+    constructor(path: string[], get_auth: () => Promise<any>) {
+        this.path = path;
+        this.get_auth = get_auth;
+    }
+
+    
+    async query(query: project_query): Promise<project[]>{
+        try {
+            let result = await ky.get(this.path.join('/'), {
+                headers: {
+                    authorization: await this.get_auth()
+                },
+                searchParams: encode_search_params(query)
+            }).json() as Response_Multiple<project>;
+            return result.data;
+        } catch(err){
+            return Promise.reject(err)
+        }
+    }
+
+    async post(document: project_post): Promise<project>{
+        try {
+            let result = await ky.post(this.path.join('/'), {
+                headers: {
+                    authorization: await this.get_auth()
+                },
+                json: document
+            }).json() as Response<project>;
+            return result.data;
+        } catch(err){
+            return Promise.reject(err)
+        }
+    }
+
+    document(document_id: string) {
+        let path = this.path;
+        let get_auth = this.get_auth;
+        return {
+            async get(): Promise<project>{
+                try {
+                    let result = await ky.get([...path, document_id].join('/'), {
+                        headers: {
+                            authorization: await get_auth()
+                        },
+                    }).json() as Response<project>;
+                    return result.data;
+                } catch(err){
+                    return Promise.reject(err)
+                }
+            },
+
+            async put(update: project_put): Promise<project>{
+                try {
+                    let result = await ky.put([...path, document_id].join('/'), {
+                        headers: {
+                            authorization: await get_auth()
+                        },
+                        json: update
+                    }).json() as Response<project>;
+                    return result.data;
+                } catch(err){
+                    return Promise.reject(err)
+                }
+            },
+            
+            async remove(): Promise<project>{
+                try {
+                    let result = await ky.delete([...path, document_id].join('/'), {
+                        headers: {
+                            authorization: await get_auth()
+                        },
+                    }).json() as Response<project>;
+                    return result.data;
+                } catch(err){
+                    return Promise.reject(err)
+                }
+            },
+
+        }
+    }
+}

package/test/tmp/src/index.ts

@@ -0,0 +1,20 @@
+import ky from 'ky';
+
+
+import { Collection_Institution } from "./Institution.js"
+
+
+export function api(base_url: string, get_auth: () => Promise<any>) {
+    return {
+        collection(collection_id: "institution") {
+            switch(collection_id) {
+                case "institution":
+                    return new Collection_Institution([base_url, "institution"], get_auth);
+                default:
+                    throw new Error(`Api does not have the collection ${collection_id}`)
+            }
+        }
+    }
+}
+
+

package/test/tmp/src/types/brief_news_category.ts

@@ -0,0 +1,7 @@
+export type brief_news_category = {
+	"_id": string
+	"name": string
+	"slug": string
+	"institution_id": string
+	"client_id": string
+}

package/test/tmp/src/types/brief_news_category_post.ts

@@ -0,0 +1,7 @@
+export type brief_news_category_post = {
+	"_id"?: string
+	"name": string
+	"slug": string
+	"institution_id": string
+	"client_id": string
+}

package/test/tmp/src/types/brief_news_category_put.ts

@@ -0,0 +1,7 @@
+export type brief_news_category_put = {
+	"_id"?: string
+	"name"?: string
+	"slug"?: string
+	"institution_id"?: string
+	"client_id"?: string
+}

package/test/tmp/src/types/brief_news_category_query.ts

@@ -0,0 +1,26 @@
+export type brief_news_category_query = {
+	"limit"?: number
+	"cursor"?: string
+	"sort_order"?: ("ascending" | "descending")
+	"_id"?: string
+	"_id_gt"?: string
+	"_id_lt"?: string
+	"_id_in"?: string[]
+	"name"?: string
+	"name_gt"?: string
+	"name_lt"?: string
+	"name_in"?: string[]
+	"slug"?: string
+	"slug_gt"?: string
+	"slug_lt"?: string
+	"slug_in"?: string[]
+	"institution_id"?: string
+	"institution_id_gt"?: string
+	"institution_id_lt"?: string
+	"institution_id_in"?: string[]
+	"client_id"?: string
+	"client_id_gt"?: string
+	"client_id_lt"?: string
+	"client_id_in"?: string[]
+	"sort"?: ("_id" | "name" | "slug" | "institution_id" | "client_id")
+}

package/test/tmp/src/types/client.ts

@@ -0,0 +1,5 @@
+export type client = {
+	"_id": string
+	"name": string
+	"institution_id": string
+}

package/test/tmp/src/types/client_post.ts

@@ -0,0 +1,5 @@
+export type client_post = {
+	"_id"?: string
+	"name": string
+	"institution_id": string
+}

package/test/tmp/src/types/client_put.ts

@@ -0,0 +1,5 @@
+export type client_put = {
+	"_id"?: string
+	"name"?: string
+	"institution_id"?: string
+}

package/test/tmp/src/types/client_query.ts

@@ -0,0 +1,18 @@
+export type client_query = {
+	"limit"?: number
+	"cursor"?: string
+	"sort_order"?: ("ascending" | "descending")
+	"_id"?: string
+	"_id_gt"?: string
+	"_id_lt"?: string
+	"_id_in"?: string[]
+	"name"?: string
+	"name_gt"?: string
+	"name_lt"?: string
+	"name_in"?: string[]
+	"institution_id"?: string
+	"institution_id_gt"?: string
+	"institution_id_lt"?: string
+	"institution_id_in"?: string[]
+	"sort"?: ("_id" | "name" | "institution_id")
+}

package/test/tmp/src/types/institution.ts

@@ -0,0 +1,4 @@
+export type institution = {
+	"_id": string
+	"name": string
+}

package/test/tmp/src/types/institution_post.ts

@@ -0,0 +1,4 @@
+export type institution_post = {
+	"_id"?: string
+	"name": string
+}

package/test/tmp/src/types/institution_put.ts

@@ -0,0 +1,4 @@
+export type institution_put = {
+	"_id"?: string
+	"name"?: string
+}

package/test/tmp/src/types/institution_query.ts

@@ -0,0 +1,14 @@
+export type institution_query = {
+	"limit"?: number
+	"cursor"?: string
+	"sort_order"?: ("ascending" | "descending")
+	"_id"?: string
+	"_id_gt"?: string
+	"_id_lt"?: string
+	"_id_in"?: string[]
+	"name"?: string
+	"name_gt"?: string
+	"name_lt"?: string
+	"name_in"?: string[]
+	"sort"?: ("_id" | "name")
+}

package/test/tmp/src/types/project.ts

@@ -0,0 +1,7 @@
+export type project = {
+	"_id": string
+	"name": string
+	"institution_id": string
+	"client_id": string
+	"project_number": number
+}

package/test/tmp/src/types/project_post.ts

@@ -0,0 +1,7 @@
+export type project_post = {
+	"_id"?: string
+	"name": string
+	"institution_id": string
+	"client_id": string
+	"project_number": number
+}

package/test/tmp/src/types/project_put.ts

@@ -0,0 +1,7 @@
+export type project_put = {
+	"_id"?: string
+	"name"?: string
+	"institution_id"?: string
+	"client_id"?: string
+	"project_number"?: number
+}

package/test/tmp/src/types/project_query.ts

@@ -0,0 +1,27 @@
+export type project_query = {
+	"limit"?: number
+	"cursor"?: string
+	"sort_order"?: ("ascending" | "descending")
+	"_id"?: string
+	"_id_gt"?: string
+	"_id_lt"?: string
+	"_id_in"?: string[]
+	"name"?: string
+	"name_gt"?: string
+	"name_lt"?: string
+	"name_in"?: string[]
+	"institution_id"?: string
+	"institution_id_gt"?: string
+	"institution_id_lt"?: string
+	"institution_id_in"?: string[]
+	"client_id"?: string
+	"client_id_gt"?: string
+	"client_id_lt"?: string
+	"client_id_in"?: string[]
+	"project_number"?: number
+	"project_number_gt"?: number
+	"project_number_gte"?: number
+	"project_number_lt"?: number
+	"project_number_lte"?: number
+	"sort"?: ("_id" | "name" | "institution_id" | "client_id" | "project_number")
+}

package/test/tmp/src/utils/utils.ts

@@ -0,0 +1,17 @@
+// this is copied directly to ./utils/utils.ts
+
+export function encode_search_params(params: {[key: string]: string | number | boolean | string[]}): {[key: string]: string | number | boolean }{
+    let retval: {[key: string]: string | number | boolean } = {}
+    for(let [key, value] of Object.entries(params)){
+        if(Array.isArray(value)){
+            retval[key] = value.join(',')
+        } else {
+            retval[key] = value;
+        }
+    }
+
+    return retval;
+}
+
+export type Response<Q> = { data: Q }
+export type Response_Multiple<Q> = { data: Q[] }

package/test/tmp/tsconfig.json

@@ -0,0 +1,14 @@
+{
+    "compilerOptions": {
+      "module": "node16",
+      "noImplicitAny": true,
+      "removeComments": true,
+      "preserveConstEnums": true,
+      "outDir": "dist",
+      "sourceMap": true,
+      "declaration": true,
+      //"declarationMap": true//check this
+    },
+    "include": ["src/**/*"],
+    "exclude": []
+  }

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+    "compilerOptions": {
+      "module": "node16",
+      "noImplicitAny": true,
+      "removeComments": true,
+      "preserveConstEnums": true,
+      "outDir": "dist",
+      "sourceMap": true,
+      "declaration": true,
+      //"declarationMap": true//check this
+    },
+    "include": ["src/**/*", "test/0_mongoose_from_zod.test.js"],
+    "exclude": []
+  }