depflow 3.0.0-dev.10 → 3.0.0-dev.12

package/dist/schema/Config/Dependency.js

@@ -0,0 +1,80 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>.
+ * @description Schema definitions for git and npm dependencies.
+ * @license Apache-2.0
+ */
+import Schema from '@netfeez/schema';
+import Builder from './Builder.js';
+import Resolver from './Resolver.js';
+import Defaults from '../Defaults.js';
+export var DependencyName;
+(function (DependencyName) {
+    /**
+     * The identities the flow folder reserves for itself, declared once so no source can claim them.
+     */
+    const RESERVED = 'schema\\.json|node_modules';
+    /** A `user/repo` identity or a single segment: the identity of a git source, also the name of its checkout folder. */
+    DependencyName.GIT = new RegExp(`^(?!(?:${RESERVED})(?:/|$))[A-Za-z0-9][A-Za-z0-9._-]*(?:/[A-Za-z0-9][A-Za-z0-9._-]*)?$`);
+    /** A package name, optionally scoped: the identity of an npm source. */
+    DependencyName.NPM = new RegExp(`^(?!(${RESERVED})$)@?[A-Za-z0-9][A-Za-z0-9._~-]*(/[A-Za-z0-9][A-Za-z0-9._~-]*)?$`);
+})(DependencyName || (DependencyName = {}));
+export const GitDependency = new Schema({
+    type: 'object',
+    keys: {
+        name: {
+            type: 'string',
+            required: true,
+            pattern: DependencyName.GIT,
+            description: 'Unique name used to reference the dependency in flows and path aliases. It is an identity, not an arbitrary path: a `<user>/<repo>` pair or a single alphanumeric segment.'
+        },
+        repo: {
+            type: 'string',
+            required: true,
+            description: 'Git repository URL to clone the dependency from.'
+        },
+        tag: {
+            type: 'string',
+            default: 'main',
+            description: 'Git tag, branch or commit to check out after cloning. Defaults to "main".'
+        },
+        builder: {
+            ...Builder.definition,
+            get default() { return Defaults.array(); },
+            description: 'Build pipeline applied after cloning the repository.'
+        },
+        resolver: {
+            ...Resolver.definition,
+            get default() { return Defaults.record(); },
+            description: 'Target resolution used to rewrite the dependency paths.'
+        }
+    }
+});
+export const NpmDependency = new Schema({
+    type: 'object',
+    keys: {
+        name: {
+            type: 'string',
+            required: true,
+            pattern: DependencyName.NPM,
+            description: 'NPM package name to install, optionally scoped.'
+        },
+        version: {
+            type: 'string',
+            required: true,
+            description: 'NPM package version or semver range to install.'
+        },
+        builder: {
+            ...Builder.definition,
+            get default() { return Defaults.array(); },
+            description: 'Build pipeline applied after installing the package.'
+        },
+        resolver: {
+            ...Resolver.definition,
+            get default() { return Defaults.record(); },
+            description: 'Target resolution used to rewrite the dependency paths.'
+        }
+    }
+});
+export const Dependency = { GitDependency, NpmDependency };
+export default Dependency;
+//# sourceMappingURL=Dependency.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Dependency.js","sourceRoot":"","sources":["../../../src/schema/Config/Dependency.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAEtC,MAAM,KAAW,cAAc,CAa9B;AAbD,WAAiB,cAAc;IAE3B;;OAEG;IACH,MAAM,QAAQ,GAAG,4BAA4B,CAAC;IAE9C,sHAAsH;IACzG,kBAAG,GAAW,IAAI,MAAM,CAAC,UAAU,QAAQ,sEAAsE,CAAC,CAAC;IAEhI,wEAAwE;IAC3D,kBAAG,GAAW,IAAI,MAAM,CAAC,QAAQ,QAAQ,kEAAkE,CAAC,CAAC;AAE9H,CAAC,EAbgB,cAAc,KAAd,cAAc,QAa9B;AAGD,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,MAAM,CAAC;IACpC,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE;QACF,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,cAAc,CAAC,GAAG;YAC3B,WAAW,EAAE,4KAA4K;SAC5L;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,kDAAkD;SAClE;QACD,GAAG,EAAE;YACD,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,MAAM;YACf,WAAW,EAAE,2EAA2E;SAC3F;QACD,OAAO,EAAE;YACL,GAAG,OAAO,CAAC,UAAU;YACrB,IAAI,OAAO,KAAK,OAAO,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC1C,WAAW,EAAE,sDAAsD;SACtE;QACD,QAAQ,EAAE;YACN,GAAG,QAAQ,CAAC,UAAU;YACtB,IAAI,OAAO,KAAK,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC3C,WAAW,EAAE,yDAAyD;SACzE;KACJ;CACJ,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,MAAM,CAAC;IACpC,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE;QACF,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,cAAc,CAAC,GAAG;YAC3B,WAAW,EAAE,iDAAiD;SACjE;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,iDAAiD;SACjE;QACD,OAAO,EAAE;YACL,GAAG,OAAO,CAAC,UAAU;YACrB,IAAI,OAAO,KAAK,OAAO,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC1C,WAAW,EAAE,sDAAsD;SACtE;QACD,QAAQ,EAAE;YACN,GAAG,QAAQ,CAAC,UAAU;YACtB,IAAI,OAAO,KAAK,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC3C,WAAW,EAAE,yDAAyD;SACzE;KACJ;CACJ,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,aAAa,EAAE,aAAa,EAAE,CAAC;AAK3D,eAAe,UAAU,CAAC"}

