@anvil-works/anvil-pyright 0.0.1 → 0.0.2-canary

package/dist/anvil-typeshed/client/anvil/users/mfa.pyi

@@ -0,0 +1,76 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for anvil.users.mfa module
+# Generated files: client/anvil/users/mfa.pyi, server/anvil/users/mfa.pyi
+
+from typing import Any, Literal
+
+from anvil.tables import Row
+
+def create_fido_mfa_method(email_address: str) -> Any:
+    """Generate a WebAuthn challenge that can be used to register a new hardware token for two-factor authentication."""
+    ...
+
+def get_fido_mfa_login(email_address: str, password: str) -> Any:
+    """Generate a WebAuthn challenge that the given user can use to log in with a previously registered hardware token."""
+    ...
+
+def get_totp_mfa_login(code: str) -> Any:
+    """Get an MFA login object representing a TOTP login code.
+
+    This can be passed to the login_with_email function as the mfa argument."""
+    ...
+
+def get_twilio_mfa_login(code: str) -> Any:
+    """Get an MFA login object representing a Twilio Verify token.
+
+    This can be passed to the login_with_email function as the mfa argument."""
+    ...
+
+def generate_totp_secret(email_address: str) -> dict[str, Any]:
+    """Generate a TOTP secret that can be added as two-factor authentication for the current user."""
+    ...
+
+def validate_totp_code(mfa_method: Any, code: str) -> bool:
+    """Validate the given TOTP code against the given MFA method from a User row."""
+    ...
+
+def generate_twilio_mfa_method(phone: str) -> Any:
+    """Generate a Twilio MFA method from the provided phone number."""
+    ...
+
+def send_twilio_token(mfa_method: Any, channel: Literal["sms", "call"]) -> None:
+    """Send a Twilio Verify token using the given MFA method from a User row."""
+    ...
+
+def check_twilio_token(mfa_method: Any, token: str) -> bool:
+    """Validate the given Twilio Verify token against the given MFA method from a User row."""
+    ...
+
+def add_mfa_method(password: str, mfa_method: Any, *, clear_existing: bool = False) -> None:
+    """Add an MFA method to the current user by passing the user's password and the mfa method.
+
+    Optionally clearing all existing methods."""
+    ...
+
+def get_available_mfa_types(email_address: str, password: str) -> list[str]:
+    """Get the available MFA types for the given user by passing their email and password."""
+    ...
+
+def get_enabled_mfa_types() -> list[str]:
+    """Get all the enabled MFA types for this app."""
+    ...
+
+def mfa_login_with_form(email_address: str, password: str) -> Row | None:
+    """Display a form to collect two-factor authentication credentials from the user currently logging in.
+
+    Pass the function their email and password."""
+    ...
+
+def configure_mfa_with_form(*, allow_cancel: bool = False) -> None:
+    """Display a form for the user to configure 2-factor authentication.
+
+    allow_cancel: if True, the signup form has a Cancel button that the user can use to dismiss the form."""
+    ...

package/dist/anvil-typeshed/client/stripe/__init__.pyi

@@ -0,0 +1,8 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for stripe module
+# Generated files: client/stripe/__init__.pyi, server/stripe/__init__.pyi
+
+from stripe import checkout as checkout

package/dist/anvil-typeshed/client/stripe/checkout.pyi

