@homedev/objector 0.1.9 → 0.1.11

package/dist/index.js

@@ -0,0 +1,2 @@
+import l from"path";import P from"fs/promises";import X from"path";import p from"yaml";var u=async(F)=>{try{return await P.access(F,P.constants.R_OK),!0}catch{return!1}},I=async(F,w)=>{let O=await(async()=>{let $=[""];if(!X.isAbsolute(F)&&w?.dirs)$.push(...w.dirs);for(let M of $){let q=X.join(M,F);if(await u(q))return X.resolve(q)}throw new Error(`File not found: "${F}"`)})(),T=await P.readFile(O),C=X.dirname(O),E={"[.](yml|yaml)$":p.parse,"[.]json$":JSON.parse,...w?.parsers},j=Object.entries(E).find(($)=>O.match($[0]));if(!j)throw new Error(`Unhandled file type: ${F}`);return{content:j[1](T.toString()),fullPath:O,folderPath:C}};var z=async(F,w)=>{for(let r of F){let O=w?.root?l.join(w.root,r):r,T=await I(O,w?.loadOptions);if(w?.loaded)await w.loaded(T)}};var S=(F,w,r)=>{for(let O of Object.keys(w)){if(F[O]===void 0)continue;let T=w[O],C=F[O];if(typeof C!==typeof T||Array.isArray(C)!==Array.isArray(T)){let j=r?.mismatch?.(O,C,T,F,w);if(j!==void 0){w[O]=j;continue}throw new Error(`Type mismatch: ${O}`)}let E=r?.mode?.(O,C,T,F,w)??"merge";switch(E){case"source":w[O]=C;continue;case"target":continue;case"skip":delete w[O],delete F[O];continue;case"merge":break;default:throw new Error(`Unknown merge mode: ${E}`)}if(typeof C==="object")if(Array.isArray(C))T.push(...C);else{if(r?.navigate?.(O,C,T,F,w)===!1)continue;S(C,T,r)}else{if(C===T)continue;let j=r?.conflict?.(O,C,T,F,w);w[O]=j===void 0?T:j}}for(let O of Object.keys(F))if(w[O]===void 0)w[O]=F[O]};var K;((E)=>{E[E.Explore=0]="Explore";E[E.SkipSiblings=1]="SkipSiblings";E[E.NoExplore=2]="NoExplore";E[E.ReplaceItem=3]="ReplaceItem";E[E.ReplaceParent=4]="ReplaceParent";E[E.DeleteParent=5]="DeleteParent"})(K||={});class U{action;by;constructor(F,w){this.action=F;this.by=w}static ReplaceParent(F){return new U(4,F)}static ReplaceItem(F){return new U(3,F)}static SkipSiblings(){return new U(1)}static Explore(){return new U(0)}static NoExplore(){return new U(2)}static DeleteParent(){return new U(5)}}var Y=async(F,w)=>{let r=async(T)=>{let C=T.key===null,E=C?{action:0}:await w(T);if(T.value&&typeof T.value==="object"&&E.action==0){if(!C)T.path.push(T.key);if(await O(T),!C)T.path.pop()}return E},O=async(T)=>{for(let[C,E]of Object.entries(T.value)){let j=await r({key:C,value:E,path:T.path,parent:T.value});switch(j.action){case 4:if(!T.key)throw new Error("Cannot replace root");T.parent[T.key]=j.by;return;case 3:T.value[C]=j.by;break;case 5:delete T.parent[T.key];return;case 1:return}}};await r({key:null,value:F,path:[],parent:null})};var A=(F,w,r="(",O=")")=>{let T=0,C="",E=[];for(let j of F){if(C+=j,j===r)T++;if(j===O)T--;if(T===0&&j===w)E.push(C.slice(0,-1)),C=""}if(C)E.push(C);return E},g=(F)=>{let w=/(?:\s*"([^"]*)"\s*|([^",]+))(?:,)?|(,)/g,r=[],O;while((O=w.exec(F))!==null)r.push({value:O[1]??O[2]?.trim()??"",quoted:O[1]!==void 0});return r};var f=(F,w,r,O)=>{if(F.startsWith("{")){let T=F.substring(1,F.length-1);return Z(w,T,r).toString()}return O?F:void 0},i=(F,w,r,O)=>{let T=f(w,r,O);if(T)return Z(F,T,O);let C=/^\[([^=\]]*)([=]*)([^\]]*)\]$/.exec(w);if(C){let[j,b,$,M]=C,q=f(b.trim(),r,O,!0),L=f(M.trim(),r,O,!0);if(Array.isArray(F))switch($){case"==":case"=":return F.find((G)=>G[q]==L)}}let E=/^([^[\]]*)\[([^\]]*)]/.exec(w);if(E)return F[E[1]][E[2]];return F[w]},Z=(F,w,r)=>{let O=void 0,T=void 0;w??="";let C=(M)=>M?.endsWith("?")?[M.substring(0,M.length-1),!0]:[M,!1],E=(M,q)=>{let[L,G]=C(q.pop());if(L){let H=i(M,L,F,r);if(H===void 0){if(G||r?.defaultValue!==void 0)return;throw new Error(`Unknown path element: "${L}" in "${w}"`)}return O=M,T=L,E(H,q)}if(r?.set&&T)O[T]=r?.set;return M},j=A(w,r?.separator??".","{","}"),b=j.length>0&&j[j.length-1].startsWith("?=")?j.pop()?.substring(2):void 0;j.reverse();let $=E(F,j);if($===void 0)return b??r?.defaultValue;return $};var B=(F,w)=>{let r=/^(?<path>[^@>]*)?(?:@(?<from>[^>]*))?$/.exec(F)?.groups;if(!r)throw new Error(`Invalid reference: "${F}"`);let{from:O,path:T}=r;if(!O)return Z(w.root,T,{defaultValue:w?.defaultValue});if(w.async===!1){if(!w.load)throw new Error("No load function defined");return Z(w.load(O),T,{defaultValue:w?.defaultValue})}else return(w.load??I)(O).then((C)=>Z(C,T))};var J=async(F,w,r,O)=>{let T,C=[],E=w;if(!O.sources)return U.Explore();if(E=E.replaceAll(O.sourcesMatcher??/\$\((?<key>[^:()]+)(?::(?<arg>(?:(?:"[^"]*"|[^",()]*),?)*))?\)/g,(j,...b)=>{if(T)return j;let $=(_)=>{if(_ instanceof Promise)return`ð[${C.push(_)}]ñ`;if(typeof _==="object")return T=_,j;return _??""},M=b[b.length-1],q=O.sources[M.key];if(M.arg===void 0)return $(B(M.key,{root:r,load:O?.load}));if(q===void 0)throw new Error(`Unhandled source type: ${M.key}`);let[L,G]="fn"in q?[q.fn,q]:[q,{}],H=g(M.arg),v=G.processArgs===!1?[]:H.map((_)=>_.quoted?_.value:B(_.value,{root:r}));return $(L({groups:M,args:v,rawArgs:H,path:F,value:E,root:r,key:M.key,options:O}))}),T)E=await T;else if(C.length){let j=await Promise.all(C);E=j.find((b)=>typeof b==="object")??E.replaceAll(/\xf0\[(\d+)]\xf1/g,(b,$)=>j[+$-1])}if(E===null)return U.DeleteParent();if(E===w)return U.Explore();if(E instanceof U)return E;if(typeof E==="string"){let j=await J(F,E,r,O);if(j.action!==0)return j}return U.ReplaceItem(E)};var V=async(F,w,r,O)=>{if(F.key.startsWith("$"))return U.NoExplore();if(!O.keys)return;let T=(O?.keysMatcher??/^\.(?<key>.*)/).exec(F.key)?.groups;if(T){let C=O.keys[T.key];if(C!==void 0){let E=typeof C==="object"?C:{},j=typeof C==="function"?C:C.fn;if(typeof F.value==="string"){let M=await J(w,F.value,r,O);if(M.by)F.value=M.by}else await W(F.value,{...O,filters:[...O.filters??[],...E.filters??[]]});let b={args:[F.value],rawArgs:[],groups:T,path:w,value:F.value,root:r,parent:F.parent,key:F.key,file:O?.file,options:O},$=await j(b);if($ instanceof U)return $;if($===null)return U.DeleteParent();if($===void 0)return U.Explore();return U.ReplaceParent($)}}};var W=async(F,w)=>Y(F,async(r)=>{let O=[...r.path,r.key].join(".");if(w.filters?.length&&w.filters.some((T)=>T.test(O)))return U.NoExplore();return await V(r,O,{...F,...w.root},w)??(typeof r.value==="string"?J(O,r.value,{...F,...w.root},w):U.Explore())});var zw=async(F,w)=>{let r=[];return await Y(F,(O)=>{if(w([...O.path,O.key].join("."),O.value))r.push(O.value);return U.Explore()}),r};var y=(F,w="name")=>Object.entries(F).map(([r,O])=>({[w]:r,...O})),Aw=(F,w="name")=>Object.fromEntries(F.map((r)=>[r[w],r])),R=(F,w="name")=>Object.fromEntries(F.map((r)=>{let{[w]:O,...T}=r;return[O,T]}));import Q from"fs/promises";import n from"path";import o from"yaml";import D from"path";var d=(F)=>{return{load:async(w)=>{for(let{file:r,alias:O}of Array.isArray(w.value)?w.value:[w.value]){if(!r)throw new Error("File reference required");await F.load(r,O??r,w.file&&D.dirname(w.file))}delete w.parent[w.key]},include:(w)=>F.load(w.value,void 0,w.file&&D.dirname(w.file)),from:async(w)=>{let r=await B(w.value,{root:w.root,load:(O)=>F.load(O,void 0,w.file&&D.dirname(w.file))});if(w.parent.content){if(Array.isArray(w.parent.content)&&Array.isArray(r))return[...r,...w.parent.content];return F.merge(r,w.parent.content),w.parent.content}return r},concat:async(w)=>{let r=[];for(let O of Array.isArray(w.value)?w.value:[w.value])r.push(...await B(O,{root:w.root,load:(T)=>F.load(T,void 0,w.file&&D.dirname(w.file))}));return r.filter((O)=>O!==void 0)},extends:async(w)=>{for(let r of Array.isArray(w.value)?w.value:[w.value])F.merge(await B(r,{root:w.root,load:(O)=>F.load(O,void 0,w.file&&D.dirname(w.file))}),w.parent);delete w.parent[w.key]},alias:(w)=>{F.alias(w.value,w.parent),delete w.parent[w.key]},if:(w)=>{if(!w.value)return null;delete w.parent[w.key]},skip:(w)=>{return delete w.parent[w.key],U.SkipSiblings()},output:(w)=>{delete w.parent[w.key];for(let r of Array.isArray(w.value)?w.value:[w.value])if(typeof r==="string")F.output({name:r,value:w.parent});else F.output({...r,value:r.value??w.parent})},each:{filters:[/select|model/],fn:async(w)=>{delete w.parent[w.key];let r=($)=>B($,{root:w.root,load:(M)=>F.load(M,void 0,w.file&&D.dirname(w.file))}),O=()=>{if(typeof w.value==="string"||!w.value.model)return w.parent;if(typeof w.value.model==="string")return r(w.value.model);return w.value.model},T=()=>{if(typeof w.value==="string")return r(w.value);if(Array.isArray(w.value))return w.value;if(typeof w.value.from==="string")return r(w.value.from);return w.value.from},C=async($)=>{let M=w.value.select;if(M===void 0)return $;if(typeof M!=="string"){let q=JSON.parse(JSON.stringify(M));return await W(q,{...w.options,root:{...w.root,result:$}}),q}return await B(M,{root:{...w.root,result:$}})},E=await T(),j=await O();if(!Array.isArray(E))throw new Error('Key "each" requires a source list');if(j===void 0)throw new Error('Key "each" must define a model');if(w.value.extend?.model)j=F.mergeAll([j,...Array.isArray(w.value.extend.model)?w.value.extend.model:[w.value.extend.model]]);let b=[];for(let $=0;$<E.length;$++){let M=JSON.parse(JSON.stringify(j));if(await W(M,{...w.options,root:{...w.root,item:E[$],this:M,index:$}}),w.value.extend?.result)M=F.mergeAll([M,...Array.isArray(w.value.extend?.result)?w.value.extend.result:[Array.isArray(w.value.extend?.result)]]);b.push(await C(M))}return b}}}};import a from"fs/promises";var h=(F)=>F.replace(/((?:[_ ]+)\w|^\w)/g,(w,r)=>r.toUpperCase()).replace(/_/g,""),s=(F)=>h(F).replace(/((?:[ ]+\w)|^\w)/g,(w,r)=>r.toLowerCase()),m=(F,w)=>F.replace(/([a-z])([A-Z])/g,`$1${w}$2`).replace(/\s+/g,w),k=(F,w)=>{switch(w){case"upper":return F.toUpperCase();case"lower":return F.toLowerCase()}},N=(F)=>{return{include:async(w)=>await F.load(w.args[0],w.args[1]),file:async(w)=>await a.readFile(w.args[0]).then((r)=>r.toString()),env:(w)=>process.env[w.args[0]],len:(w)=>w.args[0].length,reverse:(w)=>w.args[0].split("").reverse().join(""),substring:(w)=>w.args[0].substring(+w.args[1],+w.args[2]),concat:(w)=>w.args.join(""),lower:(w)=>w.args[0].toLowerCase(),upper:(w)=>w.args[0].toUpperCase(),pascal:(w)=>h(w.args[0]),camel:(w)=>s(w.args[0]),snake:(w)=>k(m(w.args[0],"_"),w.args[1]),kebab:(w)=>k(m(w.args[0],"-"),w.args[1]),encode:(w)=>Buffer.from(w.args[0]).toString(w.args[1]??"base64"),decode:(w)=>Buffer.from(w.args[0],w.args[1]??"base64").toString(),uuid:(w)=>crypto.randomUUID(),join:(w)=>{let[r,O,T]=w.args,C=B(r,{root:w.root,load:(E)=>F.load(E)});if(!Array.isArray(C))throw new Error("Object is not a list");if(O?.length)C=C.map((E)=>B(O,{root:{...w.root,...E},load:(j)=>F.load(j)}));return C.join(T?.replace("\\n",`
+`))},list:async(w)=>y(await B(w.args[0],{root:w.root,load:(r)=>F.load(r)}),w.args[1]),object:async(w)=>R(await B(w.args[0],{root:w.root,load:(r)=>F.load(r)}),w.args[1]),default:{processArgs:!1,fn:async(w)=>{let r=w.rawArgs[1]?.value?w.rawArgs[1].quoted?w.rawArgs[1].value:await B(w.rawArgs[1].value,{root:w.root,load:(O)=>F.load(O)}):"";return await B(w.rawArgs[0].value,{root:w.root,load:(O)=>F.load(O),defaultValue:r})}}}};class x{options={load:{dirs:[]},merge:{},include:{},fields:{},includeKey:"includes",mergeKey:".merge",outputs:[]};cache={};includeDirectory(...F){return this.options.load.dirs??=[],this.options.load.dirs.push(...F),this}keys(F){return this.options.fields.keys={...this.options.fields.keys,...F},this}sources(F){return this.options.fields.sources={...this.options.fields.sources,...F},this}variables(F){return this.options.variables={...this.options.variables,...F},this}output(F){return this.options.outputs??=[],this.options.outputs.push(F),this}defaultProcessors(){return this.sources(N(this)).keys(d(this))}alias(F,w){return this.cache[F]=w,this}getAlias(F){return this.cache[F]}getOutputs(){return this.options.outputs??[]}use(F){return F(this),this}filter(F){return this.options.fields.filters??=[],this.options.fields.filters?.push(F),this}async load(F,w,r){if(w&&this.cache[w])return this.cache[w];if(this.cache[F])return this.cache[F];let O=r?[r]:[];this.options.load.dirs&&O.push(...this.options.load.dirs);let T=await I(F,{...this.options.load,dirs:O});if(!T.content)return null;if(w)this.cache[w]=T.content;if(this.options.includeKey&&T.content[this.options.includeKey])await z(T.content[this.options.includeKey],{root:T.folderPath,loaded:(C)=>{if(this.options.mergeKey&&C.content)S(C.content,T.content,{mode:(E,j,b)=>b[this.options.mergeKey],...this.options.merge})},loadOptions:this.options.load,...this.options.include}),delete T.content[this.options.includeKey];return await W(T.content,{...this.options.fields,file:T.fullPath,root:{...this.options.fields.root,...this.options.variables},load:(C)=>this.load(C)}),T.content}merge(F,w){S(F,w,{mode:(r,O,T)=>T[this.options.mergeKey],...this.options.merge})}mergeAll(F){let w={};for(let r of F.toReversed())this.merge(r,w);return w}async writeOutputs(F){if(F?.targetDirectory&&F?.removeFirst)try{await Q.rm(F?.targetDirectory,{recursive:!0,force:!0})}catch(w){throw new Error(`Failed to clean the output directory: ${w.message}`)}for(let w of this.getOutputs()){let r=n.join(F?.targetDirectory??".",w.name),O=n.dirname(r);if(F?.writing?.(w)===!1)continue;try{await Q.mkdir(O,{recursive:!0})}catch(T){throw new Error(`Failed to create target directory "${O}" for output "${r}": ${T.message}`)}try{switch(w.type){case"yaml":await Q.writeFile(r,o.stringify(w.value));break;case"json":await Q.writeFile(r,JSON.stringify(w.value));break;default:await Q.writeFile(r,w.value.toString())}}catch(T){throw new Error(`Failed to write output "${r}": ${T.message}`)}}}}export{Aw as toObjectWithKey,R as toObject,y as toList,B as select,z as processIncludes,W as processFields,Y as navigate,S as merge,I as load,zw as find,x as Objector,U as NavigateResult,K as NavigateAction};