package/{build → dist}/schema/Config/Extractor.d.ts

@@ -1,59 +1,73 @@
-import { Schema } from '@netfeez/common';
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>.
+ * @description Schema definitions for file extraction mappings from source globs.
+ * @license Apache-2.0
+ */
+import Schema from '@netfeez/schema';
 export declare const ExtractorEntry: Schema<{
     readonly type: "object";
     readonly required: true;
-    readonly properties: {
+    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 required: false;
             readonly type: "union";
-            readonly union: [{
+            readonly union: readonly [{
                 readonly type: "string";
             }, {
                 readonly type: "object";
-                readonly properties: {
+                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 required: false;
             readonly type: "union";
-            readonly union: [{
+            readonly union: readonly [{
                 readonly type: "string";
             }, {
                 readonly type: "object";
-                readonly properties: {
+                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.";
         };
     };
 }>;
@@ -62,71 +76,81 @@ export declare namespace ExtractorEntry { }
 export declare const Extractor: Schema<{
     readonly type: "object";
     readonly required: true;
-    readonly allowAdditionalProperties: {
+    readonly additional: {
         readonly type: "union";
         readonly required: true;
-        readonly union: [{
+        readonly union: readonly [{
             readonly type: "string";
             readonly required: true;
         }, {
             readonly type: "object";
             readonly required: true;
-            readonly properties: {
+            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 required: false;
                     readonly type: "union";
-                    readonly union: [{
+                    readonly union: readonly [{
                         readonly type: "string";
                     }, {
                         readonly type: "object";
-                        readonly properties: {
+                        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 required: false;
                     readonly type: "union";
-                    readonly union: [{
+                    readonly union: readonly [{
                         readonly type: "string";
                     }, {
                         readonly type: "object";
-                        readonly properties: {
+                        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.";
 }>;
 export type Extractor = typeof Extractor.infer;
 export declare namespace Extractor { }

package/dist/schema/Config/Extractor.js

@@ -0,0 +1,43 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>.
+ * @description Schema definitions for file extraction mappings from source globs.
+ * @license Apache-2.0
+ */
+import Schema from '@netfeez/schema';
+import Transform from './Transform.js';
+export const ExtractorEntry = new Schema({
+    type: 'object',
+    required: true,
+    keys: {
+        to: {
+            type: 'string',
+            required: true,
+            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.'
+        },
+        map: {
+            ...Transform.definition,
+            required: false,
+            description: 'Transformation applied to the destination path of the extracted files.'
+        },
+        transform: {
+            ...Transform.definition,
+            required: false,
+            description: 'Transformation applied to the content of the extracted files.'
+        }
+    }
+});
+export const Extractor = new Schema({
+    type: 'object',
+    required: true,
+    additional: {
+        type: 'union',
+        required: true,
+        union: [
+            { type: 'string', required: true },
+            ExtractorEntry.definition
+        ]
+    },
+    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.'
+});
+export default Extractor;
+//# sourceMappingURL=Extractor.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Extractor.js","sourceRoot":"","sources":["../../../src/schema/Config/Extractor.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAEvC,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,MAAM,CAAC;IACrC,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE;QACF,EAAE,EAAE;YACA,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,uJAAuJ;SACvK;QACD,GAAG,EAAE;YACD,GAAG,SAAS,CAAC,UAAU;YACvB,QAAQ,EAAE,KAAK;YACf,WAAW,EAAE,wEAAwE;SACxF;QACD,SAAS,EAAE;YACP,GAAG,SAAS,CAAC,UAAU;YACvB,QAAQ,EAAE,KAAK;YACf,WAAW,EAAE,+DAA+D;SAC/E;KACJ;CACJ,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,MAAM,CAAC;IAChC,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE;QACR,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE;YACH,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;YAClC,cAAc,CAAC,UAAU;SAC5B;KACJ;IACD,WAAW,EAAE,0JAA0J;CAC1K,CAAC,CAAC;AAGH,eAAe,SAAS,CAAC"}

package/{build → dist}/schema/Config/Resolver.d.ts

@@ -1,16 +1,24 @@
-import { Schema } from '@netfeez/common';
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>.
+ * @description Schema definitions for dependency resolution targets: local, type and cdn.
+ * @license Apache-2.0
+ */
+import Schema from '@netfeez/schema';
 export declare const TargetOptions: Schema<{
     readonly type: "object";
-    readonly properties: {
+    readonly keys: {
         readonly local: {
             readonly type: "string";
             readonly required: true;
+            readonly description: "Local path or glob pattern the dependency resolves to.";
         };
         readonly type: {
             readonly type: "string";
+            readonly description: "Optional identifier describing the resolution type.";
         };
         readonly cdn: {
             readonly type: "string";
+            readonly description: "CDN URL used when the dependency is resolved in CDN mode.";
         };
     };
 }>;
@@ -19,51 +27,60 @@ export declare namespace TargetOptions { }
 export declare const Target: Schema<{
     readonly type: "union";
     readonly required: true;
-    readonly union: [{
+    readonly union: readonly [{
         readonly type: "string";
     }, {
         readonly type: "object";
-        readonly properties: {
+        readonly keys: {
             readonly local: {
                 readonly type: "string";
                 readonly required: true;
+                readonly description: "Local path or glob pattern the dependency resolves to.";
             };
             readonly type: {
                 readonly type: "string";
+                readonly description: "Optional identifier describing the resolution type.";
             };
             readonly cdn: {
                 readonly type: "string";
+                readonly description: "CDN URL used when the dependency is resolved in CDN mode.";
             };
         };
     }];
+    readonly description: "Resolution target of a dependency: either a plain string or an object with local, type and cdn options.";
 }>;
 export type Target = typeof Target.infer;
 export declare namespace Target { }
 export declare const Resolver: Schema<{
     readonly type: "object";
     readonly required: true;
-    readonly default: {};
-    readonly allowAdditionalProperties: {
+    readonly default: Record<string, never>;
+    readonly additional: {
         readonly type: "union";
         readonly required: true;
-        readonly union: [{
+        readonly union: readonly [{
             readonly type: "string";
         }, {
             readonly type: "object";
-            readonly properties: {
+            readonly keys: {
                 readonly local: {
                     readonly type: "string";
                     readonly required: true;
+                    readonly description: "Local path or glob pattern the dependency resolves to.";
                 };
                 readonly type: {
                     readonly type: "string";
+                    readonly description: "Optional identifier describing the resolution type.";
                 };
                 readonly cdn: {
                     readonly type: "string";
+                    readonly description: "CDN URL used when the dependency is resolved in CDN mode.";
                 };
             };
         }];
+        readonly description: "Resolution target of a dependency: either a plain string or an object with local, type and cdn options.";
     };
+    readonly description: "Mapping of dependency names to their resolution targets (local file or CDN).";
 }>;
 export type Resolver = typeof Resolver.infer;
 export declare namespace Resolver { }

package/dist/schema/Config/Resolver.js

@@ -0,0 +1,43 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>.
+ * @description Schema definitions for dependency resolution targets: local, type and cdn.
+ * @license Apache-2.0
+ */
+import Schema from '@netfeez/schema';
+import Defaults from '../Defaults.js';
+export const TargetOptions = new Schema({
+    type: 'object',
+    keys: {
+        local: {
+            type: 'string',
+            required: true,
+            description: 'Local path or glob pattern the dependency resolves to.'
+        },
+        type: {
+            type: 'string',
+            description: 'Optional identifier describing the resolution type.'
+        },
+        cdn: {
+            type: 'string',
+            description: 'CDN URL used when the dependency is resolved in CDN mode.'
+        }
+    }
+});
+export const Target = new Schema({
+    type: 'union',
+    required: true,
+    union: [
+        { type: 'string' },
+        TargetOptions.definition
+    ],
+    description: 'Resolution target of a dependency: either a plain string or an object with local, type and cdn options.'
+});
+export const Resolver = new Schema({
+    type: 'object',
+    required: true,
+    get default() { return Defaults.record(); },
+    additional: Target.definition,
+    description: 'Mapping of dependency names to their resolution targets (local file or CDN).'
+});
+export default Resolver;
+//# sourceMappingURL=Resolver.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Resolver.js","sourceRoot":"","sources":["../../../src/schema/Config/Resolver.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAEtC,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,MAAM,CAAC;IACpC,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE;QACF,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,wDAAwD;SACxE;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qDAAqD;SACrE;QACD,GAAG,EAAE;YACD,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2DAA2D;SAC3E;KACJ;CACJ,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;IAC7B,IAAI,EAAE,OAAO;IACb,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE;QACH,EAAE,IAAI,EAAE,QAAQ,EAAE;QAClB,aAAa,CAAC,UAAU;KAC3B;IACD,WAAW,EAAE,yGAAyG;CACzH,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC;IAC/B,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,IAAI,OAAO,KAAK,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC3C,UAAU,EAAE,MAAM,CAAC,UAAU;IAC7B,WAAW,EAAE,8EAA8E;CAC9F,CAAC,CAAC;AAIH,eAAe,QAAQ,CAAC"}

package/{build → dist}/schema/Config/Transform.d.ts

@@ -1,19 +1,27 @@
-import { Schema } from '@netfeez/common';
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>.
+ * @description Schema definitions for content transformations: search pattern, flags and replacement.
+ * @license Apache-2.0
+ */
+import Schema from '@netfeez/schema';
 export declare const TransformOptions: Schema<{
     readonly type: "object";
-    readonly properties: {
+    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.";
         };
     };
 }>;
@@ -22,51 +30,60 @@ export declare namespace TransformOptions { }
 export declare const GlobalTransform: Schema<{
     readonly type: "object";
     readonly required: true;
-    readonly properties: {
+    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 applied to all files matching a glob pattern.";
 }>;
 export type GlobalTransform = typeof GlobalTransform.infer;
 export declare namespace GlobalTransform { }
 export declare const Transform: Schema<{
     readonly type: "union";
     readonly required: true;
-    readonly union: [{
+    readonly union: readonly [{
         readonly type: "string";
     }, {
         readonly type: "object";
-        readonly properties: {
+        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 description: "A transformation definition: either a plain string used as a regex pattern or an object with search, flags and replace options.";
 }>;
 export type Transform = typeof Transform.infer;
 export declare namespace Transform { }

package/dist/schema/Config/Transform.js

@@ -0,0 +1,51 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>.
+ * @description Schema definitions for content transformations: search pattern, flags and replacement.
+ * @license Apache-2.0
+ */
+import Schema from '@netfeez/schema';
+export const TransformOptions = new Schema({
+    type: 'object',
+    keys: {
+        search: {
+            type: 'string',
+            required: true,
+            description: 'The regular expression pattern to search for in the file content.'
+        },
+        flags: {
+            type: 'string',
+            default: 'g',
+            pattern: /^[gimsuy]*$/,
+            description: 'Flags applied to the regular expression search. Defaults to "g" (global).'
+        },
+        replace: {
+            type: 'string',
+            required: true,
+            description: 'The replacement string used to substitute the matches found by the search pattern.'
+        }
+    }
+});
+export const GlobalTransform = new Schema({
+    type: 'object',
+    required: true,
+    keys: {
+        glob: {
+            type: 'string',
+            required: true,
+            description: 'Glob pattern matching the files to which the global transformation is applied.'
+        },
+        ...TransformOptions.definition.keys
+    },
+    description: 'Global transformation applied to all files matching a glob pattern.'
+});
+export const Transform = new Schema({
+    type: 'union',
+    required: true,
+    union: [
+        { type: 'string' },
+        TransformOptions.definition
+    ],
+    description: 'A transformation definition: either a plain string used as a regex pattern or an object with search, flags and replace options.'
+});
+export default Transform;
+//# sourceMappingURL=Transform.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Transform.js","sourceRoot":"","sources":["../../../src/schema/Config/Transform.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,MAAM,MAAM,iBAAiB,CAAC;AAErC,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,MAAM,CAAC;IACvC,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE;QACF,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,mEAAmE;SACnF;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE,aAAa;YACtB,WAAW,EAAE,2EAA2E;SAC3F;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,oFAAoF;SACpG;KACJ;CACJ,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,MAAM,CAAC;IACtC,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE;QACF,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,gFAAgF;SAChG;QACD,GAAG,gBAAgB,CAAC,UAAU,CAAC,IAAI;KACtC;IACD,WAAW,EAAE,qEAAqE;CACrF,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,MAAM,CAAC;IAChC,IAAI,EAAE,OAAO;IACb,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE;QACH,EAAE,IAAI,EAAE,QAAQ,EAAE;QAClB,gBAAgB,CAAC,UAAU;KAC9B;IACD,WAAW,EAAE,iIAAiI;CACjJ,CAAC,CAAC;AAIH,eAAe,SAAS,CAAC"}

package/dist/schema/Defaults.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>.
+ * @description Fresh default factories for the mutable collection defaults declared by the schemas.
+ * @license Apache-2.0
+ */
+export declare namespace Defaults {
+    /**
+     * Materializes a brand new empty array. Used as the value of a `default` accessor, so every
+     * processed document receives its own array instead of sharing the one held by the schema.
+     * @returns A new empty array on every access.
+     **/
+    function array(): never[];
+    /**
+     * Materializes a brand new empty record. Used as the value of a `default` accessor, so every
+     * processed document receives its own object instead of sharing the one held by the schema.
+     * @returns A new empty record on every access.
+     **/
+    function record(): Record<string, never>;
+}
+export default Defaults;

package/dist/schema/Defaults.js

@@ -0,0 +1,24 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>.
+ * @description Fresh default factories for the mutable collection defaults declared by the schemas.
+ * @license Apache-2.0
+ */
+export var Defaults;
+(function (Defaults) {
+    /**
+     * Materializes a brand new empty array. Used as the value of a `default` accessor, so every
+     * processed document receives its own array instead of sharing the one held by the schema.
+     * @returns A new empty array on every access.
+     **/
+    function array() { return []; }
+    Defaults.array = array;
+    /**
+     * Materializes a brand new empty record. Used as the value of a `default` accessor, so every
+     * processed document receives its own object instead of sharing the one held by the schema.
+     * @returns A new empty record on every access.
+     **/
+    function record() { return {}; }
+    Defaults.record = record;
+})(Defaults || (Defaults = {}));
+export default Defaults;
+//# sourceMappingURL=Defaults.js.map

package/dist/schema/Defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Defaults.js","sourceRoot":"","sources":["../../src/schema/Defaults.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,KAAW,QAAQ,CAgBxB;AAhBD,WAAiB,QAAQ;IAErB;;;;QAII;IACJ,SAAgB,KAAK,KAAc,OAAO,EAAE,CAAC,CAAC,CAAC;IAA/B,SAAA,KAAK,QAA0B,CAAA;IAE/C;;;;QAII;IACJ,SAAgB,MAAM,KAA4B,OAAO,EAAE,CAAC,CAAC,CAAC;IAA9C,SAAA,MAAM,SAAwC,CAAA;AAElE,CAAC,EAhBgB,QAAQ,KAAR,QAAQ,QAgBxB;AAED,eAAe,QAAQ,CAAC"}