@@ -0,0 +1,67 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for stripe.checkout module
+# Generated files: client/stripe/checkout.pyi, server/stripe/checkout.pyi
+
+from typing import Any
+
+def get_token(
+    *,
+    amount: int,
+    currency: str,
+    title: str | None = None,
+    description: str | None = None,
+    icon_url: str | None = None,
+    billing_address: bool = False,
+    zipcode: bool = False,
+    raw: bool = False,
+) -> tuple[str, dict[str, Any]]:
+    """Show the Stripe checkout form and return a raw (token, user_details) tuple.
+
+    The token can be used to place charges from server modules.
+    The user_details are a dictionary of user-supplied data (eg 'email').
+
+    Args:
+        amount: A number, in least units of currency (eg cents or pennies).
+        currency: A three-letter currency code (eg 'USD').
+        title: Configures the checkout dialog title.
+        description: Configures the checkout dialog description.
+        icon_url: Path to an image to be used on the checkout form.
+        zipcode: Setting to True requires the user to enter their postal code.
+        billing_address: Setting to True requires the user to enter a billing address.
+        raw: Setting to True returns a token for your own API key.
+
+    [Anvil Docs](https://anvil.works/docs/integrations/stripe)"""
+    ...
+
+
+def charge(
+    *,
+    amount: int,
+    currency: str,
+    title: str | None = None,
+    description: str | None = None,
+    icon_url: str | None = None,
+    billing_address: bool = False,
+    shipping_address: bool = False,
+    zipcode: bool = False,
+) -> dict[str, Any]:
+    """Charge the user for a one-off payment by showing a Stripe checkout form.
+
+    Returns a dictionary of information about the transaction on success.
+
+    Args:
+        amount: A number, in least units of currency (eg cents or pennies).
+        currency: A three-letter currency code (eg 'USD').
+        title: Configures the checkout dialog title.
+        description: Configures the checkout dialog description.
+        icon_url: Path to an image to be used on the checkout form
+            (eg anvil.server.get_app_origin() + '/_/theme/icon.png').
+        billing_address: Setting to True requires the user to enter a billing address.
+        shipping_address: Setting to True requires the user to enter a shipping and billing address.
+        zipcode: Setting to True requires the user to enter their zipcode/postal code.
+
+    [Anvil Docs](https://anvil.works/docs/integrations/stripe)"""
+    ...

package/dist/anvil-typeshed/server/anvil/__init__.pyi

@@ -0,0 +1,148 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for Anvil
+# Generated files: client/anvil/__init__.pyi, server/anvil/__init__.pyi
+
+from typing import Any, Callable, TypeVar, overload, Iterator, Mapping, Literal
+
+_T = TypeVar("_T")
+_F = TypeVar("_F", bound=Callable[..., Any])
+
+# ============================================================================
+# Media Classes
+# ============================================================================
+
+class Media:
+    """A Media object represents binary data, such as a file.
+
+    [Anvil Docs](https://anvil.works/docs/media)"""
+
+    content_type: str
+    """The MIME type of this Media."""
+
+    name: str | None
+    """The file name associated with this Media, or None if it has no name."""
+
+    url: str | None
+    """The URL where you can download this Media, or None if it is not downloadable."""
+
+    length: int
+    """The length of this Media, in bytes."""
+
+    def get_bytes(self) -> bytes:
+        """Get a binary string of the data represented by this Media object.
+
+        [Anvil Docs](https://anvil.works/docs/media)"""
+        ...
+
+    def get_url(self) -> str | None:
+        """Get a Media object's URL, or None if there isn't one associated with it.
+
+        [Anvil Docs](https://anvil.works/docs/media)"""
+        ...
+
+
+class BlobMedia(Media):
+    """Create a Media object with the specified content_type and content.
+
+    Optionally specify a filename as well.
+
+    [Anvil Docs](https://anvil.works/docs/media)"""
+
+    def __init__(self, content_type: str, content: bytes, *, name: str | None = None) -> None: ...
+
+
+class URLMedia(Media):
+    """Create a Media object representing the data at a specific URL.
+
+    Caution: Getting data from URLs directly in your code will often fail
+    for security reasons, or fail to handle binary data.
+
+    [Anvil Docs](https://anvil.works/docs/media)"""
+
+    def __init__(self, url: str, /) -> None: ...
+
+
+# ============================================================================
+# App Information
+# ============================================================================
+
+class AppEnvironment:
+    """Information about the current app environment."""
+
+    name: str
+    """The name of the current environment."""
+
+    tags: list[str]
+    """Tags associated with the current environment."""
+
+
+class AppInfo:
+    """Information about the current app.
+
+    [Anvil Docs](https://anvil.works/docs/deployment/environment-variables)"""
+
+    id: str
+    """A unique identifier for the current app."""
+
+    branch: str
+    """The Git branch from which the current app is being run.
+
+    This is 'master' for development apps or apps without a published version,
+    and 'published' if this app is being run from its published version."""
+
+    package_name: str
+    """The package name of this app."""
+
+    environment: AppEnvironment
+    """The environment in which the current app is being run."""
+
+    theme_colors: Mapping[str, str]
+    """Theme colors for this app as a readonly dict."""
+
+    def get_asset(self, path: str | None = None) -> Media:
+        """Get an asset file from the app's theme assets."""
+        ...
+
+    def get_client_config(self, package_name: str | None = None) -> dict[str, Any]:
+        """Get the client config for the specified package.
+
+        If no package name is specified, the client config for the current app is returned."""
+        ...
+
+    def get_server_config(self, package_name: str | None = None) -> dict[str, Any]:
+        """Get the server config for the specified package.
+
+        If no package name is specified, the server config for the current app is returned."""
+        ...
+
+
+app: AppInfo
+"""Information about the current app, as an instance of AppInfo."""
+
+
+# ============================================================================
+# Utility Functions
+# ============================================================================
+
+def is_server_side() -> bool:
+    """Check whether Anvil is running server side or not."""
+    ...
+
+
+# ============================================================================
+# Server-Only: Secrets Access
+# ============================================================================
+
+class _Secrets:
+    """Access to app secrets.
+
+    [Anvil Docs](https://anvil.works/docs/deployment/secrets)"""
+
+    def get_secret(self, name: str) -> str | None: ...
+    def __getattr__(self, name: str) -> str | None: ...
+
+
+secrets: _Secrets

