ApiLogicServer 15.0.65__py3-none-any.whl → 15.1.0__py3-none-any.whl

api_logic_server_cli/prototypes/manager/samples/basic_demo/customizations/database/models.py

@@ -0,0 +1,130 @@
+# coding: utf-8
+from sqlalchemy import DECIMAL, Boolean, DateTime  # API Logic Server GenAI assist
+from sqlalchemy import Column, DECIMAL, Date, ForeignKey, Integer, String
+from sqlalchemy.orm import relationship
+from sqlalchemy.ext.declarative import declarative_base
+
+########################################################################################################################
+# Classes describing database for SqlAlchemy ORM, initially created by schema introspection.
+#
+# Alter this file per your database maintenance policy
+#    See https://apilogicserver.github.io/Docs/Project-Rebuild/#rebuilding
+#
+# Created:  May 25, 2025 19:10:32
+# Database: sqlite:////Users/val/dev/ApiLogicServer/ApiLogicServer-dev/servers/basic_demo/database/db.sqlite
+# Dialect:  sqlite
+#
+# mypy: ignore-errors
+########################################################################################################################
+ 
+from database.system.SAFRSBaseX import SAFRSBaseX, TestBase
+from flask_login import UserMixin
+import safrs, flask_sqlalchemy, os
+from safrs import jsonapi_attr
+from flask_sqlalchemy import SQLAlchemy
+from sqlalchemy.orm import relationship
+from sqlalchemy.orm import Mapped
+from sqlalchemy.sql.sqltypes import NullType
+from typing import List
+
+db = SQLAlchemy() 
+Base = declarative_base()  # type: flask_sqlalchemy.model.DefaultMeta
+metadata = Base.metadata
+
+#NullType = db.String  # datatype fixup
+#TIMESTAMP= db.TIMESTAMP
+
+from sqlalchemy.dialects.sqlite import *
+
+if os.getenv('APILOGICPROJECT_NO_FLASK') is None or os.getenv('APILOGICPROJECT_NO_FLASK') == 'None':
+    Base = SAFRSBaseX   # enables rules to be used outside of Flask, e.g., test data loading
+else:
+    Base = TestBase     # ensure proper types, so rules work for data loading
+    print('*** Models.py Using TestBase ***')
+
+
+
+class Customer(Base):  # type: ignore
+    __tablename__ = 'customer'
+    _s_collection_name = 'Customer'  # type: ignore
+
+    id = Column(Integer, primary_key=True)
+    name = Column(String)
+    balance : DECIMAL = Column(DECIMAL)
+    credit_limit : DECIMAL = Column(DECIMAL)
+    email = Column(String)
+    email_opt_out = Column(Boolean)
+    # parent relationships (access parent)
+
+    # child relationships (access children)
+    OrderList : Mapped[List["Order"]] = relationship(back_populates="customer")
+    SysEmailList : Mapped[List["SysEmail"]] = relationship(back_populates="customer")
+
+
+
+class Product(Base):  # type: ignore
+    __tablename__ = 'product'
+    _s_collection_name = 'Product'  # type: ignore
+
+    id = Column(Integer, primary_key=True)
+    name = Column(String)
+    unit_price : DECIMAL = Column(DECIMAL)
+
+    # parent relationships (access parent)
+
+    # child relationships (access children)
+    ItemList : Mapped[List["Item"]] = relationship(back_populates="product")
+
+
+class Order(Base):  # type: ignore
+    __tablename__ = 'order'
+    _s_collection_name = 'Order'  # type: ignore
+
+    id = Column(Integer, primary_key=True)
+    notes = Column(String)
+    customer_id = Column(ForeignKey('customer.id'), nullable=False)
+    CreatedOn = Column(Date)
+    date_shipped = Column(Date)
+    amount_total : DECIMAL = Column(DECIMAL)
+
+    # parent relationships (access parent)
+    customer : Mapped["Customer"] = relationship(back_populates=("OrderList"))
+
+    # child relationships (access children)
+    ItemList : Mapped[List["Item"]] = relationship(back_populates="order")
+
+
+
+class SysEmail(Base):  # type: ignore
+    __tablename__ = 'sys_email'
+    _s_collection_name = 'SysEmail'  # type: ignore
+
+    id = Column(Integer, primary_key=True)
+    message = Column(String)
+    subject = Column(String)
+    customer_id = Column(ForeignKey('customer.id'), nullable=False)
+    CreatedOn = Column(Date)
+
+    # parent relationships (access parent)
+    customer : Mapped["Customer"] = relationship(back_populates=("SysEmailList"))
+
+    # child relationships (access children)
+
+
+
+class Item(Base):  # type: ignore
+    __tablename__ = 'item'
+    _s_collection_name = 'Item'  # type: ignore
+
+    id = Column(Integer, primary_key=True)
+    order_id = Column(ForeignKey('order.id'))
+    product_id = Column(ForeignKey('product.id'), nullable=False)
+    quantity = Column(Integer, nullable=False)
+    amount : DECIMAL = Column(DECIMAL)
+    unit_price : DECIMAL = Column(DECIMAL)
+
+    # parent relationships (access parent)
+    order : Mapped["Order"] = relationship(back_populates=("ItemList"))
+    product : Mapped["Product"] = relationship(back_populates=("ItemList"))
+
+    # child relationships (access children)

