depflow 3.0.0-dev.1 → 3.0.0-dev.11

package/dist/schema/Config/Builder.d.ts

@@ -0,0 +1,496 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>.
+ * @description Schema definitions for build steps: run, extract and transform entries.
+ * @license Apache-2.0
+ */
+import Schema from '@netfeez/schema';
+export declare const RunEntry: Schema<{
+    readonly type: "object";
+    readonly required: true;
+    readonly keys: {
+        readonly maxTimeMs: {
+            readonly type: "number";
+            readonly default: 60000;
+            readonly minimum: -1;
+            readonly description: "Maximum execution time for the run step in milliseconds. A value of -1 disables the limit.";
+        };
+        readonly allowFails: {
+            readonly type: "boolean";
+            readonly default: false;
+            readonly description: "Whether failed commands within the step are tolerated. Defaults to false.";
+        };
+        readonly run: {
+            readonly type: "union";
+            readonly required: true;
+            readonly union: readonly [{
+                readonly type: "string";
+            }, {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+            }];
+            readonly description: "Shell command or list of shell commands to execute.";
+        };
+    };
+}>;
+export type RunEntry = typeof RunEntry.infer;
+export declare namespace RunEntry { }
+export declare const ExtractEntry: Schema<{
+    readonly type: "object";
+    readonly required: true;
+    readonly keys: {
+        readonly extract: {
+            readonly type: "union";
+            readonly required: true;
+            readonly union: readonly [{
+                readonly type: "string";
+            }, {
+                readonly type: "object";
+                readonly required: true;
+                readonly additional: {
+                    readonly type: "union";
+                    readonly required: true;
+                    readonly union: readonly [{
+                        readonly type: "string";
+                        readonly required: true;
+                    }, {
+                        readonly type: "object";
+                        readonly required: true;
+                        readonly keys: {
+                            readonly to: {
+                                readonly type: "string";
+                                readonly required: true;
+                                readonly description: "Destination folder to which the matched files are copied. A relative path is resolved against the project root, an absolute one is used as it stands.";
+                            };
+                            readonly map: {
+                                readonly type: "union";
+                                readonly union: readonly [{
+                                    readonly type: "string";
+                                }, {
+                                    readonly type: "object";
+                                    readonly keys: {
+                                        readonly search: {
+                                            readonly type: "string";
+                                            readonly required: true;
+                                            readonly description: "The regular expression pattern to search for in the file content.";
+                                        };
+                                        readonly flags: {
+                                            readonly type: "string";
+                                            readonly default: "g";
+                                            readonly pattern: RegExp;
+                                            readonly description: "Flags applied to the regular expression search. Defaults to \"g\" (global).";
+                                        };
+                                        readonly replace: {
+                                            readonly type: "string";
+                                            readonly required: true;
+                                            readonly description: "The replacement string used to substitute the matches found by the search pattern.";
+                                        };
+                                    };
+                                }];
+                                readonly required: false;
+                                readonly description: "Transformation applied to the destination path of the extracted files.";
+                            };
+                            readonly transform: {
+                                readonly type: "union";
+                                readonly union: readonly [{
+                                    readonly type: "string";
+                                }, {
+                                    readonly type: "object";
+                                    readonly keys: {
+                                        readonly search: {
+                                            readonly type: "string";
+                                            readonly required: true;
+                                            readonly description: "The regular expression pattern to search for in the file content.";
+                                        };
+                                        readonly flags: {
+                                            readonly type: "string";
+                                            readonly default: "g";
+                                            readonly pattern: RegExp;
+                                            readonly description: "Flags applied to the regular expression search. Defaults to \"g\" (global).";
+                                        };
+                                        readonly replace: {
+                                            readonly type: "string";
+                                            readonly required: true;
+                                            readonly description: "The replacement string used to substitute the matches found by the search pattern.";
+                                        };
+                                    };
+                                }];
+                                readonly required: false;
+                                readonly description: "Transformation applied to the content of the extracted files.";
+                            };
+                        };
+                    }];
+                };
+                readonly description: "Mapping of source glob patterns, relative to the folder the pipeline works in, to extraction entries, each describing where and how files are extracted.";
+            }];
+            readonly description: "Destination folder for the extracted files or an extraction mapping.";
+        };
+    };
+}>;
+export type ExtractEntry = typeof ExtractEntry.infer;
+export declare namespace ExtractEntry { }
+export declare const TransformEntry: Schema<{
+    readonly type: "object";
+    readonly required: true;
+    readonly keys: {
+        readonly transform: {
+            readonly type: "object";
+            readonly required: true;
+            readonly keys: {
+                readonly search: {
+                    readonly type: "string";
+                    readonly required: true;
+                    readonly description: "The regular expression pattern to search for in the file content.";
+                };
+                readonly flags: {
+                    readonly type: "string";
+                    readonly default: "g";
+                    readonly pattern: RegExp;
+                    readonly description: "Flags applied to the regular expression search. Defaults to \"g\" (global).";
+                };
+                readonly replace: {
+                    readonly type: "string";
+                    readonly required: true;
+                    readonly description: "The replacement string used to substitute the matches found by the search pattern.";
+                };
+                readonly glob: {
+                    readonly type: "string";
+                    readonly required: true;
+                    readonly description: "Glob pattern matching the files to which the global transformation is applied.";
+                };
+            };
+            readonly description: "Global transformation to apply over the files matched by the glob pattern.";
+        };
+    };
+}>;
+export type TransformEntry = typeof TransformEntry.infer;
+export declare namespace TransformEntry { }
+export declare const BuilderEntry: Schema<{
+    readonly type: "union";
+    readonly required: true;
+    readonly union: readonly [{
+        readonly type: "object";
+        readonly required: true;
+        readonly keys: {
+            readonly maxTimeMs: {
+                readonly type: "number";
+                readonly default: 60000;
+                readonly minimum: -1;
+                readonly description: "Maximum execution time for the run step in milliseconds. A value of -1 disables the limit.";
+            };
+            readonly allowFails: {
+                readonly type: "boolean";
+                readonly default: false;
+                readonly description: "Whether failed commands within the step are tolerated. Defaults to false.";
+            };
+            readonly run: {
+                readonly type: "union";
+                readonly required: true;
+                readonly union: readonly [{
+                    readonly type: "string";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                }];
+                readonly description: "Shell command or list of shell commands to execute.";
+            };
+        };
+    }, {
+        readonly type: "object";
+        readonly required: true;
+        readonly keys: {
+            readonly extract: {
+                readonly type: "union";
+                readonly required: true;
+                readonly union: readonly [{
+                    readonly type: "string";
+                }, {
+                    readonly type: "object";
+                    readonly required: true;
+                    readonly additional: {
+                        readonly type: "union";
+                        readonly required: true;
+                        readonly union: readonly [{
+                            readonly type: "string";
+                            readonly required: true;
+                        }, {
+                            readonly type: "object";
+                            readonly required: true;
+                            readonly keys: {
+                                readonly to: {
+                                    readonly type: "string";
+                                    readonly required: true;
+                                    readonly description: "Destination folder to which the matched files are copied. A relative path is resolved against the project root, an absolute one is used as it stands.";
+                                };
+                                readonly map: {
+                                    readonly type: "union";
+                                    readonly union: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                        readonly keys: {
+                                            readonly search: {
+                                                readonly type: "string";
+                                                readonly required: true;
+                                                readonly description: "The regular expression pattern to search for in the file content.";
+                                            };
+                                            readonly flags: {
+                                                readonly type: "string";
+                                                readonly default: "g";
+                                                readonly pattern: RegExp;
+                                                readonly description: "Flags applied to the regular expression search. Defaults to \"g\" (global).";
+                                            };
+                                            readonly replace: {
+                                                readonly type: "string";
+                                                readonly required: true;
+                                                readonly description: "The replacement string used to substitute the matches found by the search pattern.";
+                                            };
+                                        };
+                                    }];
+                                    readonly required: false;
+                                    readonly description: "Transformation applied to the destination path of the extracted files.";
+                                };
+                                readonly transform: {
+                                    readonly type: "union";
+                                    readonly union: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "object";
+                                        readonly keys: {
+                                            readonly search: {
+                                                readonly type: "string";
+                                                readonly required: true;
+                                                readonly description: "The regular expression pattern to search for in the file content.";
+                                            };
+                                            readonly flags: {
+                                                readonly type: "string";
+                                                readonly default: "g";
+                                                readonly pattern: RegExp;
+                                                readonly description: "Flags applied to the regular expression search. Defaults to \"g\" (global).";
+                                            };
+                                            readonly replace: {
+                                                readonly type: "string";
+                                                readonly required: true;
+                                                readonly description: "The replacement string used to substitute the matches found by the search pattern.";
+                                            };
+                                        };
+                                    }];
+                                    readonly required: false;
+                                    readonly description: "Transformation applied to the content of the extracted files.";
+                                };
+                            };
+                        }];
+                    };
+                    readonly description: "Mapping of source glob patterns, relative to the folder the pipeline works in, to extraction entries, each describing where and how files are extracted.";
+                }];
+                readonly description: "Destination folder for the extracted files or an extraction mapping.";
+            };
+        };
+    }, {
+        readonly type: "object";
+        readonly required: true;
+        readonly keys: {
+            readonly transform: {
+                readonly type: "object";
+                readonly required: true;
+                readonly keys: {
+                    readonly search: {
+                        readonly type: "string";
+                        readonly required: true;
+                        readonly description: "The regular expression pattern to search for in the file content.";
+                    };
+                    readonly flags: {
+                        readonly type: "string";
+                        readonly default: "g";
+                        readonly pattern: RegExp;
+                        readonly description: "Flags applied to the regular expression search. Defaults to \"g\" (global).";
+                    };
+                    readonly replace: {
+                        readonly type: "string";
+                        readonly required: true;
+                        readonly description: "The replacement string used to substitute the matches found by the search pattern.";
+                    };
+                    readonly glob: {
+                        readonly type: "string";
+                        readonly required: true;
+                        readonly description: "Glob pattern matching the files to which the global transformation is applied.";
+                    };
+                };
+                readonly description: "Global transformation to apply over the files matched by the glob pattern.";
+            };
+        };
+    }];
+    readonly description: "A single build step: run commands, extract files or apply a global transformation.";
+}>;
+export type BuilderEntry = typeof BuilderEntry.infer;
+export declare namespace BuilderEntry { }
+export declare const Builder: Schema<{
+    readonly type: "array";
+    readonly default: never[];
+    readonly items: {
+        readonly type: "union";
+        readonly required: true;
+        readonly union: readonly [{
+            readonly type: "object";
+            readonly required: true;
+            readonly keys: {
+                readonly maxTimeMs: {
+                    readonly type: "number";
+                    readonly default: 60000;
+                    readonly minimum: -1;
+                    readonly description: "Maximum execution time for the run step in milliseconds. A value of -1 disables the limit.";
+                };
+                readonly allowFails: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                    readonly description: "Whether failed commands within the step are tolerated. Defaults to false.";
+                };
+                readonly run: {
+                    readonly type: "union";
+                    readonly required: true;
+                    readonly union: readonly [{
+                        readonly type: "string";
+                    }, {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    }];
+                    readonly description: "Shell command or list of shell commands to execute.";
+                };
+            };
+        }, {
+            readonly type: "object";
+            readonly required: true;
+            readonly keys: {
+                readonly extract: {
+                    readonly type: "union";
+                    readonly required: true;
+                    readonly union: readonly [{
+                        readonly type: "string";
+                    }, {
+                        readonly type: "object";
+                        readonly required: true;
+                        readonly additional: {
+                            readonly type: "union";
+                            readonly required: true;
+                            readonly union: readonly [{
+                                readonly type: "string";
+                                readonly required: true;
+                            }, {
+                                readonly type: "object";
+                                readonly required: true;
+                                readonly keys: {
+                                    readonly to: {
+                                        readonly type: "string";
+                                        readonly required: true;
+                                        readonly description: "Destination folder to which the matched files are copied. A relative path is resolved against the project root, an absolute one is used as it stands.";
+                                    };
+                                    readonly map: {
+                                        readonly type: "union";
+                                        readonly union: readonly [{
+                                            readonly type: "string";
+                                        }, {
+                                            readonly type: "object";
+                                            readonly keys: {
+                                                readonly search: {
+                                                    readonly type: "string";
+                                                    readonly required: true;
+                                                    readonly description: "The regular expression pattern to search for in the file content.";
+                                                };
+                                                readonly flags: {
+                                                    readonly type: "string";
+                                                    readonly default: "g";
+                                                    readonly pattern: RegExp;
+                                                    readonly description: "Flags applied to the regular expression search. Defaults to \"g\" (global).";
+                                                };
+                                                readonly replace: {
+                                                    readonly type: "string";
+                                                    readonly required: true;
+                                                    readonly description: "The replacement string used to substitute the matches found by the search pattern.";
+                                                };
+                                            };
+                                        }];
+                                        readonly required: false;
+                                        readonly description: "Transformation applied to the destination path of the extracted files.";
+                                    };
+                                    readonly transform: {
+                                        readonly type: "union";
+                                        readonly union: readonly [{
+                                            readonly type: "string";
+                                        }, {
+                                            readonly type: "object";
+                                            readonly keys: {
+                                                readonly search: {
+                                                    readonly type: "string";
+                                                    readonly required: true;
+                                                    readonly description: "The regular expression pattern to search for in the file content.";
+                                                };
+                                                readonly flags: {
+                                                    readonly type: "string";
+                                                    readonly default: "g";
+                                                    readonly pattern: RegExp;
+                                                    readonly description: "Flags applied to the regular expression search. Defaults to \"g\" (global).";
+                                                };
+                                                readonly replace: {
+                                                    readonly type: "string";
+                                                    readonly required: true;
+                                                    readonly description: "The replacement string used to substitute the matches found by the search pattern.";
+                                                };
+                                            };
+                                        }];
+                                        readonly required: false;
+                                        readonly description: "Transformation applied to the content of the extracted files.";
+                                    };
+                                };
+                            }];
+                        };
+                        readonly description: "Mapping of source glob patterns, relative to the folder the pipeline works in, to extraction entries, each describing where and how files are extracted.";
+                    }];
+                    readonly description: "Destination folder for the extracted files or an extraction mapping.";
+                };
+            };
+        }, {
+            readonly type: "object";
+            readonly required: true;
+            readonly keys: {
+                readonly transform: {
+                    readonly type: "object";
+                    readonly required: true;
+                    readonly keys: {
+                        readonly search: {
+                            readonly type: "string";
+                            readonly required: true;
+                            readonly description: "The regular expression pattern to search for in the file content.";
+                        };
+                        readonly flags: {
+                            readonly type: "string";
+                            readonly default: "g";
+                            readonly pattern: RegExp;
+                            readonly description: "Flags applied to the regular expression search. Defaults to \"g\" (global).";
+                        };
+                        readonly replace: {
+                            readonly type: "string";
+                            readonly required: true;
+                            readonly description: "The replacement string used to substitute the matches found by the search pattern.";
+                        };
+                        readonly glob: {
+                            readonly type: "string";
+                            readonly required: true;
+                            readonly description: "Glob pattern matching the files to which the global transformation is applied.";
+                        };
+                    };
+                    readonly description: "Global transformation to apply over the files matched by the glob pattern.";
+                };
+            };
+        }];
+        readonly description: "A single build step: run commands, extract files or apply a global transformation.";
+    };
+    readonly description: "Ordered pipeline of build steps applied when a dependency is built.";
+}>;
+export type Builder = typeof Builder.infer;
+export declare namespace Builder { }
+export default Builder;

