239 lines
8.5 KiB
JavaScript
239 lines
8.5 KiB
JavaScript
import { z } from 'zod';
|
|
import * as path from 'path';
|
|
import { accessSync, constants, lstatSync, existsSync } from 'fs';
|
|
import { isString } from '@polymech/core/primitives';
|
|
import { logger } from '@/logger.js';
|
|
import { sync as exists } from '@polymech/fs/exists';
|
|
import { sync as read } from '@polymech/fs/read';
|
|
import { DEFAULT_VARS, resolve, resolveVariables } from '@/variables.js';
|
|
import { getDescription } from '@/shemas/index.js';
|
|
import { isFile } from '@/lib/fs.js';
|
|
const DefaultPathSchemaBase = z.string().describe('Path to a file or directory');
|
|
const PathErrorMessages = {
|
|
INVALID_INPUT: 'INVALID_INPUT: ${inputPath}',
|
|
PATH_DOES_NOT_EXIST: 'Path does not exist ${inputPath} = ${resolvedPath}',
|
|
DIRECTORY_NOT_WRITABLE: 'Directory is not writable ${inputPath} = ${resolvedPath}',
|
|
NOT_A_DIRECTORY: 'Path is not a directory or does not exist ${inputPath} = ${resolvedPath}',
|
|
NOT_A_JSON_FILE: 'File is not a JSON file or does not exist ${inputPath} = ${resolvedPath}',
|
|
PATH_NOT_ABSOLUTE: 'Path is not absolute ${inputPath} = ${resolvedPath}',
|
|
PATH_NOT_RELATIVE: 'Path is not relative ${inputPath} = ${resolvedPath}',
|
|
};
|
|
export var E_PATH;
|
|
(function (E_PATH) {
|
|
E_PATH[E_PATH["ENSURE_PATH_EXISTS"] = 1] = "ENSURE_PATH_EXISTS";
|
|
E_PATH[E_PATH["INVALID_INPUT"] = 2] = "INVALID_INPUT";
|
|
E_PATH[E_PATH["ENSURE_DIRECTORY_WRITABLE"] = 3] = "ENSURE_DIRECTORY_WRITABLE";
|
|
E_PATH[E_PATH["ENSURE_FILE_IS_JSON"] = 4] = "ENSURE_FILE_IS_JSON";
|
|
E_PATH[E_PATH["ENSURE_PATH_IS_ABSOLUTE"] = 5] = "ENSURE_PATH_IS_ABSOLUTE";
|
|
E_PATH[E_PATH["ENSURE_PATH_IS_RELATIVE"] = 6] = "ENSURE_PATH_IS_RELATIVE";
|
|
E_PATH[E_PATH["GET_PATH_INFO"] = 7] = "GET_PATH_INFO";
|
|
})(E_PATH = E_PATH || (E_PATH = {}));
|
|
export const Transformers = {
|
|
resolve: (val, variables = {}) => {
|
|
if (!val) {
|
|
return null;
|
|
}
|
|
return {
|
|
resolved: path.resolve(resolve(val, false, variables)),
|
|
source: val
|
|
};
|
|
},
|
|
json: (val, variables = {}) => {
|
|
if (!val) {
|
|
return null;
|
|
}
|
|
const resolved = path.resolve(resolve(isString(val) ? val : val.source, false, variables));
|
|
return {
|
|
resolved,
|
|
source: val,
|
|
value: read(resolved, 'json')
|
|
};
|
|
},
|
|
string: (val, variables = {}) => {
|
|
if (!val) {
|
|
return null;
|
|
}
|
|
let src = isString(val) ? val : val.source;
|
|
src = resolve(src, false, variables);
|
|
const resolved = path.resolve(src);
|
|
if (!exists(resolved) || !isFile(resolved)) {
|
|
return {
|
|
resolved,
|
|
source: val,
|
|
value: null
|
|
};
|
|
}
|
|
else {
|
|
let value = null;
|
|
try {
|
|
value = read(resolved, 'string');
|
|
}
|
|
catch (e) {
|
|
logger.error('Failed to read file', { resolved, source: val, error: e.message });
|
|
}
|
|
return {
|
|
resolved,
|
|
source: val,
|
|
value
|
|
};
|
|
}
|
|
}
|
|
};
|
|
export const TransformersDescription = [
|
|
{
|
|
description: 'RESOLVE_PATH',
|
|
fn: Transformers.resolve
|
|
},
|
|
{
|
|
description: 'READ_JSON',
|
|
fn: Transformers.json
|
|
},
|
|
{
|
|
description: 'READ_STRING',
|
|
fn: Transformers.string
|
|
}
|
|
];
|
|
const extendType = (type, extend, variables = {}) => {
|
|
if (Array.isArray(extend.refine)) {
|
|
for (const refine of extend.refine) {
|
|
type = type.refine(refine);
|
|
}
|
|
}
|
|
else {
|
|
type = type.refine(extend.refine);
|
|
}
|
|
if (Array.isArray(extend.transform)) {
|
|
for (const transform of extend.transform) {
|
|
type = type.transform((val) => transform(val, variables));
|
|
}
|
|
}
|
|
else {
|
|
type = type.transform(extend.transform);
|
|
}
|
|
return type;
|
|
};
|
|
const extendTypeDescription = (type, extension, variables = {}) => {
|
|
const description = getDescription(type) || '';
|
|
let transformerDescriptions = 'Transformers:\n';
|
|
if (Array.isArray(extension.transform)) {
|
|
for (const transform of extension.transform) {
|
|
transformerDescriptions += transformerDescription(transform) + '\n';
|
|
}
|
|
}
|
|
else {
|
|
transformerDescriptions += transformerDescription(extension.transform) + '\n';
|
|
}
|
|
type = type.describe(description + '\n' + transformerDescriptions);
|
|
return type;
|
|
};
|
|
const transformerDescription = (fn) => {
|
|
const description = TransformersDescription.find((t) => t.fn === fn);
|
|
return description ? description.description : 'Unknown';
|
|
};
|
|
export const extendSchema = (baseSchema, extend) => {
|
|
const baseShape = baseSchema.shape;
|
|
const extendedShape = { ...baseShape };
|
|
for (const [key, refines] of Object.entries(extend)) {
|
|
if (!baseShape[key])
|
|
continue;
|
|
let fieldSchema = baseShape[key];
|
|
if (Array.isArray(refines.refine)) {
|
|
for (const refine of refines.refine) {
|
|
fieldSchema = fieldSchema.superRefine(refine);
|
|
}
|
|
}
|
|
else {
|
|
fieldSchema = fieldSchema.superRefine(refines);
|
|
}
|
|
if (Array.isArray(refines.transform)) {
|
|
for (const transform of refines.transform) {
|
|
fieldSchema = fieldSchema.transform((val) => transform(val));
|
|
}
|
|
}
|
|
else {
|
|
fieldSchema = fieldSchema.transform(refines.transform);
|
|
}
|
|
extendedShape[key] = fieldSchema;
|
|
}
|
|
return z.object(extendedShape);
|
|
};
|
|
export const ENSURE_DIRECTORY_WRITABLE = (inputPath, ctx, variables) => {
|
|
const resolvedPath = path.resolve(resolve(inputPath, false, variables));
|
|
const parts = path.parse(resolvedPath);
|
|
if (resolvedPath && existsSync(parts.dir) && lstatSync(parts.dir).isDirectory()) {
|
|
try {
|
|
accessSync(resolvedPath, constants.W_OK);
|
|
return resolvedPath;
|
|
}
|
|
catch (e) {
|
|
ctx.addIssue({
|
|
code: E_PATH.ENSURE_DIRECTORY_WRITABLE,
|
|
message: resolveVariables(PathErrorMessages.DIRECTORY_NOT_WRITABLE, false, { inputPath, resolvedPath })
|
|
});
|
|
return z.NEVER;
|
|
}
|
|
}
|
|
else {
|
|
ctx.addIssue({
|
|
code: E_PATH.ENSURE_DIRECTORY_WRITABLE,
|
|
message: resolveVariables(PathErrorMessages.NOT_A_DIRECTORY, false, { inputPath, resolvedPath })
|
|
});
|
|
return z.NEVER;
|
|
}
|
|
};
|
|
export const IS_VALID_STRING = (inputPath) => {
|
|
return isString(inputPath);
|
|
};
|
|
export const ENSURE_PATH_EXISTS = (inputPath, ctx, variables) => {
|
|
if (!inputPath || !ctx) {
|
|
return z.NEVER;
|
|
}
|
|
if (!isString(inputPath)) {
|
|
ctx.addIssue({
|
|
code: E_PATH.INVALID_INPUT,
|
|
message: resolveVariables(PathErrorMessages.INVALID_INPUT, false, {})
|
|
});
|
|
return z.NEVER;
|
|
}
|
|
const resolvedPath = path.resolve(resolve(inputPath, false, variables));
|
|
if (!exists(resolvedPath)) {
|
|
ctx.addIssue({
|
|
code: E_PATH.ENSURE_PATH_EXISTS,
|
|
message: resolveVariables(PathErrorMessages.PATH_DOES_NOT_EXIST, false, { inputPath, resolvedPath })
|
|
});
|
|
return z.NEVER;
|
|
}
|
|
return resolvedPath;
|
|
};
|
|
export const test = () => {
|
|
const BaseCompilerOptions = () => z.object({
|
|
root: DefaultPathSchemaBase.default(`${process.cwd()}`)
|
|
});
|
|
const ret = extendSchema(BaseCompilerOptions(), {
|
|
root: {
|
|
refine: [
|
|
(val, ctx) => ENSURE_DIRECTORY_WRITABLE(val, ctx, DEFAULT_VARS({ exampleVar: 'exampleValue' })),
|
|
(val, ctx) => ENSURE_PATH_EXISTS(val, ctx, DEFAULT_VARS({ exampleVar: 'exampleValue' }))
|
|
],
|
|
transform: [
|
|
(val) => path.resolve(resolve(val, false, DEFAULT_VARS({ exampleVar: 'exampleValue' })))
|
|
]
|
|
}
|
|
});
|
|
return ret;
|
|
};
|
|
export const Templates = {
|
|
json: {
|
|
refine: [IS_VALID_STRING, ENSURE_PATH_EXISTS],
|
|
transform: [Transformers.resolve, Transformers.json]
|
|
},
|
|
string: {
|
|
refine: [ENSURE_PATH_EXISTS],
|
|
transform: [Transformers.resolve, Transformers.string]
|
|
}
|
|
};
|
|
export const extend = (baseSchema, template, variables = {}) => {
|
|
const type = extendType(baseSchema, template, variables);
|
|
return extendTypeDescription(type, template, variables);
|
|
};
|
|
//# sourceMappingURL=path.js.map
|