@homedev/objector 0.0.11 → 0.0.12

package/dist/index.js

@@ -1 +1 @@
-import b from"path";import J from"fs/promises";import B from"path";import z from"yaml";var _=async(O)=>{try{return await J.access(O,J.constants.R_OK),!0}catch{return!1}},G=async(O,T)=>{let F=await(async()=>{let D=[""];if(!B.isAbsolute(O)&&T?.dirs)D.push(...T.dirs);for(let I of D){let q=B.join(I,O);if(await _(q))return B.resolve(q)}throw new Error(`File not found: "${O}"`)})(),P=await J.readFile(F),j=B.dirname(F),E={"[.](yml|yaml)$":z.parse,"[.]json$":JSON.parse,...T?.parsers},M=Object.entries(E).find((D)=>F.match(D[0]));if(!M)throw new Error(`Unhandled file type: ${O}`);return{content:M[1](P.toString()),fullPath:F,folderPath:j}};var k=async(O,T)=>{for(let C of O){let F=T?.root?b.join(T.root,C):C,P=await G(F,T?.loadOptions);if(T?.loaded)await T.loaded(P)}};var f=(O,T,C)=>{for(let F of Object.keys(T)){if(O[F]===void 0)continue;let P=T[F],j=O[F];if(typeof j!==typeof P||Array.isArray(j)!==Array.isArray(P)){let M=C?.mismatch?.(F,j,P,O,T);if(M!==void 0){T[F]=M;continue}throw new Error(`Type mismatch: ${F}`)}let E=C?.mode?.(F,j,P,O,T)??"merge";switch(E){case"source":T[F]=j;continue;case"target":continue;case"skip":delete T[F],delete O[F];continue;case"merge":break;default:throw new Error(`Unknown merge mode: ${E}`)}if(typeof j==="object")if(Array.isArray(j))P.push(...j);else{if(C?.navigate?.(F,j,P,O,T)===!1)continue;f(j,P,C)}else{if(j===P)continue;let M=C?.conflict?.(F,j,P,O,T);T[F]=M===void 0?P:M}}for(let F of Object.keys(O))if(T[F]===void 0)T[F]=O[F]};var K;((j)=>{j[j.Continue=0]="Continue";j[j.Skip=1]="Skip";j[j.ReplaceItem=2]="ReplaceItem";j[j.ReplaceParent=3]="ReplaceParent";j[j.DeleteParent=4]="DeleteParent"})(K||={});class w{action;by;constructor(O,T){this.action=O;this.by=T}static ReplaceParent(O){return new w(3,O)}static ReplaceItem(O){return new w(2,O)}static Skip(){return new w(1)}static Continue(){return new w(0)}static DeleteParent(){return new w(4)}}var H=async(O,T)=>{let C=async(P)=>{for(let[j,E]of Object.entries(P.value)){let M=await F({key:j,value:E,path:P.path,parent:P.value});switch(M.action){case 3:if(!P.key)throw new Error("Cannot replace root");P.parent[P.key]=M.by;return;case 2:P.value[j]=M.by;break;case 1:return;case 4:delete P.parent[P.key];return}}},F=async(P)=>{let j=P.key?await T(P):{action:0};if(j.action===0){if(P.value&&typeof P.value==="object"){if(P.key)P.path.push(P.key);if(await C(P),P.key)P.path.pop()}}return j};await F({key:null,value:O,path:[],parent:null})};var S=async(O,T,C,F)=>{for(let[P,j]of F?.keys??[]){let E=P.exec(O.key);if(E){let[,M,...W]=E;if(j[M]){let D={args:[O.value,...W],path:T,value:O.value,root:C,parent:O.parent,key:O.key,origin:F?.origin,options:F},I=typeof j[M]==="function"?await j[M](D):j[M];if(I===null)return w.DeleteParent();if(I===void 0)return w.Continue();return w.ReplaceParent(I)}}}};var U=async(O,T,C,F)=>{let P,j=[],E=T;for(let[M,W]of F?.sources??[]){if(P)break;E=E.replaceAll(M,(D,I,...q)=>{if(P)return D;let $=W[I];if(typeof $!=="object"&&typeof $!=="function")return $??D;if(typeof $==="object")return P=$,D;let d=$({args:q,path:O,value:E,root:C,key:I,options:F});if(typeof d==="object")return P=d,D;return d instanceof Promise?`ð[${j.push(d)}]ñ`:d})}if(P){let M=await P;if(M===null)return w.DeleteParent();if(M)return w.ReplaceItem(M)}if(j.length){let M=await Promise.all(j);E=E.replaceAll(/\xf0\[(\d+)]\xf1/g,(W,D)=>M[+D-1])}return E===T?w.Continue():w.ReplaceItem(E)};var e=async(O,T)=>H(O,async(C)=>{let F=[...C.path,C.key].join(".");if(T?.filters){if(!T.filters.some((P)=>P.test(F)))return w.Continue()}return await S(C,F,O,T)??(typeof C.value==="string"?await U(F,C.value,O,T):w.Continue())});import L from"yaml";var X=(O,T="name")=>Object.entries(O).map(([C,F])=>({[T]:C,...F})),FF=(O,T="name")=>Object.fromEntries(O.map((C)=>[C[T],C])),Z=(O,T="name")=>Object.fromEntries(O.map((C)=>{let{[T]:F,...P}=C;return[F,P]}));var Y=(O,T)=>{let C=/^\[([^=\]]*)([=]*)([^\]]*)\]$/.exec(T);if(C){let[P,j,E,M]=C;if(Array.isArray(O))switch(E){case"==":case"=":return O.find((W)=>W[j.trim()]==M.trim())}}let F=/^([^[\]]*)\[([^\]]*)]/.exec(T);if(F)return O[F[1]][F[2]];return O[T]},Q=(O,T,C)=>{let F=void 0,P=void 0;T??="";let j=(M,W)=>{let D=W.pop();if(D){let I=Y(M,D);if(!I)throw new Error(`Unknown path element: "${D}" in "${T}"`);return F=M,P=D,j(I,W)}if(C?.set&&P)F[P]=C?.set;return M},E=j(O,T.split(C?.separator??".").reverse());switch(C?.format){case"list":return X(E,C?.key);case"object":return Z(E,C?.key);case"json":return JSON.stringify(E);case"yaml":return L.stringify(E);default:return E}},CF=(O,T)=>{let C=/^(?<path>[^@>]*)?(?:@(?<from>[^>]*))?(?:>(?<format>[^|]*)(?:\|(?<key>.*))?)?$/.exec(O)?.groups;if(!C)throw new Error(`Invalid reference: "${O}"`);let{from:F,path:P,format:j,key:E}=C;if(!F)return Q(T.root,P,{format:j,key:E});if(T.async===!1){if(!T.load)throw new Error("No load function defined");return Q(T.load(F),P,{format:j,key:E})}else return(T.load??G)(F).then((M)=>Q(M,P,{format:j,key:E}))};var wF=async(O,T)=>{let C=[];return await H(O,(F)=>{if(T([...F.path,F.key].join("."),F.value))C.push(F.value);return w.Continue()}),C};export{FF as toObjectWithKey,Z as toObject,X as toList,Q as selectPath,CF as select,k as processIncludes,e as processFields,H as navigate,f as merge,G as load,wF as find,w as NavigateResult,K as NavigateAction};
+import f from"path";import w from"fs/promises";import Z from"path";import v from"yaml";var g=async(T)=>{try{return await w.access(T,w.constants.R_OK),!0}catch{return!1}},J=async(T,F)=>{let j=await(async()=>{let I=[""];if(!Z.isAbsolute(T)&&F?.dirs)I.push(...F.dirs);for(let q of I){let X=Z.join(q,T);if(await g(X))return Z.resolve(X)}throw new Error(`File not found: "${T}"`)})(),O=await w.readFile(j),M=Z.dirname(j),E={"[.](yml|yaml)$":v.parse,"[.]json$":JSON.parse,...F?.parsers},P=Object.entries(E).find((I)=>j.match(I[0]));if(!P)throw new Error(`Unhandled file type: ${T}`);return{content:P[1](O.toString()),fullPath:j,folderPath:M}};var Y=async(T,F)=>{for(let C of T){let j=F?.root?f.join(F.root,C):C,O=await J(j,F?.loadOptions);if(F?.loaded)await F.loaded(O)}};var S=(T,F,C)=>{for(let j of Object.keys(F)){if(T[j]===void 0)continue;let O=F[j],M=T[j];if(typeof M!==typeof O||Array.isArray(M)!==Array.isArray(O)){let P=C?.mismatch?.(j,M,O,T,F);if(P!==void 0){F[j]=P;continue}throw new Error(`Type mismatch: ${j}`)}let E=C?.mode?.(j,M,O,T,F)??"merge";switch(E){case"source":F[j]=M;continue;case"target":continue;case"skip":delete F[j],delete T[j];continue;case"merge":break;default:throw new Error(`Unknown merge mode: ${E}`)}if(typeof M==="object")if(Array.isArray(M))O.push(...M);else{if(C?.navigate?.(j,M,O,T,F)===!1)continue;S(M,O,C)}else{if(M===O)continue;let P=C?.conflict?.(j,M,O,T,F);F[j]=P===void 0?O:P}}for(let j of Object.keys(T))if(F[j]===void 0)F[j]=T[j]};var b;((M)=>{M[M.Continue=0]="Continue";M[M.Skip=1]="Skip";M[M.ReplaceItem=2]="ReplaceItem";M[M.ReplaceParent=3]="ReplaceParent";M[M.DeleteParent=4]="DeleteParent"})(b||={});class W{action;by;constructor(T,F){this.action=T;this.by=F}static ReplaceParent(T){return new W(3,T)}static ReplaceItem(T){return new W(2,T)}static Skip(){return new W(1)}static Continue(){return new W(0)}static DeleteParent(){return new W(4)}}var _=async(T,F)=>{let C=async(O)=>{for(let[M,E]of Object.entries(O.value)){let P=await j({key:M,value:E,path:O.path,parent:O.value});switch(P.action){case 3:if(!O.key)throw new Error("Cannot replace root");O.parent[O.key]=P.by;return;case 2:O.value[M]=P.by;break;case 1:return;case 4:delete O.parent[O.key];return}}},j=async(O)=>{let M=O.key?await F(O):{action:0};if(M.action===0){if(O.value&&typeof O.value==="object"){if(O.key)O.path.push(O.key);if(await C(O),O.key)O.path.pop()}}return M};await j({key:null,value:T,path:[],parent:null})};var z=async(T,F,C,j)=>{for(let[O,M]of j?.keys??[]){let E=O.exec(T.key);if(E){let[,P,...$]=E;if(M[P]){let I={args:[T.value,...$],path:F,value:T.value,root:C,parent:T.parent,key:T.key,origin:j?.origin,options:j},q=typeof M[P]==="function"?await M[P](I):M[P];if(q===null)return W.DeleteParent();if(q===void 0)return W.Continue();return W.ReplaceParent(q)}}}};var K=async(T,F,C,j)=>{let O,M=[],E=F;for(let[P,$]of j?.sources??[]){if(O)break;E=E.replaceAll(P,(I,q,...X)=>{if(O)return I;let H=$[q];if(typeof H!=="object"&&typeof H!=="function")return H??I;if(typeof H==="object")return O=H,I;let Q=H({args:X,path:T,value:E,root:C,key:q,options:j});if(typeof Q==="object")return O=Q,I;return Q instanceof Promise?`ð[${M.push(Q)}]ñ`:Q})}if(O){let P=await O;if(P===null)return W.DeleteParent();if(P)return W.ReplaceItem(P)}if(M.length){let P=await Promise.all(M);E=E.replaceAll(/\xf0\[(\d+)]\xf1/g,($,I)=>P[+I-1])}return E===F?W.Continue():W.ReplaceItem(E)};var D=async(T,F)=>_(T,async(C)=>{let j=[...C.path,C.key].join(".");if(F?.filters){if(!F.filters.some((M)=>M.test(j)))return W.Continue()}let O=async(M)=>{let E=await K(j,M,T,F);if(E.action===2&&typeof E.by==="string"){let P=await O(E.by);if(P.by)return P}return E};return await z(C,j,T,F)??(typeof C.value==="string"?await O(C.value):W.Continue())});import h from"yaml";var R=(T,F="name")=>Object.entries(T).map(([C,j])=>({[F]:C,...j})),$F=(T,F="name")=>Object.fromEntries(T.map((C)=>[C[F],C])),A=(T,F="name")=>Object.fromEntries(T.map((C)=>{let{[F]:j,...O}=C;return[j,O]}));var V=(T,F,C="(",j=")")=>{let O=0,M="",E=[];for(let P of T){if(M+=P,P===C)O++;if(P===j)O--;if(O===0&&P===F)E.push(M.slice(0,-1)),M=""}if(M)E.push(M);return E};var d=(T,F,C,j)=>{if(F.startsWith("{")){let E=F.substring(1,F.length-1),P=B(C,E,j);return B(T,P,j)}let O=/^\[([^=\]]*)([=]*)([^\]]*)\]$/.exec(F);if(O){let[E,P,$,I]=O;if(Array.isArray(T))switch($){case"==":case"=":return T.find((q)=>q[P.trim()]==I.trim())}}let M=/^([^[\]]*)\[([^\]]*)]/.exec(F);if(M)return T[M[1]][M[2]];return T[F]},B=(T,F,C)=>{let j=void 0,O=void 0;F??="";let M=(P,$)=>{let I=$.pop();if(I){let q=d(P,I,T,C);if(!q)throw new Error(`Unknown path element: "${I}" in "${F}"`);return j=P,O=I,M(q,$)}if(C?.set&&O)j[O]=C?.set;return P},E=M(T,V(F,C?.separator??".","{","}").reverse());switch(C?.format){case"list":return R(E,C?.key);case"object":return A(E,C?.key);case"json":return JSON.stringify(E);case"yaml":return h.stringify(E);default:return E}},G=(T,F)=>{let C=/^(?<path>[^@>]*)?(?:@(?<from>[^>]*))?(?:>(?<format>[^|]*)(?:\|(?<key>.*))?)?$/.exec(T)?.groups;if(!C)throw new Error(`Invalid reference: "${T}"`);let{from:j,path:O,format:M,key:E}=C;if(!j)return B(F.root,O,{format:M,key:E});if(F.async===!1){if(!F.load)throw new Error("No load function defined");return B(F.load(j),O,{format:M,key:E})}else return(F.load??J)(j).then((P)=>B(P,O,{format:M,key:E}))};var ZF=async(T,F)=>{let C=[];return await _(T,(j)=>{if(F([...j.path,j.key].join("."),j.value))C.push(j.value);return W.Continue()}),C};import L from"fs/promises";import N from"path";import p from"yaml";import m from"fs/promises";import U from"path";var y=(T)=>{return{include:(F)=>T.load(F.args[0]),file:(F)=>m.readFile(F.args[0]).then((C)=>C.toString()),from:(F)=>G(F.args[0],{root:F.root,load:(C)=>T.load(C)}),env:(F)=>process.env[F.args[0]],ref:(F)=>G(F.args[0],{root:F.root,load:(C)=>T.getAlias(C),async:!1})}},k=(T)=>{return{include:(F)=>T.load(F.value,void 0,F.origin&&U.dirname(F.origin)),from:async(F)=>{let C=await G(F.value,{root:F.root,load:(j)=>T.load(j,void 0,F.origin&&U.dirname(F.origin))});if(F.parent.content){if(Array.isArray(F.parent.content)&&Array.isArray(C))return[...C,...F.parent.content];return T.merge(C,F.parent.content),F.parent.content}return C},concat:async(F)=>{let C=[];for(let j of Array.isArray(F.value)?F.value:[F.value])C.push(...await G(j,{root:F.root,load:(O)=>T.load(O,void 0,F.origin&&U.dirname(F.origin))}));return C.filter((j)=>j!==void 0)},extends:async(F)=>{for(let C of Array.isArray(F.value)?F.value:[F.value])T.merge(await G(C,{root:F.root,load:(j)=>T.load(j,void 0,F.origin&&U.dirname(F.origin))}),F.parent);delete F.parent[F.key]},alias:(F)=>{T.alias(F.value,F.parent),delete F.parent[F.key]},if:(F)=>{if(!F.value)return null;delete F.parent[F.key]},output:(F)=>{delete F.parent[F.key];for(let C of Array.isArray(F.value)?F.value:[F.value])T.output(C,F.parent)},each:async(F)=>{delete F.parent[F.key];let C=Array.isArray(F.value)?F.value:await G(F.value,{root:F.root,load:(O)=>T.load(O,void 0,F.origin&&U.dirname(F.origin))}),j=[];if(!Array.isArray(C))throw new Error("source must be a list");for(let O=0;O<C.length;O++){let M=C[O],E=[[/^\.(.*)/,{item:(I)=>B(M,I.value)}]],P=[[/\$\((\w*)(?::([^)]*))?\)/g,{index:O,item:(I)=>B(M,I.args[0])}]];F.options?.keys&&E.push(...F.options.keys),F.options?.sources&&P.push(...F.options.sources);let $={...F.parent};await D($,{...F.options,sources:P,keys:E}),j.push($)}return j}}};class r{options={load:{dirs:[]},merge:{},include:{},fields:{},includeKey:"includes",mergeKey:".merge"};cache={};includeDirectory(...T){return this.options.load.dirs??=[],this.options.load.dirs.push(...T),this}updateOrCreate(T,F,C){this.options.fields[F]??=[];let j=this.options.fields[F],O=j.find((M)=>M[0].source===T.source);if(!O)j.push([T,C]);else O[1]={...O[1],...C};return this}keys(T,F){return this.updateOrCreate(F??/^\.(.*)/,"keys",T)}sources(T,F){return this.updateOrCreate(F??/\$\(([^:)]*)(?::([^)]*))?\)/g,"sources",T)}output(T,F){return this.options.outputs??={},this.options.outputs[T]=F,this}defaultSources(T){return this.sources(y(this),T)}defaultKeys(T){return this.keys(k(this),T)}defaultProcessors(){return this.defaultKeys().defaultSources()}alias(T,F){return this.cache[T]=F,this}getAlias(T){return this.cache[T]}getOutputs(){return this.options.outputs??{}}async load(T,F,C){if(this.cache[T])return this.cache[T];let j=C?[C]:[];this.options.load.dirs&&j.push(...this.options.load.dirs);let O=await J(T,{...this.options.load,dirs:j});if(!O.content)return null;if(F)this.cache[F]=O.content;if(this.options.includeKey&&O.content[this.options.includeKey])await Y(O.content[this.options.includeKey],{root:O.folderPath,loaded:(M)=>{if(this.options.mergeKey){if(M.content)S(M.content,O.content,{mode:(E,P,$)=>$[this.options.mergeKey],...this.options.merge})}},loadOptions:this.options.load,...this.options.include}),delete O.content[this.options.includeKey];return await D(O.content,{...this.options.fields,origin:O.fullPath}),O.content}merge(T,F){S(T,F,{mode:(C,j,O)=>O[this.options.mergeKey],...this.options.merge})}async writeOutputs(T){for(let[F,C]of Object.entries(this.getOutputs())){let j=N.join(T??".",F);try{switch(N.extname(F)){case".yml":case".yaml":await L.writeFile(j,p.stringify(C));break;case".json":await L.writeFile(j,JSON.stringify(C));break;default:await L.writeFile(j,C)}}catch{throw new Error(`Failed to write output: ${j}`)}}}}export{$F as toObjectWithKey,A as toObject,R as toList,B as selectPath,G as select,Y as processIncludes,D as processFields,_ as navigate,S as merge,J as load,ZF as find,r as Objector,W as NavigateResult,b as NavigateAction};