api_logic_server_cli/prototypes/manager/samples/basic_demo/customizations/docs/mcp_learning/mcp_discovery.json

@@ -0,0 +1,108 @@
+{
+  "base_url": "http://localhost:5656/api",
+  "authorization_url": "http://localhost:5656/api/auth/login",
+  "description": "API Logic Project: basic_demo",
+  "learning": "To issue one request per row from a prior step (fan-out), use the syntax:\n\n\"$<stepIndex>[*].<fieldName>\"\n\nFor example, if step 0 returns orders, and you want to send a POST per customer:\n\nBefore (incorrect):\n    \"customer_id\": \"{customer_id}\"\n\nAfter (correct):\n    \"customer_id\": \"$0[*].customer_id\"\n    \nOnly if 'email' is in the Natural language query, send email by issing a POST request to the SysEmail endpoint, setting the subject, message and customer_id in the body.   DO NOT include a POST unless the word \u2018email\u2019 appears in the user query.\n\nFormat response as mcp_responseFormat.\n\n<mcp_responseFormat>\nclass QueryParam(BaseModel):\n    name: str  # attribute name\n    op: str  # eq, lt, gt\n    val: str\n\nclass JsonValues(BaseMopdel):\n    name: str  # name of attribute\n    value: str # value of attribute\n\nclass Resource(BaseModel):\n    tool_type: str\n    base_url: str\n    path: str # specified use case or requirement name (use 'General' if missing)\n    method: str # GET, PATCH, POST or DELETE\n    body: json # data for PATCH or POST\n    query_params: List(QueryParam) # filter for GET\n\nclass MCPResult(BaseModel):  # must match system/genai/prompt_inserts/response_format.prompt\n    schema_version: str\n    resources : List[Resource] # list resources\n\n<mcp_responseFormat/>\n",
+  "resources": [
+    {
+      "fields": [
+        "id",
+        "name",
+        "balance",
+        "credit_limit",
+        "email",
+        "email_opt_out"
+      ],
+      "filterable": [
+        "id",
+        "name",
+        "balance",
+        "credit_limit",
+        "email",
+        "email_opt_out"
+      ],
+      "methods": [
+        "GET",
+        "PATCH",
+        "POST",
+        "DELETE"
+      ],
+      "name": "Customer",
+      "path": "/Customer"
+    },
+    {
+      "fields": [
+        "id",
+        "order_id",
+        "product_id",
+        "quantity",
+        "amount",
+        "unit_price"
+      ],
+      "filterable": [
+        "id",
+        "order_id",
+        "product_id",
+        "quantity",
+        "amount",
+        "unit_price"
+      ],
+      "methods": [
+        "GET",
+        "PATCH",
+        "POST",
+        "DELETE"
+      ],
+      "name": "Item",
+      "path": "/Item"
+    },
+    {
+      "fields": [
+        "id",
+        "notes",
+        "customer_id",
+        "CreatedOn",
+        "date_shipped",
+        "amount_total"
+      ],
+      "filterable": [
+        "id",
+        "notes",
+        "customer_id",
+        "CreatedOn",
+        "date_shipped",
+        "amount_total"
+      ],
+      "methods": [
+        "GET",
+        "PATCH",
+        "POST",
+        "DELETE"
+      ],
+      "name": "Order",
+      "path": "/Order"
+    },
+    {
+      "fields": [
+        "id",
+        "name",
+        "unit_price"
+      ],
+      "filterable": [
+        "id",
+        "name",
+        "unit_price"
+      ],
+      "methods": [
+        "GET",
+        "PATCH",
+        "POST",
+        "DELETE"
+      ],
+      "name": "Product",
+      "path": "/Product"
+    }
+  ],
+  "schema_version": "1.0",
+  "tool_type": "json-api"
+}

