@homedev/objector 0.0.6 → 0.0.8

package/dist/index.js

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

package/dist/objector.d.ts

@@ -14,6 +14,7 @@ export declare interface FieldContext {
     root: any;
     parent?: any;
     key: string;
+    origin?: string;
 }
 
 export declare type FieldProcessorAsyncMap = Record<string, (context: FieldContext) => MaybePromise<any>>;
@@ -98,7 +99,8 @@ export declare enum NavigateAction {
     Continue = 0,
     Skip = 1,
     ReplaceItem = 2,
-    ReplaceParent = 3
+    ReplaceParent = 3,
+    DeleteParent = 4
 }
 
 /**
@@ -127,6 +129,7 @@ export declare class NavigateResult {
     static ReplaceItem(by: any): NavigateResult;
     static Skip(): NavigateResult;
     static Continue(): NavigateResult;
+    static DeleteParent(): NavigateResult;
 }
 
 /**
@@ -143,6 +146,7 @@ export declare interface ProcessFieldsOptions {
     keys?: FieldProcessorMatcherAsync[];
     variables?: FieldVariableMatcher[];
     filters?: RegExp[];
+    origin?: string;
 }
 
 /**
@@ -152,6 +156,18 @@ export declare interface ProcessFieldsOptions {
  */
 export declare const processIncludes: (includes: string[], options?: IncludeOptions) => Promise<void>;
 
+export declare const select: (at: string, options: {
+    root?: any;
+    load?: (from: string) => Promise<any>;
+}) => Promise<any>;
+
+export declare interface SelectOptions {
+    set?: any;
+    format?: string;
+    key?: string;
+    separator?: string;
+}
+
 /**
  * @public
  * @param from
@@ -159,6 +175,12 @@ export declare const processIncludes: (includes: string[], options?: IncludeOpti
  * @param set
  * @returns
  */
-export declare const select: <T = any>(from: any, path: string, set?: any) => T;
+export declare const selectPath: <T = any>(from: any, path: string, options?: SelectOptions) => T;
+
+export declare const toList: <T>(from: any, key?: string) => T[];
+
+export declare const toObject: <T>(from: any[], key?: string) => T;
+
+export declare const toObjectWithKey: <T>(from: any[], key?: string) => T;
 
 export { }

package/package.json

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