generator-jhipster
Version:
Spring Boot + Angular/React/Vue in one handy generator
218 lines (217 loc) • 8.98 kB
JavaScript
/**
* Copyright 2013-2026 the original author or authors from the JHipster project.
*
* This file is part of the JHipster project, see https://www.jhipster.tech/
* for more information.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const filterNullishValues = (value) => value != null;
const MUTATION_CONTEXT_SYMBOL = '__MutationContext__';
/**
* Copy and remove null and undefined values
* @param object
*/
export function removeFieldsWithNullishValues(object) {
return filterValue(object, filterNullishValues);
}
/**
* Copy and remove null and undefined values
* @param object
*/
function filterValue(object, customFilterValue = filterNullishValues, deep = 1) {
const clone = {};
for (const [key, value] of Object.entries(object)) {
if (customFilterValue(value)) {
if (typeof value === 'object') {
if (Array.isArray(value)) {
clone[key] = value.filter(customFilterValue);
}
else if (deep < 4) {
// Avoid recursion depth issues
clone[key] = filterValue(value, customFilterValue, deep + 1);
}
}
else {
clone[key] = value;
}
}
}
return clone;
}
/**
* Picks every field from source.
* A field with undefined value is returned for missing fields.
*/
export const pickFields = (source, fields) => Object.fromEntries(fields.map(field => [field, source[field]]));
export const DelayedMutation = '__DelayedMutation__';
export const UndefinedMutation = '__UndefinedMutation__';
const OverrideMutation = Symbol('OverrideMutation');
export const overrideMutateDataProperty = (fn) => {
fn[OverrideMutation] = true;
return fn;
};
export const dontOverrideMutateDataProperty = (fn) => {
fn[OverrideMutation] = false;
return fn;
};
class PropertyNotYetDefinedError extends Error {
constructor(property) {
super(`Property ${property} is not defined yet`);
this.name = 'PropertyNotYetDefinedError';
}
}
export const createDelayedMutationContext = (options = {}) => {
const context = {};
context[MUTATION_CONTEXT_SYMBOL] = { ...options, delayContext: {} };
return context;
};
const isMutationContext = (context) => {
return context && typeof context === 'object' && MUTATION_CONTEXT_SYMBOL in context && context[MUTATION_CONTEXT_SYMBOL] !== undefined;
};
const createNotYetDefinedProxy = (target) => new Proxy(target, {
get: (obj, prop) => {
if (prop in obj) {
return obj[prop];
}
throw new PropertyNotYetDefinedError(prop.toString());
},
});
const handleMutateDataCallback = (fn, context, { defaults }) => {
const mutationContext = isMutationContext(context);
const { autoDelay = false } = mutationContext ? (context[MUTATION_CONTEXT_SYMBOL] ?? {}) : {};
try {
return fn(autoDelay ? createNotYetDefinedProxy(context) : context, mutationContext && !defaults ?
{ delayMarker: DelayedMutation, undefinedMarker: UndefinedMutation, data: context }
: { undefinedMarker: UndefinedMutation, data: context });
}
catch (error) {
if (error instanceof PropertyNotYetDefinedError) {
return DelayedMutation;
}
throw error;
}
};
const applyDelayedMutations = (context, opts) => {
let mutationApplied = false;
const delayedContext = context[MUTATION_CONTEXT_SYMBOL].delayContext;
if (delayedContext) {
const { defaults = true, throwOnDelay = false } = opts || {};
for (const [key, value] of Object.entries(delayedContext)) {
if (key in context && context[key] !== undefined) {
delete delayedContext[key];
}
else {
let result = undefined;
for (const fn of value) {
result = handleMutateDataCallback(fn, context, { defaults });
if (result !== DelayedMutation && result !== undefined) {
break;
}
}
if (result === DelayedMutation) {
if (throwOnDelay) {
throw new Error(`Mutation for key ${key} is still delayed, passing defaults should return a valid value instead of Delay Symbol`);
}
continue;
}
else if (result === undefined) {
if (throwOnDelay) {
throw new Error(`Mutation for key ${key} is undefined, passing defaults should return a valid value`);
}
}
else if (result === UndefinedMutation) {
result = undefined;
}
delete delayedContext[key];
context[key] = result;
mutationApplied = true;
}
}
}
return mutationApplied;
};
export const finalizeMutations = (context) => {
if (isMutationContext(context)) {
while (applyDelayedMutations(context, { defaults: true })) {
// Apply mutations until there is no more mutation to apply, this is to handle mutations that depend on other mutations.
}
context[MUTATION_CONTEXT_SYMBOL].autoDelay = false;
// In case there is still delayed mutations, it means that some required properties are missing, we throw an error to avoid silent issues.
applyDelayedMutations(context, { defaults: true, throwOnDelay: true });
delete context[MUTATION_CONTEXT_SYMBOL];
}
};
/**
* Mutation properties accepts:
* - functions: receives the data and the return value is set at the data property.
* - non functions: data property will receive the property in case current value is undefined.
* - __override__ property: if set to false, functions will not override existing values.
*
* Applies each mutation object in order.
*
* Note: if data property is expected to be a function, mutation should be a function that returns the desired function.
*
* @example
* // data = { prop: 'foo-bar', prop2: 'foo2', fn: () => 'fn' }
* mutateData(
* data,
* { prop: 'foo', prop2: ({ prop }) => prop + 2, fn: () => () => 'fn' },
* { prop: ({ prop }) => prop + '-bar', prop2: 'won\'t override' },
* { __override__: false, prop: () => 'won\'t override' },
* );
*/
export function mutateData(context, ...mutations) {
if (typeof context !== 'object' || context === null || Array.isArray(context)) {
throw new Error('Context should be a non null and non array object');
}
for (let mutation of mutations) {
if (typeof mutation === 'function') {
mutation = mutation(context);
}
const override = mutation.__override__;
const mutationEntries = Object.entries(mutation).filter(([key]) => key !== '__override__');
if (mutationEntries.length === 0) {
continue;
}
for (const [key, value] of mutationEntries) {
if (typeof value === 'function') {
if ((override !== false && value[OverrideMutation] !== false) ||
!(key in context) ||
context[key] === undefined ||
value[OverrideMutation] === true) {
const result = handleMutateDataCallback(value, context, { defaults: false });
if (result === DelayedMutation) {
if (isMutationContext(context)) {
const delayed = (context[MUTATION_CONTEXT_SYMBOL].delayContext[key] ??= []);
// Last mutation should take precedence.
delayed.unshift(value);
}
else {
throw new Error(`Context should be a mutation context to use delayed mutations, missing context for key: ${key}`);
}
}
else {
context[key] = result === UndefinedMutation ? undefined : result;
}
}
}
else if (!(key in context) || context[key] === undefined || override === true) {
context[key] = value;
}
}
if (isMutationContext(context)) {
applyDelayedMutations(context, { defaults: false });
}
}
}