api_logic_server_cli/prototypes/manager/samples/basic_demo/customizations/logic/declare_logic.py

@@ -0,0 +1,106 @@
+import datetime, os
+from decimal import Decimal
+from logic_bank.exec_row_logic.logic_row import LogicRow
+from logic_bank.extensions.rule_extensions import RuleExtension
+from logic_bank.logic_bank import Rule
+from logic_bank.logic_bank import DeclareRule
+import database.models as models
+import api.system.opt_locking.opt_locking as opt_locking
+from security.system.authorization import Grant, Security
+from logic.load_verify_rules import load_verify_rules
+import integration.kafka.kafka_producer as kafka_producer
+from integration.n8n.n8n_producer import send_n8n_message
+import logging
+
+app_logger = logging.getLogger(__name__)
+
+declare_logic_message = "ALERT:  *** No Rules Yet ***"  # printed in api_logic_server.py
+
+def declare_logic():
+    ''' Declarative multi-table derivations and constraints, extensible with Python.
+ 
+    Brief background: see readme_declare_logic.md
+    
+    Your Code Goes Here - Use code completion (Rule.) to declare rules
+    '''
+
+    if os.environ.get("WG_PROJECT"):
+        # Inside WG: Load rules from docs/expprt/export.json
+        load_verify_rules()
+    else:
+        # Outside WG: load declare_logic function
+        from logic.logic_discovery.auto_discovery import discover_logic
+        discover_logic()
+
+    # Logic from GenAI: (or, use your IDE w/ code completion)
+    from database.models import Product, Order, Item, Customer, SysEmail
+
+    # Ensure the customer's balance is less than their credit limit
+    Rule.constraint(validate=Customer, as_condition=lambda row: row.balance <= row.credit_limit, error_msg="Customer balance ({row.balance}) exceeds credit limit ({row.credit_limit})")
+
+    # Derive the customer's balance as the sum of order totals where not yet shipped.
+    Rule.sum(derive=Customer.balance, as_sum_of=Order.amount_total, where=lambda row: row.date_shipped is None)
+
+    # Derive the order's total amount from the sum of item amounts.
+    Rule.sum(derive=Order.amount_total, as_sum_of=Item.amount)
+
+    # Calculate item amount based on quantity and unit price.
+    Rule.formula(derive=Item.amount, as_expression=lambda row: row.quantity * row.unit_price)
+
+    # Copy unit price from product to item.
+    Rule.copy(derive=Item.unit_price, from_parent=Product.unit_price)
+
+    # Send order details to Kafka if order is shipped.
+    Rule.after_flush_row_event(on_class=Order, calling=kafka_producer.send_row_to_kafka, if_condition=lambda row: row.date_shipped is not None, with_args={'topic': 'order_shipping'})
+
+    # End Logic from GenAI
+    
+
+    def handle_all(logic_row: LogicRow):  # #als: TIME / DATE STAMPING, OPTIMISTIC LOCKING
+        """
+        This is generic - executed for all classes.
+
+        Invokes optimistic locking, and checks Grant permissions.
+
+        Also provides user/date stamping.
+
+        Args:
+            logic_row (LogicRow): from LogicBank - old/new row, state
+        """
+
+        if os.getenv("APILOGICPROJECT_NO_FLASK") is not None:
+            print("\ndeclare_logic.py Using TestBase\n")
+            return  # enables rules to be used outside of Flask, e.g., test data loading
+
+        if logic_row.is_updated() and logic_row.old_row is not None and logic_row.nest_level == 0:
+            opt_locking.opt_lock_patch(logic_row=logic_row)
+
+        Grant.process_updates(logic_row=logic_row)
+
+        did_stamping = False
+        if enable_stamping := True:  # #als:  DATE / USER STAMPING
+            row = logic_row.row
+            if logic_row.ins_upd_dlt == "ins" and hasattr(row, "CreatedOn"):
+                row.CreatedOn = datetime.datetime.now()
+                did_stamping = True
+            if logic_row.ins_upd_dlt == "ins" and hasattr(row, "CreatedBy"):
+                row.CreatedBy = Security.current_user().id
+                #    if Config.SECURITY_ENABLED == True else 'public'
+                did_stamping = True
+            if logic_row.ins_upd_dlt == "upd" and hasattr(row, "UpdatedOn"):
+                row.UpdatedOn = datetime.datetime.now()
+                did_stamping = True
+            if logic_row.ins_upd_dlt == "upd" and hasattr(row, "UpdatedBy"):
+                row.UpdatedBy = Security.current_user().id  \
+                    if Config.SECURITY_ENABLED == True else 'public'
+                did_stamping = True
+            if did_stamping:
+                logic_row.log("early_row_event_all_classes - handle_all did stamping")     
+    Rule.early_row_event_all_classes(early_row_event_all_classes=handle_all)
+
+    #als rules report
+    from api.system import api_utils
+    # api_utils.rules_report()
+
+    app_logger.debug("..logic/declare_logic.py (logic == rules + code)")
+

