feat: create VaultVariableScope

lib/collection/vault-variable-scope.js

@@ -0,0 +1,96 @@
+const _ = require('../util').lodash,
+    VariableList = require('./variable-list').VariableList,
+    Property = require('./property').Property,
+    { VariableScope } = require('./variable-scope'),
+    VAULT_PREFIX = 'vault:';
+
+function addVaultPrefix (key) {
+    return VAULT_PREFIX + key;
+}
+
+function removeVaultPrefix (key) {
+    return key.replace(VAULT_PREFIX, '');
+}
+
+let VaultVariableScope;
+
+_.inherit((
+
+    VaultVariableScope = function PostmanVaultVariableScope (definition, layers) {
+        if (definition) {
+            definition.id = 'vault';
+        }
+
+        VaultVariableScope.super_.call(this, definition, layers);
+    }), VariableScope);
+
+
+// eslint-disable-next-line object-shorthand
+_.assign(VaultVariableScope.prototype, {
+    has: function (key) {
+        return VariableScope.prototype.has.call(this, addVaultPrefix(key));
+    },
+    get: function (key) {
+        return VariableScope.prototype.get.call(this, addVaultPrefix(key));
+    },
+    set: function (key, value, type) {
+        return VariableScope.prototype.set.call(this, addVaultPrefix(key), value, type);
+    },
+    unset: function (key) {
+        return VariableScope.prototype.unset.call(this, addVaultPrefix(key));
+    },
+    replaceIn (template) {
+        const values = new VariableList(this, this.values.toJSON().map((v) => {
+            return {
+                ...v,
+                key: removeVaultPrefix(v.key)
+            };
+        }));
+
+        if (_.isString(template) || _.isArray(template)) {
+            // convert template to object because replaceSubstitutionsIn only accepts objects
+            var result = Property.replaceSubstitutionsIn({ template }, _.concat(values, this._layers));
+
+            return result.template;
+        }
+
+        if (_.isObject(template)) {
+            return Property.replaceSubstitutionsIn(template, _.concat(values, this._layers));
+        }
+
+        return template;
+    },
+    applyMutation (instruction, key, value) {
+        if (this[instruction]) {
+            this[instruction](removeVaultPrefix(key), value);
+        }
+    }
+});
+
+_.assign(VaultVariableScope, {
+    /**
+     * Defines the name of this property for internal use.
+     *
+     * @private
+     * @readOnly
+     * @type {String}
+     *
+     * @note that this is directly accessed only in case of VariableScope from _.findValue lodash util mixin
+     */
+    _postman_propertyName: 'VaultVariableScope',
+
+    /**
+     * Check whether an object is an instance of {@link VariableScope}.
+     *
+     * @param {*} obj -
+     * @returns {Boolean}
+     */
+    isVariableScope: function (obj) {
+        return Boolean(obj) && ((obj instanceof VariableScope) ||
+            _.inSuperChain(obj.constructor, '_postman_propertyName', VariableScope._postman_propertyName));
+    }
+});
+
+module.exports = {
+    VaultVariableScope
+};

lib/index.js

@@ -28,6 +28,7 @@ module.exports = {
     Variable: require('./collection/variable').Variable,
     VariableList: require('./collection/variable-list').VariableList,
     VariableScope: require('./collection/variable-scope').VariableScope,
+    VaultVariableScope: require('./collection/vault-variable-scope').VaultVariableScope,
     ProxyConfig: require('./collection/proxy-config').ProxyConfig,
     ProxyConfigList: require('./collection/proxy-config-list').ProxyConfigList,
     Version: require('./collection/version').Version