Release version 1.0.0 (Python)

CHANGELOG.md

@@ -5,11 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0]
+
+- **Breaking:** rename the verify result field `new_id_token_response` to `invalid_token_response`, matching the `exchange_using_token_exchange` and `admin_graphql_request` parameters. Update any code that reads this field:
+
+  ```diff
+  - result.new_id_token_response
+  + result.invalid_token_response
+  ```
+
 ## [0.1.4]
 
 - Verify the dest property is not a malicious URL before making a token exchange request
 - Reject App Proxy requests with multiple `shop` query parameters with a 401 response.
 - Refreshing a non-expiring token now returns a no-refresh-needed result instead of an error
+- Checkout UI and Customer Account UI Extension requests now return `shop` without the `https://` prefix
+- Update the README for the package
 
 ## [0.1.3]
 

shopify_app/__init__.py

@@ -130,7 +130,7 @@ def verify_pos_ui_ext_req(
             request (RequestInput): A RequestInput dict with method, headers, url, and body fields
 
         Returns:
-            ResultWithExchangeableIdToken: Verification result with ok, shop, user_id, id_token, log, response, and new_id_token_response fields
+            ResultWithExchangeableIdToken: Verification result with ok, shop, user_id, id_token, log, response, and invalid_token_response fields
         """
         return verify_pos_ui_ext_req(request, self.config)
 
@@ -158,7 +158,7 @@ def verify_admin_ui_ext_req(
             request (RequestInput): A RequestInput dict with method, headers, url, and body fields
 
         Returns:
-            ResultWithExchangeableIdToken: Verification result with ok, shop, user_id, id_token, log, response, and new_id_token_response fields
+            ResultWithExchangeableIdToken: Verification result with ok, shop, user_id, id_token, log, response, and invalid_token_response fields
         """
         return verify_admin_ui_ext_req(request, self.config)
 
@@ -173,7 +173,7 @@ def verify_app_home_req(
             app_home_patch_id_token_path (str): Path to the patch ID token page
 
         Returns:
-            ResultWithExchangeableIdToken: Verification result with ok, shop, user_id, id_token, log, response, and new_id_token_response fields
+            ResultWithExchangeableIdToken: Verification result with ok, shop, user_id, id_token, log, response, and invalid_token_response fields
         """
         return verify_app_home_req(request, self.config, app_home_patch_id_token_path)
 

shopify_app/_version.py

@@ -2,4 +2,4 @@
 
 from __future__ import annotations
 
-__version__ = "0.1.4"
+__version__ = "1.0.0"

shopify_app/types.py

@@ -272,7 +272,7 @@ class ResultWithExchangeableIdToken:
         response: Suggested HTTP response to return
         user_id: The user ID from the token's sub claim, or None on failure
         id_token: ID token details (exchangeable), or None on failure
-        new_id_token_response: Pre-built response for token refresh scenarios
+        invalid_token_response: Pre-built response for token refresh scenarios
     """
 
     ok: bool
@@ -281,7 +281,7 @@ class ResultWithExchangeableIdToken:
     response: Res
     user_id: Optional[str]
     id_token: Optional[IdTokenDetails]
-    new_id_token_response: Optional[Res]
+    invalid_token_response: Optional[Res]
 
 
 @dataclass(frozen=True)

shopify_app/verify/_non_exchangeable_id_token.py

@@ -219,7 +219,7 @@ def _verify_non_exchangeable_id_token(
 
     # Extract shop from dest claim
     dest = payload.get("dest", "")
-    shop = dest.replace(".myshopify.com", "") if dest else ""
+    shop = dest.replace("https://", "").replace(".myshopify.com", "") if dest else ""
 
     return ResultWithNonExchangeableIdToken(
         ok=True,

shopify_app/verify/admin_ui_ext.py

@@ -49,7 +49,7 @@ def verify_admin_ui_ext_req(
             response=Res(status=500, body="", headers={}),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     headers = request.get("headers")
@@ -65,7 +65,7 @@ def verify_admin_ui_ext_req(
             response=Res(status=500, body="", headers={}),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     url = request.get("url")
@@ -81,7 +81,7 @@ def verify_admin_ui_ext_req(
             response=Res(status=500, body="", headers={}),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     client_secret = config.get("client_secret", "")
@@ -116,7 +116,7 @@ def verify_admin_ui_ext_req(
                 ),
                 user_id=None,
                 id_token=None,
-                new_id_token_response=None,
+                invalid_token_response=None,
             )
 
     # Check for Authorization header
@@ -132,7 +132,7 @@ def verify_admin_ui_ext_req(
             response=Res(status=401, body="Unauthorized", headers={}),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     # Extract the Bearer token
@@ -153,7 +153,7 @@ def verify_admin_ui_ext_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     id_token = auth_header[7:]  # Remove "Bearer " prefix
@@ -204,7 +204,7 @@ def verify_admin_ui_ext_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     # Verify the audience (aud) matches the clientId
@@ -225,7 +225,7 @@ def verify_admin_ui_ext_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     # Extract shop from dest claim
@@ -250,7 +250,7 @@ def verify_admin_ui_ext_req(
             token=id_token,
             claims=payload,
         ),
-        new_id_token_response=Res(
+        invalid_token_response=Res(
             status=401,
             body="",
             headers={"X-Shopify-Retry-Invalid-Session-Request": "1"},

shopify_app/verify/app_home_req.py

@@ -91,7 +91,7 @@ def _build_patch_id_token_redirect(
         ),
         user_id=None,
         id_token=None,
-        new_id_token_response=None,
+        invalid_token_response=None,
     )
 
 
@@ -129,7 +129,7 @@ def verify_app_home_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     if app_home_patch_id_token_path == "":
@@ -148,7 +148,7 @@ def verify_app_home_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     # Validate request object
@@ -169,7 +169,7 @@ def verify_app_home_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     headers = request.get("headers")
@@ -189,7 +189,7 @@ def verify_app_home_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     client_secret = config.get("client_secret", "")
@@ -249,7 +249,7 @@ def verify_app_home_req(
                 ),
                 user_id=None,
                 id_token=None,
-                new_id_token_response=None,
+                invalid_token_response=None,
             )
         id_token = auth_header[7:]  # Remove "Bearer " prefix
 
@@ -269,7 +269,7 @@ def verify_app_home_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     payload = None
@@ -332,7 +332,7 @@ def verify_app_home_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     # Verify the audience (aud) matches the clientId
@@ -360,7 +360,7 @@ def verify_app_home_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     # Extract shop from dest claim (parse as URL and get hostname)
@@ -380,8 +380,8 @@ def verify_app_home_req(
             "Link": '<https://cdn.shopify.com>; rel="preconnect", <https://cdn.shopify.com/shopifycloud/app-bridge.js>; rel="preload"; as="script", <https://cdn.shopify.com/shopifycloud/polaris.js>; rel="preload"; as="script"',
         }
 
-    # Build new_id_token_response
-    new_id_token_response = None
+    # Build invalid_token_response
+    invalid_token_response = None
     if not has_authorization_header:
         # Document request - build patch ID token URL
         clean_query = _remove_query_param(parsed_url.query, "id_token")
@@ -394,7 +394,7 @@ def verify_app_home_req(
 
         patch_id_token_location = f"{parsed_url.scheme}://{parsed_url.netloc}{app_home_patch_id_token_path}?{patch_id_token_query}"
 
-        new_id_token_response = Res(
+        invalid_token_response = Res(
             status=302,
             body="",
             headers={
@@ -403,7 +403,7 @@ def verify_app_home_req(
         )
     else:
         # Fetch request
-        new_id_token_response = Res(
+        invalid_token_response = Res(
             status=401,
             body="",
             headers={
@@ -435,5 +435,5 @@ def verify_app_home_req(
             token=id_token,
             claims=payload,
         ),
-        new_id_token_response=new_id_token_response,
+        invalid_token_response=invalid_token_response,
     )

shopify_app/verify/pos_ui_ext.py

@@ -32,7 +32,7 @@ def verify_pos_ui_ext_req(
         config (dict): The app configuration with client_id, client_secret and optional old_client_secret
 
     Returns:
-        ResultWithExchangeableIdToken: Verification result with ok, shop, log, response, user_id, id_token, and new_id_token_response fields
+        ResultWithExchangeableIdToken: Verification result with ok, shop, log, response, user_id, id_token, and invalid_token_response fields
     """
     req = redact_http_log(request)
     # Validate request object
@@ -53,7 +53,7 @@ def verify_pos_ui_ext_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     headers = request.get("headers")
@@ -73,7 +73,7 @@ def verify_pos_ui_ext_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     url = request.get("url")
@@ -93,7 +93,7 @@ def verify_pos_ui_ext_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     client_id = config.get("client_id", "")
@@ -128,7 +128,7 @@ def verify_pos_ui_ext_req(
                 ),
                 user_id=None,
                 id_token=None,
-                new_id_token_response=None,
+                invalid_token_response=None,
             )
 
     # Check for Authorization header
@@ -148,7 +148,7 @@ def verify_pos_ui_ext_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     # Extract the Bearer token
@@ -169,7 +169,7 @@ def verify_pos_ui_ext_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     id_token = auth_header[7:]  # Remove "Bearer " prefix
@@ -223,7 +223,7 @@ def verify_pos_ui_ext_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     # Verify the audience (aud) matches clientId
@@ -244,7 +244,7 @@ def verify_pos_ui_ext_req(
             ),
             user_id=None,
             id_token=None,
-            new_id_token_response=None,
+            invalid_token_response=None,
         )
 
     # Extract shop from dest claim (format: https://shop-name.myshopify.com)
@@ -273,5 +273,5 @@ def verify_pos_ui_ext_req(
             token=id_token,
             claims=payload,
         ),
-        new_id_token_response=None,
+        invalid_token_response=None,
     )