api_logic_server_cli/prototypes/manager/samples/basic_demo/customizations/logic/logic_discovery/email_request.py

@@ -0,0 +1,49 @@
+import datetime
+from decimal import Decimal
+from logic_bank.exec_row_logic.logic_row import LogicRow
+from logic_bank.extensions.rule_extensions import RuleExtension
+from logic_bank.logic_bank import Rule
+from database import models
+import api.system.opt_locking.opt_locking as opt_locking
+from security.system.authorization import Grant
+import logging
+from flask import jsonify
+
+app_logger = logging.getLogger(__name__)
+
+def declare_logic():
+    """
+        This illustrates the request pattern.
+
+        The request pattern is a common pattern in API Logic Server, 
+        where an insert into SysEmail triggers service invocation, such as sending email.
+
+        See https://apilogicserver.github.io/Docs/Integration-MCP/.
+        
+        The SysEmail table includes the columns for the email (e,g, recipient, subject, message).
+        
+        Using a request object enables you to wrap the service call with logic, eg:
+        
+        * *email requirement: do not send mail if customer has opted out*  
+
+        See: https://apilogicserver.github.io/Docs/Integration-MCP/#3a-logic-request-pattern     
+    """
+
+    def send_mail(row: models.SysEmail, old_row: models.SysEmail, logic_row: LogicRow):
+        """ 
+
+        #als: Send N8N email message
+
+        Args:
+            row (Email): inserted Email
+            old_row (Email): n/a
+            logic_row (LogicRow): bundles curr/old row, with ins/upd/dlt logic
+        """
+        if logic_row.is_inserted(): 
+            customer = row.customer  # parent accessor
+            if customer.email_opt_out:
+                logic_row.log("customer opted out of email")
+                return
+            logic_row.log(f"send email {row.message} to {customer.email} (stub, eg use N8N")  # see in log  
+
+    Rule.after_flush_row_event(on_class=models.SysEmail, calling=send_mail)  # see above