package/dist/objector.d.ts

@@ -118,7 +118,7 @@ export declare interface NavigateContext {
  */
 export declare class NavigateResult {
     readonly action: NavigateAction;
-    readonly by?: any | undefined;
+    by?: any | undefined;
     constructor(action: NavigateAction, by?: any | undefined);
     static ReplaceParent(by: any): NavigateResult;
     static ReplaceItem(by: any): NavigateResult;
@@ -127,6 +127,27 @@ export declare class NavigateResult {
     static DeleteParent(): NavigateResult;
 }
 
+/**
+ * @public
+ */
+export declare class Objector {
+    private cache;
+    includeDirectory(...dirs: string[]): this;
+    private updateOrCreate;
+    keys(keys: FieldProcessorMap, matcher?: RegExp): this;
+    sources(sources: FieldProcessorMap, matcher?: RegExp): this;
+    output(name: string, value: any): this;
+    defaultSources(matcher?: RegExp): this;
+    defaultKeys(matcher?: RegExp): this;
+    defaultProcessors(): this;
+    alias(name: string, o: any): this;
+    getAlias(name: string): any;
+    getOutputs(): Record<string, any>;
+    load<T = any>(fileName: string, alias?: string, cwd?: string): Promise<T | null>;
+    merge(source: any, target: any): void;
+    writeOutputs(targetDirectory?: string): Promise<void>;
+}
+
 /**
  * @public
  * @param root

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@homedev/objector",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "object extensions for YAML/JSON",
   "author": "julzor",
   "license": "ISC",