package/dist/schema/Config/Builder.js

@@ -0,0 +1,78 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>.
+ * @description Schema definitions for build steps: run, extract and transform entries.
+ * @license Apache-2.0
+ */
+import Schema from '@netfeez/schema';
+import { GlobalTransform } from './Transform.js';
+import Extractor from './Extractor.js';
+import Defaults from '../Defaults.js';
+export const RunEntry = new Schema({
+    type: 'object',
+    required: true,
+    keys: {
+        maxTimeMs: {
+            type: 'number',
+            default: 60000,
+            minimum: -1,
+            description: 'Maximum execution time for the run step in milliseconds. A value of -1 disables the limit.'
+        },
+        allowFails: {
+            type: 'boolean',
+            default: false,
+            description: 'Whether failed commands within the step are tolerated. Defaults to false.'
+        },
+        run: {
+            type: 'union',
+            required: true,
+            union: [
+                { type: 'string' },
+                { type: 'array', items: { type: 'string' } }
+            ],
+            description: 'Shell command or list of shell commands to execute.'
+        }
+    }
+});
+export const ExtractEntry = new Schema({
+    type: 'object',
+    required: true,
+    keys: {
+        extract: {
+            type: 'union',
+            required: true,
+            union: [
+                { type: 'string' },
+                Extractor.definition
+            ],
+            description: 'Destination folder for the extracted files or an extraction mapping.'
+        }
+    }
+});
+export const TransformEntry = new Schema({
+    type: 'object',
+    required: true,
+    keys: {
+        transform: {
+            ...GlobalTransform.definition,
+            description: 'Global transformation to apply over the files matched by the glob pattern.'
+        }
+    }
+});
+export const BuilderEntry = new Schema({
+    type: 'union',
+    required: true,
+    union: [
+        RunEntry.definition,
+        ExtractEntry.definition,
+        TransformEntry.definition
+    ],
+    description: 'A single build step: run commands, extract files or apply a global transformation.'
+});
+export const Builder = new Schema({
+    type: 'array',
+    get default() { return Defaults.array(); },
+    items: BuilderEntry.definition,
+    description: 'Ordered pipeline of build steps applied when a dependency is built.'
+});
+export default Builder;
+//# sourceMappingURL=Builder.js.map