api_logic_server_cli/prototypes/manager/samples/basic_demo/customizations/logic/logic_discovery/simple_constraints.py

@@ -0,0 +1,25 @@
+import datetime
+from decimal import Decimal
+from logic_bank.exec_row_logic.logic_row import LogicRow
+from logic_bank.extensions.rule_extensions import RuleExtension
+from logic_bank.logic_bank import Rule
+from database import models
+import api.system.opt_locking.opt_locking as opt_locking
+from security.system.authorization import Grant
+import logging
+from flask import jsonify
+
+app_logger = logging.getLogger(__name__)
+
+def declare_logic():
+    """
+        Simple constraints for error testing, e.g.:
+        
+        * Set a breakpoint on `as_condition`
+        * Observe the row values in the debugger
+    """
+
+    Rule.constraint(validate=models.Customer,
+        as_condition=lambda row: row.name != 'x',
+        error_msg="Customer name cannot be 'x'")
+

api_logic_server_cli/prototypes/manager/samples/basic_demo/customizations/security/declare_security.py

@@ -0,0 +1,60 @@
+from security.system.authorization import Grant, Security, DefaultRolePermission, GlobalFilter
+from database import models
+import database
+import safrs
+import logging
+
+"""
+Illustrates declarative security - role-based authorization to database rows.
+
+* See [documentation](https://apilogicserver.github.io/Docs/Security-Overview/)
+
+* Security is invoked on server start (api_logic_server_run), per activation in `config.py`
+"""
+
+app_logger = logging.getLogger(__name__)
+
+declare_security_message = "Sample Grants Loaded"
+
+db = safrs.DB
+session = db.session
+
+
+class Roles():
+    """ Define Roles here, so can use code completion (Roles.tenant) """
+    tenant = "tenant"           # aneu, u1, u2
+    renter = "renter"           # r1
+    manager = "manager"         # u2, sam
+    sales="sales"               # s1
+
+                                # user_id = 1 -- aneu              many customers, 1 category
+                                # user_id = 2 -- u2, sam, s1, r1   3    customers, 3 categories
+
+DefaultRolePermission(to_role = Roles.tenant, can_read=True, can_delete=True)
+DefaultRolePermission(to_role = Roles.renter, can_read=True, can_delete=False)
+DefaultRolePermission(to_role = Roles.manager, can_read=True, can_delete=False)
+DefaultRolePermission(to_role = Roles.sales, can_read=True, can_delete=False)
+
+
+#############################################
+# Observe: Filters are AND'd, Grants are OR'd 
+#############################################
+
+GlobalFilter(   global_filter_attribute_name = "name",  # sales does not see Bob (yes, silly - see nw & multi-tenant))
+                roles_not_filtered = ["sa", "manager", "tenant", "renter"],     # ie, just sales
+                filter = '{entity_class}.name != \'Bob\' ')                     # poor Bob
+
+
+Grant(  on_entity = models.Customer,
+        to_role = Roles.sales,
+        filter = lambda : models.Customer.credit_limit >= 3000,
+        filter_debug = "credit_limit > 3000")                                   # this eliminates Charlie, but...
+
+Grant(  on_entity = models.Customer,
+        to_role = Roles.sales,
+        filter = lambda : models.Customer.balance > 0,
+        filter_debug = "balance > 0 (see security/declare_security.py)")        # this let's us see Charlie (grants OR'd)
+
+
+app_logger.debug("Declare Security complete - security/declare_security.py"
+    + f' -- {len(database.database_discovery.authentication_models.metadata.tables)} tables loaded')

