@homedev/objector 0.1.8 → 0.1.9

package/package.json

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

package/dist/index.js

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

package/dist/objector.d.ts

@@ -1,209 +0,0 @@
-/**
- * @public
- */
-export declare interface DataFile<T = any> {
-    content: T;
-    fullPath: string;
-    folderPath: string;
-}
-
-export declare interface FieldContext {
-    value: any;
-    key: string;
-    args: string[];
-    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[];
-}
-
-/**
- * @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;
-}
-
-/**
- * @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;
-}) => 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 { }