@homedev/objector 0.0.10 → 0.0.12

package/dist/index.js

@@ -1 +1 @@
-import K from"path";import B from"fs/promises";import I from"path";import z from"yaml";var b=async(C)=>{try{return await B.access(C,B.constants.R_OK),!0}catch{return!1}},W=async(C,F)=>{let d=await(async()=>{let j=[""];if(!I.isAbsolute(C)&&F?.dirs)j.push(...F.dirs);for(let D of j){let H=I.join(D,C);if(await b(H))return I.resolve(H)}throw new Error(`File not found: "${C}"`)})(),P=await B.readFile(d),O=I.dirname(d),U={"[.](yml|yaml)$":z.parse,"[.]json$":JSON.parse,...F?.parsers},M=Object.entries(U).find((j)=>d.match(j[0]));if(!M)throw new Error(`Unhandled file type: ${C}`);return{content:M[1](P.toString()),fullPath:d,folderPath:O}};var v=async(C,F)=>{for(let T of C){let d=F?.root?K.join(F.root,T):T,P=await W(d,F?.loadOptions);if(F?.loaded)await F.loaded(P)}};var L=(C,F,T)=>{for(let d of Object.keys(F)){if(C[d]===void 0)continue;let P=F[d],O=C[d];if(typeof O!==typeof P||Array.isArray(O)!==Array.isArray(P)){let M=T?.mismatch?.(d,O,P,C,F);if(M!==void 0){F[d]=M;continue}throw new Error(`Type mismatch: ${d}`)}let U=T?.mode?.(d,O,P,C,F)??"merge";switch(U){case"source":F[d]=O;continue;case"target":continue;case"skip":delete F[d],delete C[d];continue;case"merge":break;default:throw new Error(`Unknown merge mode: ${U}`)}if(typeof O==="object")if(Array.isArray(O))P.push(...O);else{if(T?.navigate?.(d,O,P,C,F)===!1)continue;L(O,P,T)}else{if(O===P)continue;let M=T?.conflict?.(d,O,P,C,F);F[d]=M===void 0?P:M}}for(let d of Object.keys(C))if(F[d]===void 0)F[d]=C[d]};var Y;((O)=>{O[O.Continue=0]="Continue";O[O.Skip=1]="Skip";O[O.ReplaceItem=2]="ReplaceItem";O[O.ReplaceParent=3]="ReplaceParent";O[O.DeleteParent=4]="DeleteParent"})(Y||={});class E{action;by;constructor(C,F){this.action=C;this.by=F}static ReplaceParent(C){return new E(3,C)}static ReplaceItem(C){return new E(2,C)}static Skip(){return new E(1)}static Continue(){return new E(0)}static DeleteParent(){return new E(4)}}var q=async(C,F)=>{let T=async(P)=>{for(let[O,U]of Object.entries(P.value)){let M=await d({key:O,value:U,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[O]=M.by;break;case 1:return;case 4:delete P.parent[P.key];return}}},d=async(P)=>{let O=P.key?await F(P):{action:0};if(O.action===0){if(P.value&&typeof P.value==="object"){if(P.key)P.path.push(P.key);if(await T(P),P.key)P.path.pop()}}return O};await d({key:null,value:C,path:[],parent:null})};var J=async(C,F,T,d,P)=>{for(let O of P?.functions??[]){let U=O[0].exec(T.value);if(U){let[,M,...w]=U;if(O[1][M])return E.ReplaceItem(await O[1][M]({args:w,path:F,value:C.value,root:d,key:M,options:P}))}}};var Q=async(C,F,T,d)=>{for(let P of d?.keys??[]){let O=P[0].exec(C.key);if(O){let[,U,...M]=O;if(P[1][U]){let w={args:M,path:F,value:C.value,root:T,parent:C.parent,key:C.key,origin:d?.origin,options:d},j=await P[1][U](w);if(j===null)return E.DeleteParent();if(j===void 0)return E.Continue();return E.ReplaceParent(j)}}}};var S=(C,F,T,d)=>{for(let P of d?.sources??[])F.value=F.value.replaceAll(P[0],(O,U,...M)=>P[1][U]?.({args:M,path:C,value:F.value,root:T,key:U,options:d})??O)};var X=(C,F)=>{for(let[T,d]of F?.variables??[])C.value=C.value.replaceAll(T,(P,O)=>d[O]??P)};var PF=async(C,F)=>q(C,async(T)=>{let d=[...T.path,T.key].join(".");if(F?.filters){if(!F.filters.some((O)=>O.test(d)))return E.Continue()}let P=await Q(T,d,C,F);if(P)return P;if(typeof T.value==="string"){let O={value:T.value};return S(d,O,C,F),X(O,F),await J(T,d,O,C,F)??(T.value!==O.value?E.ReplaceItem(O.value):E.Continue())}return E.Continue()});import _ from"yaml";var Z=(C,F="name")=>Object.entries(C).map(([T,d])=>({[F]:T,...d})),TF=(C,F="name")=>Object.fromEntries(C.map((T)=>[T[F],T])),$=(C,F="name")=>Object.fromEntries(C.map((T)=>{let{[F]:d,...P}=T;return[d,P]}));var r=(C,F)=>{let T=/^\[([^=\]]*)([=]*)([^\]]*)\]$/.exec(F);if(T){let[P,O,U,M]=T;if(Array.isArray(C))switch(U){case"==":case"=":return C.find((w)=>w[O.trim()]==M.trim())}}let d=/^([^[\]]*)\[([^\]]*)]/.exec(F);if(d)return C[d[1]][d[2]];return C[F]},G=(C,F,T)=>{let d=void 0,P=void 0;F??="";let O=(M,w)=>{let j=w.pop();if(j){let D=r(M,j);if(!D)throw new Error(`Unknown path element: "${j}" in "${F}"`);return d=M,P=j,O(D,w)}if(T?.set&&P)d[P]=T?.set;return M},U=O(C,F.split(T?.separator??".").reverse());switch(T?.format){case"list":return Z(U,T?.key);case"object":return $(U,T?.key);case"json":return JSON.stringify(U);case"yaml":return _.stringify(U);default:return U}},wF=(C,F)=>{let T=/^(?<path>[^@>]*)?(?:@(?<from>[^>]*))?(?:>(?<format>[^|]*)(?:\|(?<key>.*))?)?$/.exec(C)?.groups;if(!T)throw new Error(`Invalid reference: "${C}"`);let{from:d,path:P,format:O,key:U}=T;if(!d)return G(F.root,P,{format:O,key:U});if(F.async===!1){if(!F.load)throw new Error("No load function defined");return G(F.load(d),P,{format:O,key:U})}else return(F.load??W)(d).then((M)=>G(M,P,{format:O,key:U}))};var WF=async(C,F)=>{let T=[];return await q(C,(d)=>{if(F([...d.path,d.key].join("."),d.value))T.push(d.value);return E.Continue()}),T};export{TF as toObjectWithKey,$ as toObject,Z as toList,G as selectPath,wF as select,v as processIncludes,PF as processFields,q as navigate,L as merge,W as load,WF as find,E as NavigateResult,Y 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

@@ -18,16 +18,10 @@ export declare interface FieldContext {
     options?: ProcessFieldsOptions;
 }
 
-export declare type FieldProcessorAsyncMap = Record<string, (context: FieldContext) => MaybePromise<any>>;
-
-export declare type FieldProcessorMap = Record<string, (context: FieldContext) => any>;
+export declare type FieldProcessorMap = Record<string, ((context: FieldContext) => MaybePromise<any>) | string | number | object | boolean>;
 
 export declare type FieldProcessorMatcher = [matcher: RegExp, handlers: FieldProcessorMap];
 
-export declare type FieldProcessorMatcherAsync = [matcher: RegExp, handlers: FieldProcessorAsyncMap];
-
-export declare type FieldVariableMatcher = [matcher: RegExp, variables: Record<string, any>];
-
 /**
  * @public
  * @param from
@@ -124,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;
@@ -133,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
@@ -143,9 +158,7 @@ export declare const processFields: (root: any, options?: ProcessFieldsOptions)
 
 export declare interface ProcessFieldsOptions {
     sources?: FieldProcessorMatcher[];
-    functions?: FieldProcessorMatcherAsync[];
-    keys?: FieldProcessorMatcherAsync[];
-    variables?: FieldVariableMatcher[];
+    keys?: FieldProcessorMatcher[];
     filters?: RegExp[];
     origin?: string;
 }

package/package.json

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