package/dist/anvil-typeshed/server/anvil/email.pyi

@@ -0,0 +1,188 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+"""The `anvil.email` module contains functions for sending and receiving email in your Anvil app.
+
+[Anvil Docs](https://anvil.works/docs/email)"""
+
+from typing import Callable, TypeVar, overload
+
+from anvil import Media
+
+# TypeVar for email handler functions
+_MessageHandler = TypeVar("_MessageHandler", bound=Callable[["Message"], None])
+
+
+class SendFailure(Exception):
+    """Raised when sending an email fails."""
+    ...
+
+
+class DeliveryFailure(Exception):
+    """While handling an error, you can raise a DeliveryFailure exception to reject email delivery.
+
+    Optionally, you may specify a message and SMTP error code with the rejection.
+
+    [Anvil Docs](https://anvil.works/docs/email/sending_and_receiving#rejecting-email)"""
+
+    def __init__(self, message: str | None = None, smtp_code: int = 554) -> None: ...
+
+
+class Address:
+    """Represents an email address."""
+    address: str
+    """The email address this object represents."""
+    name: str
+    """The name associated with the address this object represents."""
+    raw_value: str
+    """The full string value of this address."""
+
+
+class SendReport:
+    """Report returned after sending an email."""
+    message_id: str
+    """The Message-ID header given to this outgoing message."""
+
+
+class Message:
+    """Represents an incoming email message.
+
+    [Anvil Docs](https://anvil.works/docs/email/incoming)"""
+
+    class Envelope:
+        """The sender and recipient of an email, according to the SMTP envelope."""
+        from_address: str
+        """The email address from which this message was sent, according to the SMTP envelope."""
+        recipient: str
+        """The email address that received this message.
+
+        Note that this email address may not appear in any of the headers (eg if the email has been BCCed or blind forwarded)."""
+
+    class DKIM:
+        """Object describing whether a message was signed by the sending domain."""
+        valid_from_sender: bool
+        """Was this message signed by the domain in its envelope "from" address?"""
+        domains: list[str]
+        """A list of the DKIM domains that signed this message."""
+
+    class Addressees:
+        """The addresses an email was sent from and to, according to the headers."""
+        to_addresses: list[Address]
+        """The addresses this message was sent to."""
+        from_address: Address | None
+        """The address this message was sent from."""
+        cc_addresses: list[Address]
+        """The addresses this message was copied to."""
+
+    envelope: Envelope
+    """The sender and recipient of this email, according to the SMTP envelope."""
+    dkim: DKIM
+    """Object describing whether this message was signed by the sending domain."""
+    addressees: Addressees
+    """The addresses this email was sent from and to, according to the headers."""
+    headers: list[tuple[str, str]]
+    """All the headers in this email, as a list of (name, value) pairs."""
+    text: str | None
+    """The plain-text content of this email, or None if there is no plain-text part."""
+    subject: str | None
+    """The subject of this email, or None if there is no subject."""
+    html: str | None
+    """The HTML content of this email, or None if there is no HTML part."""
+    attachments: list[Media]
+    """A list of this email's attachments."""
+    inline_attachments: dict[str, Media]
+    """A dictionary of this email's inline attachments. Keys are ContentID headers, values are the attachments as Media Objects."""
+
+    def get_header(self, header_name: str, default: str | None = None) -> str | None:
+        """Return the value of the specified header, or default value if it is not present.
+
+        Case-insensitive. If the header is specified multiple times, returns the first value."""
+        ...
+
+    def list_header(self, header_name: str) -> list[str]:
+        """Return a list containing every value of the specified header. Case-insensitive."""
+        ...
+
+    def reply(
+        self,
+        *,
+        to: str | list[str] | None = None,
+        cc: str | list[str] | None = None,
+        bcc: str | list[str] | None = None,
+        from_address: str | None = None,
+        from_name: str | None = None,
+        subject: str | None = None,
+        text: str | None = None,
+        html: str | None = None,
+        attachments: list[Media] | None = None,
+    ) -> SendReport:
+        """Reply to this email."""
+        ...
+
+
+def send(
+    *,
+    to: str | list[str] | None = None,
+    cc: str | list[str] | None = None,
+    bcc: str | list[str] | None = None,
+    from_address: str = "no-reply",
+    from_name: str | None = None,
+    subject: str | None = None,
+    text: str | None = None,
+    html: str | None = None,
+    attachments: list[Media] | None = None,
+    inline_attachments: dict[str, Media] | None = None,
+) -> SendReport:
+    """Send an email.
+
+    Args:
+        to: The email recipient[s] in the 'To' field. Can be a string or list of strings.
+            Each string can be a bare address (eg 'joe@example.com') or include a display name (eg 'Joe Bloggs <joe@example.com>').
+        cc: The email recipient[s] in the 'Cc' field. Can be a string or list of strings.
+        bcc: The email recipient[s] in the 'Bcc' field. Can be a string or list of strings.
+        from_address: The From: address from this email. If no domain is specified, or the specified domain is not a legal sending domain for this app, the address will be replaced with a valid domain.
+        from_name: The name associated with the From: address for this email. (Only valid if the from_address is a bare email address.)
+        subject: The subject line for this email.
+        text: The plain-text (no HTML) content for this email. You must specify at least one of 'text' and 'html'.
+        html: The HTML content for this email. You must specify at least one of 'text' and 'html'.
+        attachments: A list of Media objects to send as attachments with this email.
+        inline_attachments: Inline attachments that can be used in this email's HTML, for example in <img> tags. Must be a dictionary whose keys are IDs and values are Media objects. IDs can then be used in a message's HTML with 'cid:xxx' URIs.
+
+    [Anvil Docs](https://anvil.works/docs/email)"""
+    ...
+
+
+@overload
+def handle_message(fn: _MessageHandler) -> _MessageHandler:
+    """Decorator to handle incoming emails.
+
+    [Anvil Docs](https://anvil.works/docs/email/incoming)"""
+    ...
+
+
+@overload
+def handle_message(*, require_dkim: bool = False) -> Callable[[_MessageHandler], _MessageHandler]:
+    """Decorator to handle incoming emails.
+
+    Args:
+        require_dkim: If True, reject emails without a valid DKIM signature from the sender.
+
+    [Anvil Docs](https://anvil.works/docs/email/incoming)"""
+    ...
+
+
+def handle_message(
+    fn: _MessageHandler | None = None, require_dkim: bool = False
+) -> _MessageHandler | Callable[[_MessageHandler], _MessageHandler]:
+    """Decorator to handle incoming emails.
+
+    Can be used with or without arguments:
+    - `@anvil.email.handle_message` - handle all incoming emails
+    - `@anvil.email.handle_message(require_dkim=True)` - only handle emails with valid DKIM
+
+    Args:
+        require_dkim: If True, reject emails without a valid DKIM signature from the sender.
+
+    [Anvil Docs](https://anvil.works/docs/email/incoming)"""
+    ...