package/dist/schema/Config/Builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Builder.js","sourceRoot":"","sources":["../../../src/schema/Config/Builder.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAEtC,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC;IAC/B,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE;QACF,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,CAAC,CAAC;YACX,WAAW,EAAE,4FAA4F;SAC5G;QACD,UAAU,EAAE;YACR,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,WAAW,EAAE,2EAA2E;SAC3F;QACD,GAAG,EAAE;YACD,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE;gBACH,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAClB,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;aAC/C;YACD,WAAW,EAAE,qDAAqD;SACrE;KACJ;CACJ,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC;IACnC,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE;QACF,OAAO,EAAE;YACL,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE;gBACH,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAClB,SAAS,CAAC,UAAU;aACvB;YACD,WAAW,EAAE,sEAAsE;SACtF;KACJ;CACJ,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,MAAM,CAAC;IACrC,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE;QACF,SAAS,EAAE;YACP,GAAG,eAAe,CAAC,UAAU;YAC7B,WAAW,EAAE,4EAA4E;SAC5F;KACJ;CACJ,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC;IACnC,IAAI,EAAE,OAAO;IACb,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE;QACH,QAAQ,CAAC,UAAU;QACnB,YAAY,CAAC,UAAU;QACvB,cAAc,CAAC,UAAU;KAC5B;IACD,WAAW,EAAE,oFAAoF;CACpG,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC;IAC9B,IAAI,EAAE,OAAO;IACb,IAAI,OAAO,KAAK,OAAO,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC1C,KAAK,EAAE,YAAY,CAAC,UAAU;IAC9B,WAAW,EAAE,qEAAqE;CACrF,CAAC,CAAC;AAIH,eAAe,OAAO,CAAC"}