Skip to content
Coalesce404
PAGE NOT FOUND
But if you don't change your direction, and if you keep looking, you may end up where you are heading.
404
But if you don't change your direction, and if you keep looking, you may end up where you are heading.
Coalesce is a free and open-source framework created by IntelliTect to fill our desire to create better apps, faster. IntelliTect is a high-end software architecture and development consulting firm based in Spokane, Washington.
If you're looking for help with your software project, whether it be a Coalesce application, other technologies, or even just an idea, reach out to us at info@intellitect.com — we'd love to start a conversation! Our clients range from Fortune 100 companies to local small businesses and non-profits.
`,b.langId&&(k+=`",k}const it={"&":"&","<":"<",">":">",'"':""","'":"'"};function ct(h){return h.replace(/[&<>"']/g,b=>it[b])}function ut(h){var b;const j=new Set(["line"]);for(const n of h)for(const S of(b=n.classes)!==null&&b!==void 0?b:[])j.add(S);return Array.from(j)}class lt extends Ie.Registry{constructor(b){super(b),this._resolver=b,this.themesPath="themes/",this._resolvedThemes={},this._resolvedGrammars={}}getTheme(b){return typeof b=="string"?this._resolvedThemes[b]:b}async loadTheme(b){return typeof b=="string"?(this._resolvedThemes[b]||(this._resolvedThemes[b]=await Me(`${this.themesPath}${b}.json`)),this._resolvedThemes[b]):(b=De(b),b.name&&(this._resolvedThemes[b.name]=b),b)}async loadThemes(b){return await Promise.all(b.map(j=>this.loadTheme(j)))}getLoadedThemes(){return Object.keys(this._resolvedThemes)}getGrammar(b){return this._resolvedGrammars[b]}async loadLanguage(b){const j=await this.loadGrammar(b.scopeName);this._resolvedGrammars[b.id]=j,b.aliases&&b.aliases.forEach(n=>{this._resolvedGrammars[n]=j})}async loadLanguages(b){for(const j of b)this._resolver.addLanguage(j);for(const j of b)await this.loadLanguage(j)}getLoadedLanguages(){return Object.keys(this._resolvedGrammars)}}function Ge(h){return typeof h=="string"?je.find(b=>{var j;return b.id===h||((j=b.aliases)===null||j===void 0?void 0:j.includes(h))}):h}function pt(h){var b;let j=je,n=h.themes||[];return!((b=h.langs)===null||b===void 0)&&b.length&&(j=h.langs.map(Ge)),h.theme&&n.unshift(h.theme),n.length||(n=["nord"]),{_languages:j,_themes:n}}async function gt(h){var b,j;const{_languages:n,_themes:S}=pt(h),k=new tt(Je(),"vscode-oniguruma"),_=new lt(k);!((b=h.paths)===null||b===void 0)&&b.themes&&(_.themesPath=h.paths.themes),!((j=h.paths)===null||j===void 0)&&j.languages&&(k.languagesPath=h.paths.languages);const N=(await _.loadThemes(S))[0];let s;await _.loadLanguages(n);const m={"#000001":"var(--shiki-color-text)","#000002":"var(--shiki-color-background)","#000004":"var(--shiki-token-constant)","#000005":"var(--shiki-token-string)","#000006":"var(--shiki-token-comment)","#000007":"var(--shiki-token-keyword)","#000008":"var(--shiki-token-parameter)","#000009":"var(--shiki-token-function)","#000010":"var(--shiki-token-string-expression)","#000011":"var(--shiki-token-punctuation)","#000012":"var(--shiki-token-link)"};function L(t,r){t.bg=m[t.bg]||t.bg,t.fg=m[t.fg]||t.fg,r.forEach((y,v)=>{r[v]=m[y]||y})}function w(t){const r=t?_.getTheme(t):N;if(!r)throw Error(`No theme registration for ${t}`);(!s||s.name!==r.name)&&(_.setTheme(r),s=r);const y=_.getColorMap();return r.name==="css-variables"&&L(r,y),{_theme:r,_colorMap:y}}function o(t){const r=_.getGrammar(t);if(!r)throw Error(`No language registration for ${t}`);return{_grammar:r}}function A(t,r="text",y,v={includeExplanation:!0}){if(ht(r))return[...t.split(/\r\n|\r|\n/).map(K=>[{content:K}])];const{_grammar:T}=o(r),{_theme:x,_colorMap:I}=w(y);return nt(x,I,t,T,v)}function d(t,r="text",y){let v;typeof r=="object"?v=r:v={lang:r,theme:y};const T=A(t,v.lang,v.theme,{includeExplanation:!1}),{_theme:x}=w(v.theme);return ot(T,{fg:x.fg,bg:x.bg,lineOptions:v==null?void 0:v.lineOptions})}async function u(t){await _.loadTheme(t)}async function l(t){const r=Ge(t);k.addLanguage(r),await _.loadLanguage(r)}function p(){return _.getLoadedThemes()}function i(){return _.getLoadedLanguages()}function c(t){const{_theme:r}=w(t);return r.bg}function e(t){const{_theme:r}=w(t);return r.fg}return{codeToThemedTokens:A,codeToHtml:d,getTheme:t=>w(t)._theme,loadTheme:u,loadLanguage:l,getBackgroundColor:c,getForegroundColor:e,getLoadedThemes:p,getLoadedLanguages:i}}function ht(h){return!h||["plaintext","txt","text"].includes(h)}function mt(h){Xe(h)}export{je as BUNDLED_LANGUAGES,ft as BUNDLED_THEMES,me as FontStyle,gt as getHighlighter,Me as loadTheme,ot as renderToHtml,dt as setCDN,mt as setOnigasmWASM,Xe as setWasm,De as toShikiTheme}; diff --git a/assets/chunks/theme.h7w36Qzb.js b/assets/chunks/theme.h7w36Qzb.js new file mode 100644 index 000000000..40bb9ea28 --- /dev/null +++ b/assets/chunks/theme.h7w36Qzb.js @@ -0,0 +1,7 @@ +import{d as g,o as a,c as l,r as u,n as N,a as H,t as S,_ as m,b as k,w as h,e as f,T as ce,u as ze,i as Ee,l as De,f as ue,g as b,h as T,j as U,k as c,m as i,p as E,q as D,s as x,v as K,x as re,y as G,z as ee,A as te,B as we,C as Fe,D as j,F as A,E as B,G as de,H as Y,I as _,J as O,K as Pe,L as se,M as X,N as ne,O as Oe,P as xe,Q as Ve,R as Ue,S as Ge,U as je,V as qe,W as Re,X as Ke,Y as Le,Z as Se,$ as We,a0 as Ye,a1 as Je,a2 as Xe}from"./framework.g9eZ-ZSs.js";const Ze=g({__name:"VPBadge",props:{text:{},type:{default:"tip"}},setup(s){return(e,t)=>(a(),l("span",{class:N(["VPBadge",e.type])},[u(e.$slots,"default",{},()=>[H(S(e.text),1)],!0)],2))}}),Qe=m(Ze,[["__scopeId","data-v-ea5b2908"]]),et={key:0,class:"VPBackdrop"},tt=g({__name:"VPBackdrop",props:{show:{type:Boolean}},setup(s){return(e,t)=>(a(),k(ce,{name:"fade"},{default:h(()=>[e.show?(a(),l("div",et)):f("",!0)]),_:1}))}}),st=m(tt,[["__scopeId","data-v-54a304ca"]]),y=ze;function nt(s,e){let t,n=!1;return()=>{t&&clearTimeout(t),n?t=setTimeout(s,e):(s(),(n=!0)&&setTimeout(()=>n=!1,e))}}function ie(s){return/^\//.test(s)?s:`/${s}`}function ve(s){const{pathname:e,search:t,hash:n,protocol:o}=new URL(s,"http://a.com");if(Ee(s)||s.startsWith("#")||!o.startsWith("http")||/\.(?!html|md)\w+($|\?)/i.test(s)&&De(s))return s;const{site:r}=y(),d=e.endsWith("/")||e.endsWith(".html")?s:s.replace(/(?:(^\.+)\/)?.*$/,`$1${e.replace(/(\.md)?$/,r.value.cleanUrls?"":".html")}${t}${n}`);return ue(d)}function J({removeCurrent:s=!0,correspondingLink:e=!1}={}){const{site:t,localeIndex:n,page:o,theme:r}=y(),d=b(()=>{var v,$;return{label:(v=t.value.locales[n.value])==null?void 0:v.label,link:(($=t.value.locales[n.value])==null?void 0:$.link)||(n.value==="root"?"/":`/${n.value}/`)}});return{localeLinks:b(()=>Object.entries(t.value.locales).flatMap(([v,$])=>s&&d.value.label===$.label?[]:{text:$.label,link:ot($.link||(v==="root"?"/":`/${v}/`),r.value.i18nRouting!==!1&&e,o.value.relativePath.slice(d.value.link.length-1),!t.value.cleanUrls)})),currentLang:d}}function ot(s,e,t,n){return e?s.replace(/\/$/,"")+ie(t.replace(/(^|\/)index\.md$/,"$1").replace(/\.md$/,n?".html":"")):s}const at=s=>(E("data-v-b9c0c15a"),s=s(),D(),s),rt={class:"NotFound"},it={class:"code"},lt={class:"title"},ct=at(()=>c("div",{class:"divider"},null,-1)),ut={class:"quote"},dt={class:"action"},vt=["href","aria-label"],ht=g({__name:"NotFound",setup(s){const{site:e,theme:t}=y(),{localeLinks:n}=J({removeCurrent:!1}),o=T("/");return U(()=>{var d;const r=window.location.pathname.replace(e.value.base,"").replace(/(^.*?\/).*$/,"/$1");n.value.length&&(o.value=((d=n.value.find(({link:p})=>p.startsWith(r)))==null?void 0:d.link)||n.value[0].link)}),(r,d)=>{var p,v,$,w,M;return a(),l("div",rt,[c("p",it,S(((p=i(t).notFound)==null?void 0:p.code)??"404"),1),c("h1",lt,S(((v=i(t).notFound)==null?void 0:v.title)??"PAGE NOT FOUND"),1),ct,c("blockquote",ut,S((($=i(t).notFound)==null?void 0:$.quote)??"But if you don't change your direction, and if you keep looking, you may end up where you are heading."),1),c("div",dt,[c("a",{class:"link",href:i(ue)(o.value),"aria-label":((w=i(t).notFound)==null?void 0:w.linkLabel)??"go to home"},S(((M=i(t).notFound)==null?void 0:M.linkText)??"Take me home"),9,vt)])])}}}),pt=m(ht,[["__scopeId","data-v-b9c0c15a"]]);function Me(s,e){if(Array.isArray(s))return Z(s);if(s==null)return[];e=ie(e);const t=Object.keys(s).sort((o,r)=>r.split("/").length-o.split("/").length).find(o=>e.startsWith(ie(o))),n=t?s[t]:[];return Array.isArray(n)?Z(n):Z(n.items,n.base)}function _t(s){const e=[];let t=0;for(const n in s){const o=s[n];if(o.items){t=e.push(o);continue}e[t]||e.push({items:[]}),e[t].items.push(o)}return e}function ft(s){const e=[];function t(n){for(const o of n)o.text&&o.link&&e.push({text:o.text,link:o.link,docFooterText:o.docFooterText}),o.items&&t(o.items)}return t(s),e}function le(s,e){return Array.isArray(e)?e.some(t=>le(s,t)):x(s,e.link)?!0:e.items?le(s,e.items):!1}function Z(s,e){return[...s].map(t=>{const n={...t},o=n.base||e;return o&&n.link&&(n.link=o+n.link),n.items&&(n.items=Z(n.items,o)),n})}function F(){const{frontmatter:s,page:e,theme:t}=y(),n=re("(min-width: 960px)"),o=T(!1),r=b(()=>{const I=t.value.sidebar,L=e.value.relativePath;return I?Me(I,L):[]}),d=T(r.value);G(r,(I,L)=>{JSON.stringify(I)!==JSON.stringify(L)&&(d.value=r.value)});const p=b(()=>s.value.sidebar!==!1&&d.value.length>0&&s.value.layout!=="home"),v=b(()=>$?s.value.aside==null?t.value.aside==="left":s.value.aside==="left":!1),$=b(()=>s.value.layout==="home"?!1:s.value.aside!=null?!!s.value.aside:t.value.aside!==!1),w=b(()=>p.value&&n.value),M=b(()=>p.value?_t(d.value):[]);function C(){o.value=!0}function V(){o.value=!1}function P(){o.value?V():C()}return{isOpen:o,sidebar:d,sidebarGroups:M,hasSidebar:p,hasAside:$,leftAside:v,isSidebarEnabled:w,open:C,close:V,toggle:P}}function mt(s,e){let t;ee(()=>{t=s.value?document.activeElement:void 0}),U(()=>{window.addEventListener("keyup",n)}),te(()=>{window.removeEventListener("keyup",n)});function n(o){o.key==="Escape"&&s.value&&(e(),t==null||t.focus())}}const Ce=T(K?location.hash:"");K&&window.addEventListener("hashchange",()=>{Ce.value=location.hash});function gt(s){const{page:e}=y(),t=T(!1),n=b(()=>s.value.collapsed!=null),o=b(()=>!!s.value.link),r=T(!1),d=()=>{r.value=x(e.value.relativePath,s.value.link)};G([e,s,Ce],d),U(d);const p=b(()=>r.value?!0:s.value.items?le(e.value.relativePath,s.value.items):!1),v=b(()=>!!(s.value.items&&s.value.items.length));ee(()=>{t.value=!!(n.value&&s.value.collapsed)}),we(()=>{(r.value||p.value)&&(t.value=!1)});function $(){n.value&&(t.value=!t.value)}return{collapsed:t,collapsible:n,isLink:o,isActiveLink:r,hasActiveLink:p,hasChildren:v,toggle:$}}function $t(){const{hasSidebar:s}=F(),e=re("(min-width: 960px)"),t=re("(min-width: 1280px)");return{isAsideEnabled:b(()=>!t.value&&!e.value?!1:s.value?t.value:e.value)}}const kt=71;function he(s){return typeof s.outline=="object"&&!Array.isArray(s.outline)&&s.outline.label||s.outlineTitle||"On this page"}function pe(s){const e=[...document.querySelectorAll(".VPDoc :where(h1,h2,h3,h4,h5,h6)")].filter(t=>t.id&&t.hasChildNodes()).map(t=>{const n=Number(t.tagName[1]);return{title:bt(t),link:"#"+t.id,level:n}});return yt(e,s)}function bt(s){let e="";for(const t of s.childNodes)if(t.nodeType===1){if(t.classList.contains("VPBadge")||t.classList.contains("header-anchor"))continue;e+=t.textContent}else t.nodeType===3&&(e+=t.textContent);return e.trim()}function yt(s,e){if(e===!1)return[];const t=(typeof e=="object"&&!Array.isArray(e)?e.level:e)||2,[n,o]=typeof t=="number"?[t,t]:t==="deep"?[2,6]:t;s=s.filter(d=>d.level>=n&&d.level<=o);const r=[];e:for(let d=0;d${b.langId}`),k+="",h.forEach((_,O)=>{var N;const s=O+1,m=(N=S.get(s))!==null&&N!==void 0?N:[],L=ut(m).join(" ");k+=``,_.forEach(w=>{const o=[`color: ${w.color||b.fg}`];w.fontStyle&me.Italic&&o.push("font-style: italic"),w.fontStyle&me.Bold&&o.push("font-weight: bold"),w.fontStyle&me.Underline&&o.push("text-decoration: underline"),k+=`${ct(w.content)}`}),k+=` +`}),k=k.replace(/\n*$/,""),k+="
When Coalesce maps from the your POCO objects that are returned from EF Core queries, it will follow a structure called an IncludeTree to determine what relationships to follow and how deep to go in re-creating that structure in the mapped DTOs.
Without an IncludeTree present, Coalesce will map the entire object graph that is reachable from the root object. This can often spiral out of control if there aren't any rules defining how far to go while turning this graph into a tree.
For example, suppose you had the following model with a many-to-many relationship (key properties omitted for brevity):
public class Employee
+{
+ [ManyToMany("Projects")]
+ public ICollection<EmployeeProject> EmployeeProjects { get; set; }
+
+ public static IQueryable<Employee> WithProjectsAndMembers(AppDbContext db, ClaimsPrincipal user)
+ {
+ // Load all projects of an employee, as well as all members of those projects.
+ return db.Employees
+ .Include(e => e.EmployeeProjects)
+ .ThenInclude(ep => ep.Project.EmployeeProjects)
+ .ThenInclude(ep => ep.Employee);
+ }
+}
+
+public class Project
+{
+ [ManyToMany("Employees")]
+ public ICollection<EmployeeProject> EmployeeProjects { get; set; }
+}
+
+public class EmployeeProject
+{
+ public Employee Employee { get; set; }
+ public Project Project { get; set; }
+}Now, imagine that you have five employees and five projects, with every employee being a member of every project (i.e. there are 25 EmployeeProject rows).
Your client code makes a call to the Coalesce-generated API to load Employee #1 using the custom data source:
`,8),i=s("div",{class:"language-ts"},[s("button",{title:"Copy Code",class:"copy"}),s("span",{class:"lang"},"ts"),s("pre",{class:"shiki dark-plus vp-code"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#C586C0"}},"import"),s("span",{style:{color:"#D4D4D4"}}," { "),s("span",{style:{color:"#9CDCFE"}},"Employee"),s("span",{style:{color:"#D4D4D4"}}," } "),s("span",{style:{color:"#C586C0"}},"from"),s("span",{style:{color:"#CE9178"}}," '@/viewmodels.g'")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#C586C0"}},"import"),s("span",{style:{color:"#D4D4D4"}}," { "),s("span",{style:{color:"#9CDCFE"}},"EmployeeViewModel"),s("span",{style:{color:"#D4D4D4"}}," } "),s("span",{style:{color:"#C586C0"}},"from"),s("span",{style:{color:"#CE9178"}}," '@/viewmodels.g'")]),e(` +`),s("span",{class:"line"}),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#569CD6"}},"var"),s("span",{style:{color:"#9CDCFE"}}," employee"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#569CD6"}},"new"),s("span",{style:{color:"#DCDCAA"}}," EmployeeViewModel"),s("span",{style:{color:"#D4D4D4"}},"();")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#9CDCFE"}},"employee"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#9CDCFE"}},"$dataSource"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#569CD6"}},"new"),s("span",{style:{color:"#9CDCFE"}}," Employee"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#9CDCFE"}},"DataSources"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#DCDCAA"}},"WithProjectsAndMembers"),s("span",{style:{color:"#D4D4D4"}},"();")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#9CDCFE"}},"employee"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#DCDCAA"}},"$load"),s("span",{style:{color:"#D4D4D4"}},"("),s("span",{style:{color:"#B5CEA8"}},"1"),s("span",{style:{color:"#D4D4D4"}},");")])])])],-1),d=s("div",{class:"language-ts"},[s("button",{title:"Copy Code",class:"copy"}),s("span",{class:"lang"},"ts"),s("pre",{class:"shiki dark-plus vp-code"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#569CD6"}},"var"),s("span",{style:{color:"#9CDCFE"}}," employee"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#569CD6"}},"new"),s("span",{style:{color:"#9CDCFE"}}," ViewModels"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#DCDCAA"}},"Employee"),s("span",{style:{color:"#D4D4D4"}},"();")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#9CDCFE"}},"employee"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#9CDCFE"}},"dataSource"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#569CD6"}},"new"),s("span",{style:{color:"#9CDCFE"}}," employee"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#9CDCFE"}},"dataSources"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#DCDCAA"}},"WithProjectsAndMembers"),s("span",{style:{color:"#D4D4D4"}},"();")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#9CDCFE"}},"employee"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#DCDCAA"}},"load"),s("span",{style:{color:"#D4D4D4"}},"("),s("span",{style:{color:"#B5CEA8"}},"1"),s("span",{style:{color:"#D4D4D4"}},");")])])])],-1),C=n(`If you're already familiar with the fact that an IncludeTree is implicitly created in this scenario, then imagine for a moment that this is not the case (if you're not familiar with this fact, then keep reading!).
After Coalesce has called your Data Sources and evaluated the EF IQueryable returned, there are now 35 objects loaded into the current DbContext being used to handle this request - the 5 employees, 5 projects, and 25 relationships.
To map these objects to DTOs, we start with the root (employee #1) and expand outward from there until the entire object graph has been faithfully re-created with DTO objects, including all navigation properties.
The root DTO object (employee #1) then eventually is passed to the JSON serializer by ASP.NET Core to formulate the response to the request. As the object is serialized to JSON, the only objects that are not serialized are those that were already serialized as an ancestor of itself. What this ultimately means is that the structure of the serialized JSON with our example scenario ends up following a pattern like this (the vast majority of items have been omitted):
Employee#1
+ EmployeeProject#1
+ Project#1
+ EmployeeProject#6
+ Employee#2
+ EmployeeProject#7
+ Project#2
+ ... continues down through all remaining employees and projects.
+ ...
+ EmployeeProject#11
+ Employee#3
+ ...
+ EmployeeProject#2
+ Project#2
+ ...See how the structure includes the EmployeeProjects of Employee#2? We didn't write our custom data source calls to .Include in such a way that indicated that we wanted the root employee, their projects, the employees of those projects, and then the projects of those employees. But, because the JSON serializer blindly follows the object graph, that's what gets serialized. It turns out that the depth of the tree increases on the order of O(n^2), and the total size increases on the order of Ω(n!).
This is where IncludeTree comes in. When you use a custom data source like we did above, Coalesce automatically captures the structure of the calls to .Include and .ThenInclude, and uses this to perform trimming during creation of the DTO objects.
With an IncludeTree in place, our new serialized structure looks like this:
Employee#1
+ EmployeeProject#1
+ Project#1
+ EmployeeProject#6
+ Employee#2
+ EmployeeProject#11
+ Employee#3
+ ...
+ EmployeeProject#2
+ Project#2
+ ...No more extra data trailing off the end of the projects' employees!
In most cases, you don't have to worry about creating an IncludeTree. When using the Standard Data Source (or a derivative), the structure of the .Include and .ThenInclude calls will be captured automatically and be turned into an IncludeTree.
However, there are sometimes cases where you perform complex loading in these methods that involves loading data into the current DbContext outside of the IQueryable that is returned from the method. The most common situation for this is needing to conditionally load related data - for example, load all children of an object where the child has a certain value of a Status property.
In these cases, Coalesce provides a pair of extension methods, .IncludedSeparately and .ThenIncluded, that can be used to merge in the structure of the data that was loaded separately from the main IQueryable.
For example:
public override IQueryable<Employee> GetQuery()
+{
+ // Load all projects that are complete, and their members, into the db context.
+ Db.Projects
+ .Include(p => p.EmployeeProjects).ThenInclude(ep => ep.Employee)
+ .Where(p => p.Status == ProjectStatus.Complete)
+ .Load();
+
+ // Return an employee query, and notify Coalesce that we loaded the projects in a different query.
+ return Db.Employees
+ .IncludedSeparately(e => e.EmployeeProjects)
+ .ThenIncluded(ep => ep.Project.EmployeeProjects)
+ .ThenIncluded(ep => ep.Employee);
+}You can also override the GetIncludeTree method of the Standard Data Source to achieve the same result:
public override IncludeTree GetIncludeTree(IQueryable<T> query, IDataSourceParameters parameters) => Db
+ .Employees
+ .IncludedSeparately(e => e.EmployeeProjects)
+ .ThenIncluded(ep => ep.Project.EmployeeProjects)
+ .ThenIncluded(ep => ep.Employee)
+ .GetIncludeTree();If you have custom methods that return object data, you may also want to control the structure of the returned data when it is serialized. Fortunately, you can also use IncludeTree in these situations. Without an IncludeTree, the entire object graph is traversed and serialized without limit.
TIP
An IncludeTree can be obtained from any IQueryable by calling the GetIncludeTree extension method (using IntelliTect.Coalesce.Helpers.IncludeTree).
In situations where your root object isn't on your DbContext (see External Types), you can use Enumerable.Empty<MyNonDbClass>().AsQueryable() to get an IQueryable to start from. When you do this, you must use IncludedSeparately - the regular EF Include method won't work without a DbSet.
See the following two techniques for returning an IncludeTree from a custom method:
The easiest and most versatile way to return an IncludeTree from a custom method is to make that method return an ItemResult<T>, and then set the IncludeTree property of the ItemResult object. For example:
public class Employee
+{
+ public async Task<ItemResult<ICollection<Employee>>> GetChainOfCommand(AppDbContext db)
+ {
+ IQueryable<Employee> query = db.Employees
+ .Include(e => e.Supervisor);
+
+ var ret = new List<Employee>();
+ var current = this;
+ while (current.Supervisor != null)
+ {
+ ret.Push(current);
+ current = await query.FirstOrDefaultAsync(e => e.EmployeeId == current.SupervisorId);
+ }
+
+ return new(ret, includeTree: query.GetIncludeTree());
+ }
+}To tell Coalesce about the structure of the data returned from a model method, you can also add out IncludeTree includeTree to the signature of the method. Inside your method, set includeTree to an instance of an IncludeTree. However, this approach cannot be used on async methods, since out parameters are not allowed on async methods in C#. For example:
public class Employee
+{
+ public ICollection<Employee> GetChainOfCommand(AppDbContext db, out IncludeTree includeTree)
+ {
+ IQueryable<Employee> query = db.Employees
+ .Include(e => e.Supervisor);
+
+ var ret = new List<Employee>();
+ var current = this;
+ while (current.Supervisor != null)
+ {
+ ret.Push(current);
+ current = query.FirstOrDefault(e => e.EmployeeId == current.SupervisorId);
+ }
+
+ includeTree = query.GetIncludeTree();
+
+ return ret;
+ }
+}One important point remains regarding IncludeTree - it is not used to control the serialization of objects which are not mapped to the database, known as External Types. External Types are always put into the DTOs when encountered (unless otherwise prevented by [DtoIncludes] & [DtoExcludes] or Security Attributes), with the assumption that because these objects are created by you (as opposed to Entity Framework), you are responsible for preventing any undesired circular references.
By not filtering unmapped properties, you as the developer don't need to account for them in every place throughout your application where they appear - instead, they 'just work' and show up on the client as expected.
Note also that this statement does not apply to database-mapped objects that hang off of unmapped objects - any time a database-mapped object appears, it will be controlled by your include tree. If no include tree is present (because nothing was specified for the unmapped property), these mapped objects hanging off of unmapped objects will be serialized freely and with all circular references, unless you include some calls to .IncludedSeparately(m => m.MyUnmappedProperty.MyMappedProperty) to limit those objects down.
The default value (i.e. no action) is the empty string.
There are a few values of includes that are either set by default in the auto-generated views, or otherwise have special meaning:
| Value | Description |
|---|---|
'none' | Setting includes to none suppresses the Default Loading Behavior provided by the Standard Data Source - The resulting data will be the requested object (or list of objects) and nothing more. |
'admin-list' | Used when loading a list of objects in the Vue admin list page. |
'admin-editor' | Used when loading an object in the Vue admin editor component. |
'Editor' | Used when loading an object in the generated Knockout CreateEdit views. |
'<ModelName>ListGen' | Used when loading a list of objects in the generated Knockout Table and Cards views. For example, PersonListGen |
Main document: [DtoIncludes] & [DtoExcludes].
There are two C# attributes, DtoIncludes and DtoExcludes, that can be used to annotate your data model in order to customize what data gets put into the DTOs and ultimately serialized to JSON and sent out to the client.
When the database entries are returned to the client they will be trimmed based on the requested includes string and the values in DtoExcludes and DtoIncludes.
DANGER
These attributes are not security attributes - consumers of your application's API can set the includes string to any value when making a request.
Do not use them to keep certain data private - use the Security Attributes family of attributes for that.
It is important to note that the value of the includes string will match against these attributes on any of your models that appears in the object graph being mapped to DTOs - it is not limited only to the model type of the root object.
Important
DtoIncludes does not ensure that specific data will be loaded from the database. It only permits what is already loaded into the current EF DbContext to be returned from the API. See Data Sources to learn how to control what data gets loaded from the database.
Server code:
public class Person
+{
+ // Don't include CreatedBy when editing - will be included for all other views
+ [DtoExcludes("Editor")]
+ public AppUser CreatedBy { get; set; }
+
+ // Only include the Person's Department when \`includes == "details"\` on the TypeScript ViewModel.
+ [DtoIncludes("details")]
+ public Department Department { get; set; }
+
+ // LastName will be included in all views
+ public string LastName { get; set; }
+}
+
+public class Department
+{
+ [DtoIncludes("details")]
+ public ICollection<Person> People { get; set; }
+}Client code:
`,15),g=s("div",{class:"language-ts"},[s("button",{title:"Copy Code",class:"copy"}),s("span",{class:"lang"},"ts"),s("pre",{class:"shiki dark-plus vp-code"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#C586C0"}},"import"),s("span",{style:{color:"#D4D4D4"}}," { "),s("span",{style:{color:"#9CDCFE"}},"PersonListViewModel"),s("span",{style:{color:"#D4D4D4"}}," } "),s("span",{style:{color:"#C586C0"}},"from"),s("span",{style:{color:"#CE9178"}}," '@/viewmodels.g'")]),e(` +`),s("span",{class:"line"}),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#569CD6"}},"const"),s("span",{style:{color:"#4FC1FF"}}," personList"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#569CD6"}},"new"),s("span",{style:{color:"#DCDCAA"}}," PersonListViewModel"),s("span",{style:{color:"#D4D4D4"}},"();")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#9CDCFE"}},"personList"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#9CDCFE"}},"$includes"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#CE9178"}},'"Editor"'),s("span",{style:{color:"#D4D4D4"}},";")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#C586C0"}},"await"),s("span",{style:{color:"#9CDCFE"}}," personList"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#DCDCAA"}},"$load"),s("span",{style:{color:"#D4D4D4"}},"();")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#6A9955"}},"// Objects in personList.$items will not contain CreatedBy nor Department objects.")]),e(` +`),s("span",{class:"line"}),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#569CD6"}},"const"),s("span",{style:{color:"#4FC1FF"}}," personList2"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#569CD6"}},"new"),s("span",{style:{color:"#DCDCAA"}}," PersonListViewModel"),s("span",{style:{color:"#D4D4D4"}},"();")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#9CDCFE"}},"personList2"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#9CDCFE"}},"$includes"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#CE9178"}},'"details"'),s("span",{style:{color:"#D4D4D4"}},";")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#C586C0"}},"await"),s("span",{style:{color:"#9CDCFE"}}," personList"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#DCDCAA"}},"$load"),s("span",{style:{color:"#D4D4D4"}},"();")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#6A9955"}},"// Objects in personList2.items will be allowed to contain both CreatedBy and Department objects. ")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#6A9955"}},"// Department will be allowed to include its other Person objects.")])])])],-1),E=s("div",{class:"language-ts"},[s("button",{title:"Copy Code",class:"copy"}),s("span",{class:"lang"},"ts"),s("pre",{class:"shiki dark-plus vp-code"},[s("code",null,[s("span",{class:"line"},[s("span",{style:{color:"#569CD6"}},"var"),s("span",{style:{color:"#9CDCFE"}}," personList"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#569CD6"}},"new"),s("span",{style:{color:"#9CDCFE"}}," ListViewModels"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#DCDCAA"}},"PersonList"),s("span",{style:{color:"#D4D4D4"}},"();")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#9CDCFE"}},"personList"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#9CDCFE"}},"includes"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#CE9178"}},'"Editor"'),s("span",{style:{color:"#D4D4D4"}},";")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#9CDCFE"}},"personList"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#DCDCAA"}},"load"),s("span",{style:{color:"#D4D4D4"}},"(() "),s("span",{style:{color:"#569CD6"}},"=>"),s("span",{style:{color:"#D4D4D4"}}," {")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#6A9955"}}," // objects in personList.items will not contain CreatedBy nor Department objects.")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#D4D4D4"}},"});")]),e(` +`),s("span",{class:"line"}),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#569CD6"}},"var"),s("span",{style:{color:"#9CDCFE"}}," personList2"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#569CD6"}},"new"),s("span",{style:{color:"#9CDCFE"}}," ListViewModels"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#DCDCAA"}},"PersonList"),s("span",{style:{color:"#D4D4D4"}},"();")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#9CDCFE"}},"personList2"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#9CDCFE"}},"includes"),s("span",{style:{color:"#D4D4D4"}}," = "),s("span",{style:{color:"#CE9178"}},'"details"'),s("span",{style:{color:"#D4D4D4"}},";")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#9CDCFE"}},"personList2"),s("span",{style:{color:"#D4D4D4"}},"."),s("span",{style:{color:"#DCDCAA"}},"load"),s("span",{style:{color:"#D4D4D4"}},"(() "),s("span",{style:{color:"#569CD6"}},"=>"),s("span",{style:{color:"#D4D4D4"}}," {")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#6A9955"}}," // objects in personList2.items will be allowed to contain both CreatedBy and Department objects. Department will be allowed to include its other Person objects.")]),e(` +`),s("span",{class:"line"},[s("span",{style:{color:"#D4D4D4"}},"});")])])])],-1),w=s("h3",{id:"properties",tabindex:"-1"},[e("Properties "),s("a",{class:"header-anchor",href:"#properties","aria-label":'Permalink to "Properties"'},"")],-1),_=t('A comma-delimited list of values of includes on which to operate.
For DtoIncludes, this will be the values of includes for which this property will be allowed to be serialized and sent to the client.
For DtoExcludes, this will be the values of includes for which this property will not be serialized and sent to the client.
Coalesce is a framework based on ASP.NET Core that makes rapidly building awesome websites much easier. A project that would take a 3 months to complete now takes 1 month. We built this because we got tired of writing all the boiler plate code that is necessary to make amazing sites.
It does this by allowing developers to focus on the creative aspects of the solution. The more mundane parts are generated automatically. This means that you get to focus on data modeling, business logic and front-end development. Coalesce does the plumbing.
Here is a typical workflow
Coalesce was designed to create line-of-business applications. It provides a more customizable and maintainable alternative to off the shelf customizable products like SharePoint and Sales Force.
You should consider using Coalesce if your project:
Coalesce is specifically designed to meet the needs of web developers. However, there are lots of ways to do this. We have made a set of decisions which we believe makes for a great development experience
After you create your classes and the EF data context, Coalesce uses this information to generate code. When the Coalesce CLI (command line interface) is run, the following things happen:
Here are a few things we have found helpful when using Coalesce
In 2014 several developers from IntelliTect got together to talk about our craft. There were lots of different backgrounds, but recently we had all been writing web code in C#. We discussed things we enjoyed and things we dreaded. There was an underlying commitment to providing customers with great sites at a reasonable cost. However, those things often seemed at odds because of the complexity of web development.
For example, writing AJAX drop down lists with type ahead takes quite a bit of plumbing. Layer onto this the need for view models that allow for validation and saving as the user moves from field to field. We absolutely want want to deliver visually pleasing sites with complex UI paradigms. However, all this excellence adds up: complex view models, complex APIs, data binding, ugh.
Then there is that sinking feeling when you have to add another class to the project knowing that you are going to need to create all this yet again and you consider taking short cuts. Will there really be more than about 20 items in this table, maybe we don't need paging. Inevitably, the customer asks for admin screens. We consider giving them SQL Server Management Console and then consider using the built in ASP.NET list and editor pages. Better sense wins out and we end up spending two weeks building slick admin pages with paging, searching, sorting, etc.
That evening we starting talking about the things we loved to do:
We also lists things that we didn't enjoy
Over the next few months we talked about this issue, but couldn't find the right abstraction. We talked about other solutions that solve parts of the problem and considered putting together something from several pieces. Nothing felt unified and we ended up with leaky abstractions. We needed some way to divide the problem so that we could build the fun stuff and have something generate the boring stuff. This solution needed to be robust enough to satisfy our customer's needs and also be of use to developers without their needing to know the inner workings of the system.
What if we could build the models and business logic and have a tool build everything except the UI? There are great tools like Entity Framework for modeling and good tooling for minimizing duplicate code in user interfaces. And so Coalesce was born, a tool that would bring together the backend and front end development. '
Coalesce takes Entity Framework Core models and builds controllers, TypeScript view models, and admin pages automatically. These are built in a general way so that they can be applied to many different scenarios. There will always be pages that need to be written by hand and we intentionally don't support many edge cases in order to keep things simple. There is nothing wrong with building something by hand.
We have been using Coalesce for many of our web projects with great success. Typically, a project is taking about 1/3 the time it was taking before once developers ramp up. The ramp up on Coalesce has typically been a couple of days. We realized that in order for Coalesce to be useful it need to be intuitive to use and easy to understand. We have intentionally used simple paradigms to minimize the learning curve. There are complex bits, but hopefully, those are well hidden and documented as needed.
',37),n=[s];function l(r,d,h,c,u,m){return t(),a("div",null,n)}const f=e(o,[["render",l]]);export{g as __pageData,f as default}; diff --git a/assets/history.md.ux281dRc.lean.js b/assets/history.md.ux281dRc.lean.js new file mode 100644 index 000000000..6f20c4880 --- /dev/null +++ b/assets/history.md.ux281dRc.lean.js @@ -0,0 +1 @@ +import{_ as e,o as t,c as a,R as i}from"./chunks/framework.g9eZ-ZSs.js";const g=JSON.parse(`{"title":"Welcome to Coalesce's documentation!","description":"","frontmatter":{},"headers":[],"relativePath":"history.md","filePath":"history.md"}`),o={name:"history.md"},s=i("",37),n=[s];function l(r,d,h,c,u,m){return t(),a("div",null,n)}const f=e(o,[["render",l]]);export{g as __pageData,f as default}; diff --git a/assets/index.md.J5qzQ5SM.js b/assets/index.md.J5qzQ5SM.js new file mode 100644 index 000000000..a34f8d03a --- /dev/null +++ b/assets/index.md.J5qzQ5SM.js @@ -0,0 +1 @@ +import{_ as t,D as o,o as a,c as r,I as n}from"./chunks/framework.g9eZ-ZSs.js";const _=JSON.parse(`{"title":"","description":"","frontmatter":{"layout":"home","hero":{"name":"Coalesce","text":"Accelerated Web App Development","tagline":"ASP.NET Core • EF Core • Vue.js • TypeScript","image":{"src":"/coalesce-icon-color.svg","alt":"Coalesce"},"actions":[{"theme":"brand","text":"Introduction","link":"/introduction"},{"theme":"alt","text":"Get Started","link":"/stacks/vue/getting-started"}]},"features":[{"title":"🖨 Code Generated","details":"Design your data model and build awesome pages. Coalesce generates the boring parts in the middle."},{"title":"🧩 Extensible","details":"All functionality in Coalesce is configurable or overridable. You'll never be boxed in or get stuck."},{"title":"🔒 Secure","details":"Customization of table-level, row-level, and property-level security are all built-in. Read More."}]},"headers":[],"relativePath":"index.md","filePath":"index.md"}`),i={name:"index.md"};function l(s,c,d,p,m,u){const e=o("SiteFooter");return a(),r("div",null,[n(e)])}const g=t(i,[["render",l]]);export{_ as __pageData,g as default}; diff --git a/assets/index.md.J5qzQ5SM.lean.js b/assets/index.md.J5qzQ5SM.lean.js new file mode 100644 index 000000000..a34f8d03a --- /dev/null +++ b/assets/index.md.J5qzQ5SM.lean.js @@ -0,0 +1 @@ +import{_ as t,D as o,o as a,c as r,I as n}from"./chunks/framework.g9eZ-ZSs.js";const _=JSON.parse(`{"title":"","description":"","frontmatter":{"layout":"home","hero":{"name":"Coalesce","text":"Accelerated Web App Development","tagline":"ASP.NET Core • EF Core • Vue.js • TypeScript","image":{"src":"/coalesce-icon-color.svg","alt":"Coalesce"},"actions":[{"theme":"brand","text":"Introduction","link":"/introduction"},{"theme":"alt","text":"Get Started","link":"/stacks/vue/getting-started"}]},"features":[{"title":"🖨 Code Generated","details":"Design your data model and build awesome pages. Coalesce generates the boring parts in the middle."},{"title":"🧩 Extensible","details":"All functionality in Coalesce is configurable or overridable. You'll never be boxed in or get stuck."},{"title":"🔒 Secure","details":"Customization of table-level, row-level, and property-level security are all built-in. Read More."}]},"headers":[],"relativePath":"index.md","filePath":"index.md"}`),i={name:"index.md"};function l(s,c,d,p,m,u){const e=o("SiteFooter");return a(),r("div",null,[n(e)])}const g=t(i,[["render",l]]);export{_ as __pageData,g as default}; diff --git a/assets/inter-italic-cyrillic-ext.OVycGSDq.woff2 b/assets/inter-italic-cyrillic-ext.OVycGSDq.woff2 new file mode 100644 index 0000000000000000000000000000000000000000..2a687296748f6b8bc8076cd11bde49cd27e4442b GIT binary patch literal 28332 zcmV(^K-Ir@Pew8T0RR910B)=R5dZ)H0L(-H0B%750|eaw00000000000000000000 z0000QgDD%9791)+NLE2ohdBmdKT}jeRDl`*gBUMt3W0+R>k}}6+I9gp0we>63JZfs z00bZfg$M^A8&tgo+lIZ{0W$kf`dwxsbvsBZKijgA2%9xXMMwW9BpqW2)F+!l*M37V zl9T{JHdk?)M!T60nkxGasf@PS$3btkm4;ibH5~*Z*uTsmJGUKxX9cyg+F)d-5ys4C zo7|FZ`ph?caYdg&{|^%(5eV_PgnKGlxbGk&;@QKi9rFvf2ykadkugvB=bv=iyMMk$ zBY7+a5GAr4D>kv^F3Pf`OSoyhikEeWmv~9(oDIp6)-@vO+gl-}bh(56@L;!pH{2TT zIOp!%>5R+DSWy{w>@s%z%*