@liminalfunctions/framework 1.0.0

package/src/code_generation/generate_client_library.ts

@@ -0,0 +1,197 @@
+import { F_Collection } from "../F_Collection.js";
+import { F_Collection_Registry } from "../F_Collection_Registry.js";
+import { access, mkdir, readFile, writeFile } from "node:fs/promises";
+import { type_from_zod } from "./utils/type_from_zod.js";
+import mustache from 'mustache'
+import { existsSync } from "node:fs";
+import { pretty_print } from "../utils/pretty_print_zod.js";
+
+
+type api_builder = {
+    collection?: F_Collection<string, any>,
+    mustache_context?: any,
+    children: {
+        [key: string]: api_builder
+    },
+    parent?: api_builder
+}
+
+
+export async function generate_client_library<Collections>(path: string, collection_registry: F_Collection_Registry<Collections>, service_name = 'default-service') {
+    let api_builder: api_builder = {
+        mustache_context: {},
+        children: {}
+    };
+
+    // build the typescript types
+    for(let col of Object.values(collection_registry.collections)){
+        let collection = col as F_Collection<string, any>;
+
+        let mustache_context = {
+            collection_id: collection.collection_id,
+
+            type_return: `${get_type_name(collection.collection_id)}`,
+            path_type_return: `types/${get_type_name(collection.collection_id)}`,
+
+            type_query: `${get_type_name(collection.collection_id)}_query`,
+            path_type_query: `types/${get_type_name(collection.collection_id)}_query`,
+
+            type_put: `${get_type_name(collection.collection_id)}_put`,
+            path_type_put: `types/${get_type_name(collection.collection_id)}_put`,
+
+            type_post: `${get_type_name(collection.collection_id)}_post`,
+            path_type_post: `types/${get_type_name(collection.collection_id)}_post`,
+        }
+
+        let collection_type_definition_builder = [] as string[];
+        let collection_type_main = type_from_zod(collection.validator, 0);
+        collection_type_definition_builder.push(`export type ${mustache_context.type_return} = ${collection_type_main[0]}`, ...collection_type_main.slice(1));
+
+        let collection_query_type_definition_builder = [] as string[];
+        let collection_type_query = type_from_zod(collection.query_validator_client, 0);
+        collection_query_type_definition_builder.push(`export type ${mustache_context.type_query} = ${collection_type_query[0]}`, ...collection_type_query.slice(1));
+
+        let collection_put_type_definition_builder = [] as string[];
+        let collection_type_put = type_from_zod(collection.put_validator, 0);
+        collection_put_type_definition_builder.push(`export type ${mustache_context.type_put} = ${collection_type_put[0]}`, ...collection_type_put.slice(1));
+
+        let collection_post_type_definition_builder = [] as string[];
+        let collection_type_post = type_from_zod(collection.post_validator, 0);
+        collection_post_type_definition_builder.push(`export type ${mustache_context.type_post} = ${collection_type_post[0]}`, ...collection_type_post.slice(1));
+
+        if(!existsSync([path, 'src'].join('/'))){ await mkdir([path, 'src'].join('/')); }
+        if(!existsSync([path, 'dist'].join('/'))){ await mkdir([path, 'dist'].join('/')); }
+        if(!existsSync([path, 'src', 'types'].join('/'))){ await mkdir([path, 'src', 'types'].join('/')); }
+        if(!existsSync([path, 'src', 'utils'].join('/'))){ await mkdir([path, 'src', 'utils'].join('/')); }
+        await writeFile([path, 'src', 'utils', 'utils.ts'].join('/'), await readFile(import.meta.resolve('./templates/utils.ts.mustache').slice(8), { encoding: 'utf-8' }));
+        await writeFile([path, 'tsconfig.json'].join('/'), await readFile(import.meta.resolve('./templates/tsconfig.json.mustache').slice(8), { encoding: 'utf-8' }));
+        await writeFile([path, '.gitignore'].join('/'), await readFile(import.meta.resolve('./templates/.gitignore.mustache').slice(8), { encoding: 'utf-8' }));
+        await writeFile([path, 'src', mustache_context.path_type_return + '.ts'].join('/'), collection_type_definition_builder.join('\n'));
+        await writeFile([path, 'src', mustache_context.path_type_query + '.ts'].join('/'), collection_query_type_definition_builder.join('\n'));
+        await writeFile([path, 'src', mustache_context.path_type_put + '.ts'].join('/'), collection_put_type_definition_builder.join('\n'));
+        await writeFile([path, 'src', mustache_context.path_type_post + '.ts'].join('/'), collection_post_type_definition_builder.join('\n'));
+
+        for(let access_layer of collection.access_layers) {
+            let builder = get_builder(api_builder, access_layer.layers, collection, mustache_context);
+        }
+    }
+
+    let mustache_main = await readFile(import.meta.resolve('./templates/main.mustache').slice(8), { encoding: 'utf-8' });
+    let mustache_types = await readFile(import.meta.resolve('./templates/types.mustache').slice(8), { encoding: 'utf-8' });
+    let mustache_collection = await readFile(import.meta.resolve('./templates/collection.mustache').slice(8), { encoding: 'utf-8' });
+    let mustache_package = await readFile(import.meta.resolve('./templates/package.json.mustache').slice(8), { encoding: 'utf-8' });
+
+    let builder_leaves = [];
+    let queue: api_builder[] = [api_builder];
+    while(queue.length > 0){
+        let builder = queue.shift();
+
+        let children = Object.values(builder.children);
+        if(children.length > 0){
+            queue.push(...children);
+        } else {
+            builder_leaves.push(builder);
+        }
+        
+        builder.mustache_context.child_collection_id_types = `"${children.map(ele => ele.mustache_context.collection_id).join('" | "')}"`
+        builder.mustache_context.child_collections = children.map(ele => {
+            return {
+                collection_id: ele.mustache_context.collection_id,
+                built_collection: uppercase(ele.mustache_context.collection_id),
+                built_collection_path: `./${uppercase(ele.mustache_context.collection_id)}.js`
+            }
+        })
+    }
+
+    // save the escape function used by mustache so that if another
+    // tool or portion of the tool uses mustache, we don't create
+    // a difficult-to-diagnose bug. It is important not to have any
+    // async calls until we have restored the original escape function.
+    let original_escape = mustache.escape;
+    mustache.escape = (text) => text;
+
+    let rendered_index = mustache.render(mustache_main, api_builder.mustache_context);
+    let rendered_collection_manipulators = [];
+
+    queue = Object.values(api_builder.children)
+    let added = new Set(Object.values(api_builder.children));
+    while(queue.length > 0){
+        let builder = queue.shift();
+        builder.mustache_context.my_built_collection = uppercase(builder.mustache_context.collection_id);
+        builder.mustache_context.my_built_collection_path = `./${uppercase(builder.mustache_context.collection_id)}`;
+        builder.mustache_context.types = mustache.render(mustache_types, builder.mustache_context);
+        builder.mustache_context.has_subcollections = builder.mustache_context.child_collections.length > 0;
+        rendered_collection_manipulators.push({builder: builder, text: mustache.render(mustache_collection, builder.mustache_context)})
+        queue.push(...Object.values(builder.children).filter(ele => !added.has(ele)));
+        for(let child of Object.values(builder.children)){
+            added.add(child);
+        }
+    }
+
+    let rendered_package_json = mustache.render(mustache_package, {
+        server_name: service_name
+    });
+
+    // restore the original escape function so that it the escape function
+    // used by this code doesn't interfere with other vode.
+    mustache.escape = original_escape;
+
+
+    await writeFile([path, 'src', './index.ts'].join('/'), rendered_index);
+    for(let manipulator of rendered_collection_manipulators) {
+        await writeFile([path, 'src', manipulator.builder.mustache_context.my_built_collection_path as string + '.ts'].join('/'), manipulator.text);
+    }
+    await writeFile([path, './package.json'].join('/'), rendered_package_json);
+}
+
+export function get_type_name(collection_id: string, suffix?: string): string {
+    return suffix ? `${collection_id}_${suffix}`.replace(/[^(a-zA-Z0-9\_)]/g, '_') : collection_id.replace(/[^(a-zA-Z0-9\_)]/g, '_');
+}
+
+export function uppercase(str: string): string {
+    let upper_on = true;
+    let joinable = [];
+    for(let char of str) {
+        if(char === '_'){ upper_on = true; joinable.push(char); continue;}
+        if(upper_on) {
+            upper_on = false;
+            joinable.push(char.toUpperCase())
+        } else {
+           joinable.push(char)
+        }
+    }
+
+    return joinable.join('')
+}
+
+function get_builder(root: api_builder, parent_collection_ids: string[], collection: F_Collection<string, any>, mustache_context: any){
+    let builder = root;
+    let collection_ids = parent_collection_ids.slice();
+    while(collection_ids.length > 0){ 
+        let collection_id = collection_ids.shift();
+        if(!builder.children[collection_id]){
+            builder.children[collection_id] = {
+                children: {},
+                parent: builder,
+            }
+        }
+        builder = builder.children[collection_id];
+    }
+
+    if(!builder.children[collection.collection_id]){
+        builder.children[collection.collection_id] = {
+            children: {},
+            parent: builder,
+        }
+    }
+
+    builder = builder.children[collection.collection_id];
+
+    if(!builder.collection){
+        builder.collection = collection;
+        builder.mustache_context = mustache_context;
+    }
+    
+    return builder;
+}
+