package/dist/anvil-typeshed/server/anvil/facebook/__init__.pyi

@@ -0,0 +1,8 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for anvil.facebook module
+# Generated files: client/anvil/facebook/__init__.pyi, server/anvil/facebook/__init__.pyi
+
+from anvil.facebook import auth as auth

package/dist/anvil-typeshed/server/anvil/facebook/auth.pyi

@@ -0,0 +1,27 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for anvil.facebook.auth module
+# Generated files: client/anvil/facebook/auth.pyi, server/anvil/facebook/auth.pyi
+
+
+def get_user_email() -> str | None:
+    """Get the email address of the currently-logged-in Facebook user.
+
+    To log in with Facebook, call facebook.auth.login() from form code."""
+    ...
+
+def get_user_id() -> str | None:
+    """Get the Facebook user ID of the currently-logged-in Facebook user.
+
+    To log in with Facebook, call facebook.auth.login() from form code."""
+    ...
+
+def get_user_access_token() -> str | None:
+    """Get the Facebook access token of the currently-logged-in Facebook user.
+
+    To log in with Facebook, call facebook.auth.login() from form code.
+
+    [Anvil Docs](https://anvil.works/docs/integrations/facebook)"""
+    ...

package/dist/anvil-typeshed/server/anvil/files.pyi