api_logic_server_cli/prototypes/manager/samples/basic_demo/customizations/ui/admin/admin.yaml

@@ -0,0 +1,162 @@
+about:
+  date: May 26, 2025 06:57:17
+  recent_changes: works with modified safrs-react-admin
+  version: 0.0.0
+api_root: '{http_type}://{swagger_host}:{port}/{api}'
+authentication: '{system-default}'
+info:
+  number_relationships: 4
+  number_tables: 6
+info_toggle_checked: true
+resources:
+  Customer:
+    attributes:
+    - label: ' name*'
+      name: name
+      search: true
+      sort: true
+    - name: balance
+      type: DECIMAL
+    - name: credit_limit
+      type: DECIMAL
+    - name: email
+    - name: email_opt_out
+      type: Boolean
+    - name: id
+    tab_groups:
+    - direction: tomany
+      fks:
+      - customer_id
+      name: OrderList
+      resource: Order
+    - direction: tomany
+      fks:
+      - customer_id
+      name: SysEmailList
+      resource: SysEmail
+    type: Customer
+    user_key: name
+  Item:
+    attributes:
+    - label: ' id*'
+      name: id
+      search: true
+      sort: true
+    - name: order_id
+    - name: product_id
+      required: true
+    - name: quantity
+      required: true
+    - name: amount
+      type: DECIMAL
+    - name: unit_price
+      type: DECIMAL
+    tab_groups:
+    - direction: toone
+      fks:
+      - order_id
+      name: order
+      resource: Order
+    - direction: toone
+      fks:
+      - product_id
+      name: product
+      resource: Product
+    type: Item
+    user_key: id
+  Order:
+    attributes:
+    - label: ' id*'
+      name: id
+      search: true
+      sort: true
+    - name: customer_id
+      required: true
+    - name: notes
+    - name: CreatedOn
+      type: DATE
+    - name: amount_total
+      type: DECIMAL
+    - name: date_shipped
+      type: DATE
+    tab_groups:
+    - direction: tomany
+      fks:
+      - order_id
+      name: ItemList
+      resource: Item
+    - direction: toone
+      fks:
+      - customer_id
+      name: customer
+      resource: Customer
+    type: Order
+    user_key: id
+  Product:
+    attributes:
+    - label: ' name*'
+      name: name
+      search: true
+      sort: true
+    - name: unit_price
+      type: DECIMAL
+    - name: id
+    tab_groups:
+    - direction: tomany
+      fks:
+      - product_id
+      name: ItemList
+      resource: Item
+    type: Product
+    user_key: name
+  SysEmail:
+    attributes:
+    - label: ' id*'
+      name: id
+      search: true
+      sort: true
+    - name: customer_id
+      required: true
+    - name: message
+    - name: subject
+    - name: CreatedOn
+      type: DATE
+    tab_groups:
+    - direction: toone
+      fks:
+      - customer_id
+      name: customer
+      resource: Customer
+    type: SysEmail
+    user_key: id
+settings:
+  HomeJS: /admin-app/home.js
+  max_list_columns: 8
+  style_guide:
+    applicationLocales:
+    - en
+    - es
+    currency_symbol: $
+    currency_symbol_position: left
+    date_format: LL
+    decimal_max: '1000000000'
+    decimal_min: '2'
+    decimal_separator: .
+    detail_mode: tab
+    edit_on_mode: dblclick
+    exclude_listpicker: false
+    include_translation: 'false'
+    keycloak_client_id: alsclient
+    keycloak_realm: kcals
+    keycloak_url: http://localhost:8080
+    locale: en
+    max_decimal_digits: '4'
+    min_decimal_digits: '2'
+    new_mode: dialog
+    pick_style: list
+    row_height: small,
+    serviceType: JSONAPI
+    startSessionPath: /auth/login
+    style: light
+    thousand_separator: ','
+    use_keycloak: 'false'