package/dist/objector.d.ts

@@ -0,0 +1,216 @@
+/**
+ * @public
+ */
+export declare interface DataFile<T = any> {
+    content: T;
+    fullPath: string;
+    folderPath: string;
+}
+
+export declare interface FieldContext {
+    value: any;
+    key: string;
+    args: string[];
+    rawArgs: {
+        value: string;
+        quoted: boolean;
+    }[];
+    groups: Record<string, string>;
+    path: string;
+    root: any;
+    parent?: any;
+    file?: string;
+    options?: ProcessFieldsOptions;
+}
+
+export declare type FieldProcessorFunc = (context: FieldContext) => MaybePromise<any>;
+
+export declare type FieldProcessorMap = Record<string, FieldProcessorFunc | FieldProcessorOptions>;
+
+export declare interface FieldProcessorOptions {
+    fn: FieldProcessorFunc;
+    filters?: RegExp[];
+    processArgs?: boolean;
+}
+
+/**
+ * @public
+ * @param from
+ * @param cb
+ * @returns
+ */
+export declare const find: (from: any, cb: (path: string, value: string) => any) => Promise<any[]>;
+
+/**
+ * @public
+ */
+export declare interface IncludeOptions {
+    root?: string;
+    loaded?: (data: DataFile) => Promise<void> | void;
+    loadOptions?: LoadOptions;
+}
+
+/**
+ * @public
+ * @param fileName
+ * @param options
+ * @returns
+ */
+export declare const load: <T = any>(fileName: string, options?: LoadOptions) => Promise<DataFile<T>>;
+
+/**
+ * @public
+ */
+export declare interface LoadOptions {
+    dirs?: string[];
+    parsers?: Record<string, (data: string) => any>;
+}
+
+declare type MaybePromise<T> = T | Promise<T>;
+
+/**
+ * @public
+ * @param source
+ * @param target
+ * @param options
+ */
+export declare const merge: (source: any, target: any, options?: MergeOptions) => void;
+
+/**
+ * @public
+ */
+export declare type MergeMode = 'merge' | 'source' | 'target' | 'skip';
+
+/**
+ * @public
+ */
+export declare interface MergeOptions {
+    conflict?: (key: string, source: any, target: any, sourceContainer: any, targetContainer: any) => any;
+    mismatch?: (key: string, source: any, target: any, sourceContainer: any, targetContainer: any) => any;
+    navigate?: (key: string, source: any, target: any, sourceContainer: any, targetContainer: any) => boolean | undefined;
+    mode?: (key: string, source: any, target: any, sourceContainer: any, targetContainer: any) => MergeMode | void;
+}
+
+/**
+ * @public
+ * @param o
+ * @param cb
+ */
+export declare const navigate: (o: any, cb: NavigateCallback) => Promise<void>;
+
+/**
+ * @public
+ */
+export declare enum NavigateAction {
+    Explore = 0,
+    SkipSiblings = 1,
+    NoExplore = 2,
+    ReplaceItem = 3,
+    ReplaceParent = 4,
+    DeleteParent = 5
+}
+
+/**
+ * @public
+ */
+export declare type NavigateCallback = (context: NavigateContext) => Promise<NavigateResult> | NavigateResult;
+
+/**
+ * @public
+ */
+export declare interface NavigateContext {
+    key: string;
+    value: any;
+    path: string[];
+    parent: any;
+}
+
+/**
+ * @public
+ */
+export declare class NavigateResult {
+    readonly action: NavigateAction;
+    by?: any | undefined;
+    constructor(action: NavigateAction, by?: any | undefined);
+    static ReplaceParent(by: any): NavigateResult;
+    static ReplaceItem(by: any): NavigateResult;
+    static SkipSiblings(): NavigateResult;
+    static Explore(): NavigateResult;
+    static NoExplore(): NavigateResult;
+    static DeleteParent(): NavigateResult;
+}
+
+/**
+ * @public
+ */
+export declare class Objector {
+    private cache;
+    includeDirectory(...dirs: string[]): this;
+    keys(keys: FieldProcessorMap): this;
+    sources(sources: FieldProcessorMap): this;
+    variables(vars: Record<string, any>): this;
+    output(o: ObjectorOutput): this;
+    defaultProcessors(): this;
+    alias(name: string, o: any): this;
+    getAlias(name: string): any;
+    getOutputs(): ObjectorOutput[];
+    use(handler: (o: Objector) => void): this;
+    filter(f: RegExp): this;
+    load<T = any>(fileName: string, alias?: string, cwd?: string): Promise<T | null>;
+    merge(source: any, target: any): void;
+    mergeAll(elements: any[]): any;
+    writeOutputs(options?: WriteOutputsOption): Promise<void>;
+}
+
+declare interface ObjectorOutput {
+    name: string;
+    type?: string;
+    value: any;
+}
+
+/**
+ * @public
+ * @param root
+ * @param options
+ * @returns
+ */
+export declare const processFields: (root: any, options: ProcessFieldsOptions) => Promise<void>;
+
+export declare interface ProcessFieldsOptions {
+    sourcesMatcher?: RegExp;
+    sources?: FieldProcessorMap;
+    keysMatcher?: RegExp;
+    keys?: FieldProcessorMap;
+    filters?: RegExp[];
+    file?: string;
+    root?: any;
+    load?: (from: string) => Promise<any>;
+}
+
+/**
+ * @public
+ * @param includes
+ * @param options
+ */
+export declare const processIncludes: (includes: string[], options?: IncludeOptions) => Promise<void>;
+
+export declare const select: (at: string, options: {
+    root?: any;
+    load?: (from: string) => Promise<any>;
+    async?: boolean;
+    defaultValue?: any;
+}) => any;
+
+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;
+
+declare interface WriteOutputsOption {
+    targetDirectory?: string;
+    removeFirst?: boolean;
+    writing?: (output: ObjectorOutput) => boolean | undefined | void;
+}
+
+export { }

package/package.json

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