package/src/code_generation/templates/.gitignore.mustache

@@ -0,0 +1,383 @@
+.env
+/test/tmp
+
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+##
+## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
+
+# User-specific files
+*.rsuser
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Mono auto generated files
+mono_crash.*
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+[Ww][Ii][Nn]32/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
+bld/
+[Bb]in/
+[Oo]bj/
+[Oo]ut/
+[Ll]og/
+[Ll]ogs/
+
+# Visual Studio 2015/2017 cache/options directory
+.vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# Visual Studio 2017 auto generated files
+Generated\ Files/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUnit
+*.VisualState.xml
+TestResult.xml
+nunit-*.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# Benchmark Results
+BenchmarkDotNet.Artifacts/
+
+# .NET Core
+project.lock.json
+project.fragment.lock.json
+artifacts/
+
+# ASP.NET Scaffolding
+ScaffoldingReadMe.txt
+
+# StyleCop
+StyleCopReport.xml
+
+# Files built by Visual Studio
+*_i.c
+*_p.c
+*_h.h
+*.ilk
+*.meta
+*.obj
+*.iobj
+*.pch
+*.pdb
+*.ipdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*_wpftmp.csproj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.db
+*.VC.VC.opendb
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# Visual Studio Trace Files
+*.e2e
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# AxoCover is a Code Coverage Tool
+.axoCover/*
+!.axoCover/settings.json
+
+# Coverlet is a free, cross platform Code Coverage Tool
+coverage*.json
+coverage*.xml
+coverage*.info
+
+# Visual Studio code coverage results
+*.coverage
+*.coveragexml
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# Note: Comment the next line if you want to checkin your web deploy settings,
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+PublishScripts/
+
+# NuGet Packages
+*.nupkg
+# NuGet Symbol Packages
+*.snupkg
+# The packages folder can be ignored because of Package Restore
+**/[Pp]ackages/*
+# except build/, which is used as an MSBuild target.
+!**/[Pp]ackages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/[Pp]ackages/repositories.config
+# NuGet v3's project.json files produces more ignorable files
+*.nuget.props
+*.nuget.targets
+
+# Microsoft Azure Build Output
+csx/
+*.build.csdef
+
+# Microsoft Azure Emulator
+ecf/
+rcf/
+
+# Windows Store app package directories and files
+AppPackages/
+BundleArtifacts/
+Package.StoreAssociation.xml
+_pkginfo.txt
+*.appx
+*.appxbundle
+*.appxupload
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!?*.[Cc]ache/
+
+# Others
+ClientBin/
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.jfm
+*.pfx
+*.publishsettings
+orleans.codegen.cs
+
+# Including strong name files can present a security risk
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+#*.snk
+
+# Since there are multiple workflows, uncomment next line to ignore bower_components
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+#bower_components/
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+ServiceFabricBackup/
+*.rptproj.bak
+
+# SQL Server files
+*.mdf
+*.ldf
+*.ndf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+*.rptproj.rsuser
+*- [Bb]ackup.rdl
+*- [Bb]ackup ([0-9]).rdl
+*- [Bb]ackup ([0-9][0-9]).rdl
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+node_modules/
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
+*.vbw
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
+
+# Paket dependency manager
+.paket/paket.exe
+paket-files/
+
+# FAKE - F# Make
+.fake/
+
+# CodeRush personal settings
+.cr/personal
+
+# Python Tools for Visual Studio (PTVS)
+__pycache__/
+*.pyc
+
+# Cake - Uncomment if you are using it
+# tools/**
+# !tools/packages.config
+
+# Tabs Studio
+*.tss
+
+# Telerik's JustMock configuration file
+*.jmconfig
+
+# BizTalk build output
+*.btp.cs
+*.btm.cs
+*.odx.cs
+*.xsd.cs
+
+# OpenCover UI analysis results
+OpenCover/
+
+# Azure Stream Analytics local run output
+ASALocalRun/
+
+# MSBuild Binary and Structured Log
+*.binlog
+
+# NVidia Nsight GPU debugger configuration file
+*.nvuser
+
+# MFractors (Xamarin productivity tool) working folder
+.mfractor/
+
+# Local History for Visual Studio
+.localhistory/
+
+# BeatPulse healthcheck temp database
+healthchecksdb
+
+# Backup folder for Package Reference Convert tool in Visual Studio 2017
+MigrationBackup/
+
+# Ionide (cross platform F# VS Code tools) working folder
+.ionide/
+
+# Fody - auto-generated XML schema
+FodyWeavers.xsd
+internal_dependencies/copypress-thematical-pp-common-libraries-1.0.0.tgz
+plugins/rsa
+check_24h.csv
+check_2025-02-11.csv
+check_2025-02-12.csv
+check_start.csv
+check_url_constrained.csv
+check_2025-02-13_2.csv
+check_2025-02-13.csv
+check_2025-02-14.csv
+check_2025-02-18.csv
+check_2025-02-19.csv
+check_2025-02-24_big.csv
+check_2025-02-24.csv
+check_2025-02-27_rock.csv
+hub_spoke_test.txt
+hub_spoke_test_spokes.txt

