# Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).

from pants.base.payload import Payload
from pants.base.payload_field import PrimitiveField

from pants.contrib.node.targets.node_package import NodePackage


class NodeRemoteModule(NodePackage):
    """A remote Node module."""

    def __init__(self, version=None, address=None, payload=None, **kwargs):
        """
        :param string version: The version constraint for the remote node module.  Any of the forms
                               accepted by npm including '' or '*' for unconstrained (the default) are
                               acceptable.  See: https://docs.npmjs.com/files/package.json#dependencies
        """
        payload = payload or Payload()
        payload.add_fields(
            {"version": PrimitiveField(version or "*"),}  # Guard against/allow `None`.
        )
        super().__init__(address=address, payload=payload, **kwargs)

    @property
    def version(self):
        """The version constraint of the remote package.

        :rtype: string
        """
        return self.payload.version