@@ -0,0 +1,53 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for anvil.files module
+# Generated files: server/anvil/files.pyi
+
+from typing import IO, Any
+
+class OpenContextManager:
+    """Context manager for opening data files."""
+
+    def __enter__(self) -> IO[Any]:
+        """Open the file."""
+        ...
+    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+        """Close the file, uploading its contents if it was opened for writing or appending."""
+        ...
+
+class EditingContextManager:
+    """Context manager for editing data files."""
+
+    def __enter__(self) -> str:
+        """Begin editing the file. Returns the path to a temporary file."""
+        ...
+    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+        """End editing the file, uploading its new contents."""
+        ...
+
+class Files:
+    """Access to Data Files from the Data Files Service.
+
+    To access a file stored in the Data Files Service use square brackets
+    containing the path of the desired file - `data_files['<file_path>']`."""
+
+    def __getitem__(self, path: str) -> str:
+        """Return the path of a file."""
+        ...
+    def editing(self, path: str) -> EditingContextManager:
+        """Edit a file.
+
+        To ensure the proper acquisition and release of the file, use the `editing`
+        function in a `with` statement e.g. `with data_files.editing('test.txt') as file:`"""
+        ...
+    def open(self, path: str, mode: str = "r") -> OpenContextManager:
+        """The open() function opens the file (if possible) and returns the corresponding file object."""
+        ...
+
+data_files: Files
+"""Access Data Files from the Data Files Service.
+
+To access a file stored in the Data Files Service use square brackets
+containing the path of the desired file - `data_files['<file_path>']`."""

package/dist/anvil-typeshed/server/anvil/google/__init__.pyi

@@ -0,0 +1,11 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for anvil.google module
+# Generated files: client/anvil/google/__init__.pyi, server/anvil/google/__init__.pyi
+
+from anvil.google import auth as auth
+from anvil.google import drive as drive
+from anvil.google import mail as mail
+from anvil.google import sheets as sheets

package/dist/anvil-typeshed/server/anvil/google/auth.pyi

@@ -0,0 +1,31 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for anvil.google.auth module
+# Generated files: client/anvil/google/auth.pyi, server/anvil/google/auth.pyi
+
+
+def get_user_email() -> str | None:
+    """Get the email address of the currently-logged-in Google user.
+
+    To log in with Google, call anvil.google.auth.login() from form code."""
+    ...
+
+def get_user_access_token() -> str | None:
+    """Get the secret access token of the currently-logged-in Google user, for use with the Google REST API.
+
+    Requires this app to have its own Google client ID and secret."""
+    ...
+
+def get_user_refresh_token() -> str | None:
+    """Get the secret refresh token of the currently-logged-in Google user, for use with the Google REST API.
+
+    Requires this app to have its own Google client ID and secret."""
+    ...
+
+def refresh_access_token(refresh_token: str, /) -> str:
+    """Get a new access token from a refresh token you have saved, for use with the Google REST API.
+
+    Requires this app to have its own Google client ID and secret."""
+    ...