package/src/code_generation/templates/collection.mustache

@@ -0,0 +1,106 @@
+import ky from "ky";
+import { encode_search_params, Response, Response_Multiple } from "./utils/utils.js";
+
+{{#child_collections}}
+import { Collection_{{built_collection}} } from "{{ built_collection_path }}"
+{{/child_collections}}
+
+{{types}}
+
+export class Collection_{{my_built_collection}} {
+    path: string[]
+    get_auth: () => Promise<any>
+
+    constructor(path: string[], get_auth: () => Promise<any>) {
+        this.path = path;
+        this.get_auth = get_auth;
+    }
+
+    
+    async query(query: {{type_query}}): Promise<{{type_return}}[]>{
+        try {
+            let result = await ky.get(this.path.join('/'), {
+                headers: {
+                    authorization: await this.get_auth()
+                },
+                searchParams: encode_search_params(query)
+            }).json() as Response_Multiple<{{type_return}}>;
+            return result.data;
+        } catch(err){
+            return Promise.reject(err)
+        }
+    }
+
+    async post(document: {{type_post}}): Promise<{{type_return}}>{
+        try {
+            let result = await ky.post(this.path.join('/'), {
+                headers: {
+                    authorization: await this.get_auth()
+                },
+                json: document
+            }).json() as Response<{{type_return}}>;
+            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<{{type_return}}>{
+                try {
+                    let result = await ky.get([...path, document_id].join('/'), {
+                        headers: {
+                            authorization: await get_auth()
+                        },
+                    }).json() as Response<{{type_return}}>;
+                    return result.data;
+                } catch(err){
+                    return Promise.reject(err)
+                }
+            },
+
+            async put(update: {{type_put}}): Promise<{{type_return}}>{
+                try {
+                    let result = await ky.put([...path, document_id].join('/'), {
+                        headers: {
+                            authorization: await get_auth()
+                        },
+                        json: update
+                    }).json() as Response<{{type_return}}>;
+                    return result.data;
+                } catch(err){
+                    return Promise.reject(err)
+                }
+            },
+            
+            async remove(): Promise<{{type_return}}>{
+                try {
+                    let result = await ky.delete([...path, document_id].join('/'), {
+                        headers: {
+                            authorization: await get_auth()
+                        },
+                    }).json() as Response<{{type_return}}>;
+                    return result.data;
+                } catch(err){
+                    return Promise.reject(err)
+                }
+            },
+
+            {{#has_subcollections}}
+            collection(collection_id: {{child_collection_id_types}}) {
+                switch(collection_id) {
+                    {{#child_collections}}
+                    case "{{collection_id}}":
+                        return new Collection_{{built_collection}}([...path, document_id, "{{collection_id}}"], get_auth);
+                    {{/child_collections}}
+                    default:
+                        throw new Error(`Api does not have the collection ${collection_id}`)
+                }
+            }
+            {{/has_subcollections}}
+        }
+    }
+}

package/src/code_generation/templates/main.mustache

@@ -0,0 +1,24 @@
+import ky from 'ky';
+
+{{types}}
+{{#child_collections}}
+import { Collection_{{built_collection}} } from "{{ built_collection_path }}"
+{{/child_collections}}
+
+
+export function api(base_url: string, get_auth: () => Promise<any>) {
+    return {
+        collection(collection_id: {{child_collection_id_types}}) {
+            switch(collection_id) {
+                {{#child_collections}}
+                case "{{collection_id}}":
+                    return new Collection_{{built_collection}}([base_url, "{{collection_id}}"], get_auth);
+                {{/child_collections}}
+                default:
+                    throw new Error(`Api does not have the collection ${collection_id}`)
+            }
+        }
+    }
+}
+
+