ui-router-core
Version:
UI-Router Core: Framework agnostic, State-based routing for JavaScript Single Page Apps
197 lines • 9.46 kB
JavaScript
;
/**
* @coreapi
* @module params
*/ /** for typedoc */
var common_1 = require("../common/common");
var hof_1 = require("../common/hof");
var predicates_1 = require("../common/predicates");
var coreservices_1 = require("../common/coreservices");
var paramType_1 = require("./paramType");
/** @hidden */ var hasOwn = Object.prototype.hasOwnProperty;
/** @hidden */ var isShorthand = function (cfg) {
return ["value", "type", "squash", "array", "dynamic"].filter(hasOwn.bind(cfg || {})).length === 0;
};
/** @internalapi */
var DefType;
(function (DefType) {
DefType[DefType["PATH"] = 0] = "PATH";
DefType[DefType["SEARCH"] = 1] = "SEARCH";
DefType[DefType["CONFIG"] = 2] = "CONFIG";
})(DefType = exports.DefType || (exports.DefType = {}));
/** @hidden */
function unwrapShorthand(cfg) {
cfg = isShorthand(cfg) && { value: cfg } || cfg;
getStaticDefaultValue['__cacheable'] = true;
function getStaticDefaultValue() {
return cfg.value;
}
return common_1.extend(cfg, {
$$fn: predicates_1.isInjectable(cfg.value) ? cfg.value : getStaticDefaultValue,
});
}
/** @hidden */
function getType(cfg, urlType, location, id, paramTypes) {
if (cfg.type && urlType && urlType.name !== 'string')
throw new Error("Param '" + id + "' has two type configurations.");
if (cfg.type && urlType && urlType.name === 'string' && paramTypes.type(cfg.type))
return paramTypes.type(cfg.type);
if (urlType)
return urlType;
if (!cfg.type) {
var type = location === DefType.CONFIG ? "any" :
location === DefType.PATH ? "path" :
location === DefType.SEARCH ? "query" : "string";
return paramTypes.type(type);
}
return cfg.type instanceof paramType_1.ParamType ? cfg.type : paramTypes.type(cfg.type);
}
/**
* @internalapi
* returns false, true, or the squash value to indicate the "default parameter url squash policy".
*/
function getSquashPolicy(config, isOptional, defaultPolicy) {
var squash = config.squash;
if (!isOptional || squash === false)
return false;
if (!predicates_1.isDefined(squash) || squash == null)
return defaultPolicy;
if (squash === true || predicates_1.isString(squash))
return squash;
throw new Error("Invalid squash policy: '" + squash + "'. Valid policies: false, true, or arbitrary string");
}
/** @internalapi */
function getReplace(config, arrayMode, isOptional, squash) {
var replace, configuredKeys, defaultPolicy = [
{ from: "", to: (isOptional || arrayMode ? undefined : "") },
{ from: null, to: (isOptional || arrayMode ? undefined : "") },
];
replace = predicates_1.isArray(config.replace) ? config.replace : [];
if (predicates_1.isString(squash))
replace.push({ from: squash, to: undefined });
configuredKeys = common_1.map(replace, hof_1.prop("from"));
return common_1.filter(defaultPolicy, function (item) { return configuredKeys.indexOf(item.from) === -1; }).concat(replace);
}
/** @internalapi */
var Param = (function () {
function Param(id, type, config, location, urlMatcherFactory) {
config = unwrapShorthand(config);
type = getType(config, type, location, id, urlMatcherFactory.paramTypes);
var arrayMode = getArrayMode();
type = arrayMode ? type.$asArray(arrayMode, location === DefType.SEARCH) : type;
var isOptional = config.value !== undefined || location === DefType.SEARCH;
var dynamic = predicates_1.isDefined(config.dynamic) ? !!config.dynamic : !!type.dynamic;
var raw = predicates_1.isDefined(config.raw) ? !!config.raw : !!type.raw;
var squash = getSquashPolicy(config, isOptional, urlMatcherFactory.defaultSquashPolicy());
var replace = getReplace(config, arrayMode, isOptional, squash);
var inherit = predicates_1.isDefined(config.inherit) ? !!config.inherit : !!type.inherit;
// array config: param name (param[]) overrides default settings. explicit config overrides param name.
function getArrayMode() {
var arrayDefaults = { array: (location === DefType.SEARCH ? "auto" : false) };
var arrayParamNomenclature = id.match(/\[\]$/) ? { array: true } : {};
return common_1.extend(arrayDefaults, arrayParamNomenclature, config).array;
}
common_1.extend(this, { id: id, type: type, location: location, isOptional: isOptional, dynamic: dynamic, raw: raw, squash: squash, replace: replace, inherit: inherit, array: arrayMode, config: config });
}
Param.prototype.isDefaultValue = function (value) {
return this.isOptional && this.type.equals(this.value(), value);
};
/**
* [Internal] Gets the decoded representation of a value if the value is defined, otherwise, returns the
* default value, which may be the result of an injectable function.
*/
Param.prototype.value = function (value) {
var _this = this;
/**
* [Internal] Get the default value of a parameter, which may be an injectable function.
*/
var getDefaultValue = function () {
if (_this._defaultValueCache)
return _this._defaultValueCache.defaultValue;
if (!coreservices_1.services.$injector)
throw new Error("Injectable functions cannot be called at configuration time");
var defaultValue = coreservices_1.services.$injector.invoke(_this.config.$$fn);
if (defaultValue !== null && defaultValue !== undefined && !_this.type.is(defaultValue))
throw new Error("Default value (" + defaultValue + ") for parameter '" + _this.id + "' is not an instance of ParamType (" + _this.type.name + ")");
if (_this.config.$$fn['__cacheable']) {
_this._defaultValueCache = { defaultValue: defaultValue };
}
return defaultValue;
};
var replaceSpecialValues = function (val) {
for (var _i = 0, _a = _this.replace; _i < _a.length; _i++) {
var tuple = _a[_i];
if (tuple.from === val)
return tuple.to;
}
return val;
};
value = replaceSpecialValues(value);
return predicates_1.isUndefined(value) ? getDefaultValue() : this.type.$normalize(value);
};
Param.prototype.isSearch = function () {
return this.location === DefType.SEARCH;
};
Param.prototype.validates = function (value) {
// There was no parameter value, but the param is optional
if ((predicates_1.isUndefined(value) || value === null) && this.isOptional)
return true;
// The value was not of the correct ParamType, and could not be decoded to the correct ParamType
var normalized = this.type.$normalize(value);
if (!this.type.is(normalized))
return false;
// The value was of the correct type, but when encoded, did not match the ParamType's regexp
var encoded = this.type.encode(normalized);
return !(predicates_1.isString(encoded) && !this.type.pattern.exec(encoded));
};
Param.prototype.toString = function () {
return "{Param:" + this.id + " " + this.type + " squash: '" + this.squash + "' optional: " + this.isOptional + "}";
};
Param.values = function (params, values) {
if (values === void 0) { values = {}; }
var paramValues = {};
for (var _i = 0, params_1 = params; _i < params_1.length; _i++) {
var param = params_1[_i];
paramValues[param.id] = param.value(values[param.id]);
}
return paramValues;
};
/**
* Finds [[Param]] objects which have different param values
*
* Filters a list of [[Param]] objects to only those whose parameter values differ in two param value objects
*
* @param params: The list of Param objects to filter
* @param values1: The first set of parameter values
* @param values2: the second set of parameter values
*
* @returns any Param objects whose values were different between values1 and values2
*/
Param.changed = function (params, values1, values2) {
if (values1 === void 0) { values1 = {}; }
if (values2 === void 0) { values2 = {}; }
return params.filter(function (param) { return !param.type.equals(values1[param.id], values2[param.id]); });
};
/**
* Checks if two param value objects are equal (for a set of [[Param]] objects)
*
* @param params The list of [[Param]] objects to check
* @param values1 The first set of param values
* @param values2 The second set of param values
*
* @returns true if the param values in values1 and values2 are equal
*/
Param.equals = function (params, values1, values2) {
if (values1 === void 0) { values1 = {}; }
if (values2 === void 0) { values2 = {}; }
return Param.changed(params, values1, values2).length === 0;
};
/** Returns true if a the parameter values are valid, according to the Param definitions */
Param.validates = function (params, values) {
if (values === void 0) { values = {}; }
return params.map(function (param) { return param.validates(values[param.id]); }).reduce(common_1.allTrueR, true);
};
return Param;
}());
exports.Param = Param;
//# sourceMappingURL=param.js.map