@homedev/objector 0.0.18 → 0.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +2 -2
- package/dist/objector.d.ts +15 -16
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import N from"path";import
|
|
1
|
+
import N from"path";import z from"fs/promises";import Q from"path";import k from"yaml";var f=async(T)=>{try{return await z.access(T,z.constants.R_OK),!0}catch{return!1}},I=async(T,F)=>{let E=await(async()=>{let W=[""];if(!Q.isAbsolute(T)&&F?.dirs)W.push(...F.dirs);for(let B of W){let Y=Q.join(B,T);if(await f(Y))return Q.resolve(Y)}throw new Error(`File not found: "${T}"`)})(),M=await z.readFile(E),C=Q.dirname(E),j={"[.](yml|yaml)$":k.parse,"[.]json$":JSON.parse,...F?.parsers},$=Object.entries(j).find((W)=>E.match(W[0]));if(!$)throw new Error(`Unhandled file type: ${T}`);return{content:$[1](M.toString()),fullPath:E,folderPath:C}};var D=async(T,F)=>{for(let O of T){let E=F?.root?N.join(F.root,O):O,M=await I(E,F?.loadOptions);if(F?.loaded)await F.loaded(M)}};var U=(T,F,O)=>{for(let E of Object.keys(F)){if(T[E]===void 0)continue;let M=F[E],C=T[E];if(typeof C!==typeof M||Array.isArray(C)!==Array.isArray(M)){let $=O?.mismatch?.(E,C,M,T,F);if($!==void 0){F[E]=$;continue}throw new Error(`Type mismatch: ${E}`)}let j=O?.mode?.(E,C,M,T,F)??"merge";switch(j){case"source":F[E]=C;continue;case"target":continue;case"skip":delete F[E],delete T[E];continue;case"merge":break;default:throw new Error(`Unknown merge mode: ${j}`)}if(typeof C==="object")if(Array.isArray(C))M.push(...C);else{if(O?.navigate?.(E,C,M,T,F)===!1)continue;U(C,M,O)}else{if(C===M)continue;let $=O?.conflict?.(E,C,M,T,F);F[E]=$===void 0?M:$}}for(let E of Object.keys(T))if(F[E]===void 0)F[E]=T[E]};var L;((C)=>{C[C.Continue=0]="Continue";C[C.Skip=1]="Skip";C[C.ReplaceItem=2]="ReplaceItem";C[C.ReplaceParent=3]="ReplaceParent";C[C.DeleteParent=4]="DeleteParent"})(L||={});class q{action;by;constructor(T,F){this.action=T;this.by=F}static ReplaceParent(T){return new q(3,T)}static ReplaceItem(T){return new q(2,T)}static Skip(){return new q(1)}static Continue(){return new q(0)}static DeleteParent(){return new q(4)}}var X=async(T,F)=>{let O=async(M)=>{for(let[C,j]of Object.entries(M.value)){let $=await E({key:C,value:j,path:M.path,parent:M.value});switch($.action){case 3:if(!M.key)throw new Error("Cannot replace root");M.parent[M.key]=$.by;return;case 2:M.value[C]=$.by;break;case 1:return;case 4:delete M.parent[M.key];return}}},E=async(M)=>{let C=M.key?await F(M):{action:0};if(C.action===0){if(M.value&&typeof M.value==="object"){if(M.key)M.path.push(M.key);if(await O(M),M.key)M.path.pop()}}return C};await E({key:null,value:T,path:[],parent:null})};var w=async(T,F,O,E)=>{if(!E.keys)return;let M=(E?.keysMatcher??/^\.(?<key>.*)/).exec(T.key)?.groups;if(M){if(E.keys[M.key]){let C={arg:T.value,groups:M,path:F,value:T.value,root:O,parent:T.parent,key:T.key,file:E?.file,options:E},j=typeof E.keys[M.key]==="function"?await E.keys[M.key](C):E.keys[M.key];if(j===null)return q.DeleteParent();if(j===void 0)return q.Continue();return q.ReplaceParent(j)}}};import h from"yaml";var S=(T,F="name")=>Object.entries(T).map(([O,E])=>({[F]:O,...E})),TF=(T,F="name")=>Object.fromEntries(T.map((O)=>[O[F],O])),K=(T,F="name")=>Object.fromEntries(T.map((O)=>{let{[F]:E,...M}=O;return[E,M]}));var b=(T,F,O="(",E=")")=>{let M=0,C="",j=[];for(let $ of T){if(C+=$,$===O)M++;if($===E)M--;if(M===0&&$===F)j.push(C.slice(0,-1)),C=""}if(C)j.push(C);return j};var m=(T,F,O,E)=>{if(F.startsWith("{")){let j=F.substring(1,F.length-1),$=G(O,j,E).toString();return G(T,$,E)}let M=/^\[([^=\]]*)([=]*)([^\]]*)\]$/.exec(F);if(M){let[j,$,P,W]=M;if(Array.isArray(T))switch(P){case"==":case"=":return T.find((B)=>B[$.trim()]==W.trim())}}let C=/^([^[\]]*)\[([^\]]*)]/.exec(F);if(C)return T[C[1]][C[2]];return T[F]},G=(T,F,O)=>{let E=void 0,M=void 0;F??="";let C=($,P)=>{let W=P.pop();if(W){let B=m($,W,T,O);if(B===void 0)throw new Error(`Unknown path element: "${W}" in "${F}"`);return E=$,M=W,C(B,P)}if(O?.set&&M)E[M]=O?.set;return $},j=C(T,b(F,O?.separator??".","{","}").reverse());switch(O?.format){case"list":return S(j,O?.key);case"object":return K(j,O?.key);case"json":return JSON.stringify(j);case"yaml":return h.stringify(j);case"join":{let $=Array.isArray(j)?j:S(j),[,P,W]=O?.key?.match(/([^|]*)?(?:\|(.*))?/)??[];return $.map((B)=>P?B[P]:B).join(W?.replaceAll("\\n",`
|
|
2
2
|
`)??`
|
|
3
|
-
`)}default:return
|
|
3
|
+
`)}default:return j}};var R=async(T,F,O,E)=>{let M,C=[],j=F;if(!E.sources)return;let $=(P)=>{let W=E.sources[P.key];if(W===void 0)return G(O,P.key);else{if(P.arg&&P.arg[0]==="{")P.arg=G(O,P.arg.substr(1,P.arg.length-2));return W({groups:P,arg:P.arg,path:T,value:j,root:O,key:P.key,options:E})}};if(j=j.replaceAll(E.sourcesMatcher??/\$\((?<key>[^:)]*)(?::(?<arg>[^)]*))?\)/g,(P,...W)=>{if(M)return P;let B=$(W[W.length-1]);if(B instanceof Promise)return`ð[${C.push(B)}]ñ`;if(typeof B==="object")return M=B,P;return B}),M)j=await M;else if(C.length){let P=await Promise.all(C);j=P.find((W)=>typeof W==="object")??j.replaceAll(/\xf0\[(\d+)]\xf1/g,(W,B)=>P[+B-1])}if(j===null)return q.DeleteParent();if(j===F)return q.Continue();return q.ReplaceItem(j)};var Z=async(T,F)=>X(T,async(O)=>{let E=[...O.path,O.key].join(".");if(F.filters&&!F.filters.some((C)=>C.test(E)))return q.Continue();let M=async(C)=>{let j=await R(E,C,{...T,...F.root},F);if(j.action===2&&typeof j.by==="string"){let $=await M(j.by);if($.by)return $}return j};return await w(O,E,{...T,...F.root},F)??(typeof O.value==="string"?await M(O.value):q.Continue())});var H=(T,F)=>{let O=/^(?<path>[^@>]*)?(?:@(?<from>[^>]*))?(?:>(?<format>[^|]*)(?:\|(?<key>.*))?)?$/.exec(T)?.groups;if(!O)throw new Error(`Invalid reference: "${T}"`);let{from:E,path:M,format:C,key:j}=O;if(!E)return G(F.root,M,{format:C,key:j});if(F.async===!1){if(!F.load)throw new Error("No load function defined");return G(F.load(E),M,{format:C,key:j})}else return(F.load??I)(E).then(($)=>G($,M,{format:C,key:j}))};var zF=async(T,F)=>{let O=[];return await X(T,(E)=>{if(F([...E.path,E.key].join("."),E.value))O.push(E.value);return q.Continue()}),O};import _ from"fs/promises";import y from"path";import v from"yaml";import J from"path";var A=(T)=>{return{load:async(F)=>{for(let{file:O,alias:E}of Array.isArray(F.value)?F.value:[F.value]){if(!O)throw new Error("File reference required");await T.load(O,E??O,F.file&&J.dirname(F.file))}delete F.parent[F.key]},include:(F)=>T.load(F.value,void 0,F.file&&J.dirname(F.file)),from:async(F)=>{let O=await H(F.value,{root:F.root,load:(E)=>T.load(E,void 0,F.file&&J.dirname(F.file))});if(F.parent.content){if(Array.isArray(F.parent.content)&&Array.isArray(O))return[...O,...F.parent.content];return T.merge(O,F.parent.content),F.parent.content}return O},concat:async(F)=>{let O=[];for(let E of Array.isArray(F.value)?F.value:[F.value])O.push(...await H(E,{root:F.root,load:(M)=>T.load(M,void 0,F.file&&J.dirname(F.file))}));return O.filter((E)=>E!==void 0)},extends:async(F)=>{for(let O of Array.isArray(F.value)?F.value:[F.value])T.merge(await H(O,{root:F.root,load:(E)=>T.load(E,void 0,F.file&&J.dirname(F.file))}),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 O of Array.isArray(F.value)?F.value:[F.value])T.output(O,F.parent)},each:async(F)=>{delete F.parent[F.key];let O=Array.isArray(F.value)?F.value:await H(F.value,{root:F.root,load:(M)=>T.load(M,void 0,F.file&&J.dirname(F.file))}),E=[];if(!Array.isArray(O))throw new Error("source must be a list");for(let M=0;M<O.length;M++){let C=JSON.parse(JSON.stringify(F.parent));await Z(C,{...F.options,root:{...F.root,item:O[M],this:C,index:M}}),E.push(C)}return E}}};import d from"fs/promises";var V=(T)=>{return{include:(F)=>T.load(F.arg),file:(F)=>d.readFile(F.arg).then((O)=>O.toString()),env:(F)=>process.env[F.arg],ref:(F)=>H(F.arg,{root:F.root,load:(O)=>T.load(O)})}};class g{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}keys(T){return this.options.fields.keys={...this.options.fields.keys,...T},this}sources(T){return this.options.fields.sources={...this.options.fields.sources,...T},this}variables(T){return this.options.variables={...this.options.variables,...T},this}output(T,F){return this.options.outputs??={},this.options.outputs[T]=F,this}defaultProcessors(){return this.sources(V(this)).keys(A(this))}alias(T,F){return this.cache[T]=F,this}getAlias(T){return this.cache[T]}getOutputs(){return this.options.outputs??{}}async load(T,F,O){if(this.cache[T])return this.cache[T];let E=O?[O]:[];this.options.load.dirs&&E.push(...this.options.load.dirs);let M=await I(T,{...this.options.load,dirs:E});if(!M.content)return null;if(F)this.cache[F]=M.content;if(this.options.includeKey&&M.content[this.options.includeKey])await D(M.content[this.options.includeKey],{root:M.folderPath,loaded:(C)=>{if(this.options.mergeKey&&C.content)U(C.content,M.content,{mode:(j,$,P)=>P[this.options.mergeKey],...this.options.merge})},loadOptions:this.options.load,...this.options.include}),delete M.content[this.options.includeKey];return await Z(M.content,{...this.options.fields,file:M.fullPath,root:{...this.options.fields.root,...this.options.variables}}),M.content}merge(T,F){U(T,F,{mode:(O,E,M)=>M[this.options.mergeKey],...this.options.merge})}async writeOutputs(T){for(let[F,O]of Object.entries(this.getOutputs())){let E=y.join(T??".",F);try{switch(y.extname(F)){case".yml":case".yaml":await _.writeFile(E,v.stringify(O));break;case".json":await _.writeFile(E,JSON.stringify(O));break;default:await _.writeFile(E,O)}}catch{throw new Error(`Failed to write output: ${E}`)}}}}export{TF as toObjectWithKey,K as toObject,S as toList,H as select,D as processIncludes,Z as processFields,X as navigate,U as merge,I as load,zF as find,g as Objector,q as NavigateResult,L as NavigateAction};
|
package/dist/objector.d.ts
CHANGED
|
@@ -8,19 +8,18 @@ export declare interface DataFile<T = any> {
|
|
|
8
8
|
}
|
|
9
9
|
|
|
10
10
|
export declare interface FieldContext {
|
|
11
|
-
args: string[];
|
|
12
|
-
path: string;
|
|
13
11
|
value: any;
|
|
12
|
+
key: string;
|
|
13
|
+
arg: string;
|
|
14
|
+
groups: Record<string, string>;
|
|
15
|
+
path: string;
|
|
14
16
|
root: any;
|
|
15
17
|
parent?: any;
|
|
16
|
-
|
|
17
|
-
origin?: string;
|
|
18
|
+
file?: string;
|
|
18
19
|
options?: ProcessFieldsOptions;
|
|
19
20
|
}
|
|
20
21
|
|
|
21
|
-
export declare type FieldProcessorMap = Record<string, ((context: FieldContext) => MaybePromise<any>)
|
|
22
|
-
|
|
23
|
-
export declare type FieldProcessorMatcher = [matcher: RegExp, handlers: FieldProcessorMap];
|
|
22
|
+
export declare type FieldProcessorMap = Record<string, ((context: FieldContext) => MaybePromise<any>)>;
|
|
24
23
|
|
|
25
24
|
/**
|
|
26
25
|
* @public
|
|
@@ -133,12 +132,10 @@ export declare class NavigateResult {
|
|
|
133
132
|
export declare class Objector {
|
|
134
133
|
private cache;
|
|
135
134
|
includeDirectory(...dirs: string[]): this;
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
135
|
+
keys(keys: FieldProcessorMap): this;
|
|
136
|
+
sources(sources: FieldProcessorMap): this;
|
|
137
|
+
variables(vars: Record<string, any>): this;
|
|
139
138
|
output(name: string, value: any): this;
|
|
140
|
-
defaultSources(matcher?: RegExp): this;
|
|
141
|
-
defaultKeys(matcher?: RegExp): this;
|
|
142
139
|
defaultProcessors(): this;
|
|
143
140
|
alias(name: string, o: any): this;
|
|
144
141
|
getAlias(name: string): any;
|
|
@@ -154,13 +151,15 @@ export declare class Objector {
|
|
|
154
151
|
* @param options
|
|
155
152
|
* @returns
|
|
156
153
|
*/
|
|
157
|
-
export declare const processFields: (root: any, options
|
|
154
|
+
export declare const processFields: (root: any, options: ProcessFieldsOptions) => Promise<void>;
|
|
158
155
|
|
|
159
156
|
export declare interface ProcessFieldsOptions {
|
|
160
|
-
|
|
161
|
-
|
|
157
|
+
sourcesMatcher?: RegExp;
|
|
158
|
+
sources?: FieldProcessorMap;
|
|
159
|
+
keysMatcher?: RegExp;
|
|
160
|
+
keys?: FieldProcessorMap;
|
|
162
161
|
filters?: RegExp[];
|
|
163
|
-
|
|
162
|
+
file?: string;
|
|
164
163
|
root?: any;
|
|
165
164
|
}
|
|
166
165
|
|