ApiLogicServer 14.3.0__py3-none-any.whl → 14.3.7__py3-none-any.whl

api_logic_server_cli/prototypes/genai_demo/logic/readme_declare_logic.md

@@ -0,0 +1,172 @@
+This describes how to use Logic; for more information, [see here](https://apilogicserver.github.io/Docs/Logic-Why).
+
+> Key Takeway -  Logic: Multi-table Derivation and Constraint Rules, Extensible with Python 
+<br>Rules are:
+<br>1. **Declared** in your IDE - 40X more concise
+<br>2. **Activated** on server start
+<br>3. **Executed** - *automatically* -  on updates (using SQLAlchemy events)
+<br>4. **Debugged** in your IDE, and with the console log
+<br>For more on rules, [click here](https://apilogicserver.github.io/Docs/Logic-Why/).
+
+&nbsp;
+
+## Examples      
+Examples from tutorial project:
+* Examples drawn from [tutorial project](https://github.com/ApiLogicServer/demo/blob/main/logic/declare_logic.py)
+* Use Shift + "." to view in project mode
+
+You can [find the rules here](https://apilogicserver.github.io/Docs/Logic).  Below, we explore the syntax of 3 typical rules.
+
+&nbsp;
+
+### 1. Multi-Table Derivations
+
+This declares the Customer.Balance as the sum of the unshipped Order.AmountTotal:
+
+```python
+    Rule.sum(derive=models.Customer.Balance,
+            as_sum_of=models.Order.AmountTotal,
+            where=lambda row: row.ShippedDate is None)
+```
+It means the rule engine **watches** for these changes:
+* Order inserted/deleted, or
+* AmountTotal or ShippedDate or CustomerID changes
+
+Iff changes are detected, the engine **reacts** by *adjusting* the Customer.Balance.  SQLs are [optimized](#declarative-logic-important-notes).
+
+This would **chain** to check the Customers' Constraint rule, described below.
+
+&nbsp;
+
+### 2. Constraints: lambda or function
+
+Constraints are multi-field conditions which must be true for transactions to succeed (else an exception is raised).  You can express the condition as a lambda or a function:
+
+**As a lambda:**
+```python
+    Rule.constraint(validate=models.Customer,
+        as_condition=lambda row: row.Balance <= row.CreditLimit,  # parent references are supported
+        error_msg="balance ({row.Balance}) exceeds credit ({row.CreditLimit})")
+```
+
+**Or, as a function:**
+```python
+    def check_balance(row: models.Customer, old_row: models.Customer, logic_row: LogicRow):
+        if logic_row.ins_upd_dlt != "dlt":  # see also: logic_row.old_row
+            return row.Balance <= row.CreditLimit
+        else:
+            return True
+
+    Rule.constraint(validate=models.Customer,
+        calling=check_balance,
+        error_msg=f"balance ({row.Balance}) exceeds credit ({row.CreditLimit})")
+```
+
+&nbsp;
+
+### 3. Row Events: Extensible with Python
+
+Events are procedural Python code, providing extensibility for declarative rules:
+```python
+    def congratulate_sales_rep(row: models.Order, old_row: models.Order, logic_row: LogicRow):
+        pass  # event code here - sending email, messages, etc.
+
+    Rule.commit_row_event(on_class=models.Order, calling=congratulate_sales_rep)
+```
+Note there are multiple kinds of events, so you can control whether they run before or after rule execution.  For more information, [see here](https://apilogicserver.github.io/Docs/Logic-Type-Constraint).
+
+&nbsp;
+
+## LogicRow: old_row, verb, etc
+
+A key argument to functions is `logic_row`:
+
+* **Wraps row and old_row,** plus methods for insert, update and delete - rule enforcement
+
+* **Additional instance variables:** ins_upd_dlt, nest_level, session, etc.
+
+* **Helper Methods:** are_attributes_changed, set_same_named_attributes, get_parent_logic_row(role_name), get_derived_attributes, log, is_inserted, etc
+
+Here is an example:
+
+```python
+"""
+    STATE TRANSITION LOGIC, using old_row
+"""
+def raise_over_20_percent(row: models.Employee, old_row: models.Employee, logic_row: LogicRow):
+    if logic_row.ins_upd_dlt == "upd" and row.Salary > old_row.Salary:
+        return row.Salary >= Decimal('1.20') * old_row.Salary
+    else:
+        return True
+
+Rule.constraint(validate=models.Employee,
+                calling=raise_over_20_percent,
+                error_msg="{row.LastName} needs a more meaningful raise")
+```
+
+Note the `log` method, which enables you to write row/old_row into the log with a short message:
+
+```python
+logic_row.log("no manager for this order's salesrep")
+```
+
+&nbsp;
+
+## Declarative Logic: Important Notes
+
+Logic *declarative*, which differs from conventional *procedural* logic:
+
+1. **Automatic Invocation:** you don't call the rules; they execute in response to updates (via SQLAlchemy events).
+
+2. **Automatic Ordering:** you don't order the rules; execution order is based on system-discovered depencencies.
+
+3. **Automatic Optimizations:** logic is optimized to reduce SQLs.
+
+    * Rule execution is *pruned* if dependent attributes are not altered
+    * SQL is optimized, e.g., `sum` rules operate by *adjustment*, not expensive SQL `select sum`
+
+These simplify maintenance / iteration: you can be sure new logic is always called, in the correct order.
+
+&nbsp;
+
+## Debugging
+
+Debug rules using **system-generated logic log** and your **IDE debugger**; for more information, [see here](https://apilogicserver.github.io/Docs/Logic-Use).
+
+&nbsp;
+
+### Using the debugger
+
+Use the debugger as shown below.  Note you can stop in lambda functions.
+
+![Logic Debugger](https://apilogicserver.github.io/Docs/images/logic/logic-debug.png)
+
+&nbsp;
+
+### Logic Log
+
+Logging is performed using standard Python logging, with a logger named `logic_logger`.  Use `info` for tracing, and `debug` for additional information (e.g., all declared rules are logged).
+
+In addition, the system logs all rules that fire, to aid in debugging.  Referring the the screen shot above:
+
+*   Each line represents a rule execution, showing row state (old/new values), and the _{reason}_ that caused the update (e.g., client, sum adjustment)
+*   Log indention shows multi-table chaining
+
+&nbsp;
+
+## How Logic works
+
+*Activation* occurs in `api_logic_server_run.py`:
+```python
+    LogicBank.activate(session=session, activator=declare_logic, constraint_event=constraint_handler)
+```
+
+This installs the rule engine as a SQLAlchemy event listener (`before_flush`).  So, Logic *runs* automatically, in response to transaction commits (typically via the API).
+
+Rules plug into SQLAlchemy events, and execute as follows:
+
+| Logic Phase | Why It Matters |
+|:-----------------------------|:---------------------|
+| **Watch** for changes at the attribute level | Performance - Automatic Attribute-level Pruning |
+| **React** by recomputing value | Ensures Reuse - Invocation is automatic<br>Derivations are optimized (e.g. *adjustment updates* - not aggregate queries) |
+| **Chain** to other referencing data | Simplifies Maintenance - ordering is automatic<br>Multi-table logic automation |

api_logic_server_cli/prototypes/genai_demo/ui/admin/admin.yaml

@@ -1,109 +1,142 @@
 about:
-  date: January 27, 2024 16:41:35
-  merged:
-    at: January 28, 2024 13:17:27
-    new_attributes: 'Product.CarbonNeutral '
-    new_resources: ''
-    new_tab_groups: ''
+  date: February 02, 2025 11:44:16
   recent_changes: works with modified safrs-react-admin
   version: 0.0.0
 api_root: '{http_type}://{swagger_host}:{port}/{api}'
-authentication:
-  endpoint: '{http_type}://{swagger_host}:{port}/api/auth/login'
+authentication: '{system-default}'
 info:
   number_relationships: 3
   number_tables: 4
+info_toggle_checked: true
 resources:
   Customer:
     attributes:
-    - label: ' Customer Name*'
-      name: CustomerName
-      required: true
+    - label: ' name*'
+      name: name
       search: true
       sort: true
-    - name: Address
-    - name: Phone
-    - name: Balance
-    - name: CreditLimit
-      required: true
-    - name: CustomerID
+    - name: balance
+      type: DECIMAL
+    - name: credit_limit
+      type: DECIMAL
+    - name: id
+    description: Represents a customer in the system with unique name, balance, and
+      credit limit attributes.
+    info_list: Represents a customer in the system with unique name, balance, and
+      credit limit attributes.
     tab_groups:
     - direction: tomany
       fks:
-      - CustomerID
+      - customer_id
       name: OrderList
       resource: Order
     type: Customer
-    user_key: CustomerName
+    user_key: name
   Item:
     attributes:
-    - label: ' Item I D*'
-      name: ItemID
+    - label: ' id*'
+      name: id
       search: true
       sort: true
-    - name: OrderID
-    - name: ProductID
-    - name: Quantity
+    - name: order_id
+    - name: product_id
+    - name: quantity
       required: true
-    - name: UnitPrice
-    - name: Amount
+    - name: unit_price
+      type: DECIMAL
+    - name: amount
+      type: DECIMAL
+    description: Represents an item in an order, including quantity and pricing details.
+    info_list: Represents an item in an order, including quantity and pricing details.
     tab_groups:
     - direction: toone
       fks:
-      - OrderID
-      name: Order
+      - order_id
+      name: order
       resource: Order
     - direction: toone
       fks:
-      - ProductID
-      name: Product
+      - product_id
+      name: product
       resource: Product
     type: Item
-    user_key: ItemID
+    user_key: id
   Order:
     attributes:
-    - label: ' Order I D*'
-      name: OrderID
+    - label: ' id*'
+      name: id
       search: true
       sort: true
-    - name: CustomerID
-    - name: OrderDate
-    - name: Notes
-    - name: ShipDate
-    - name: AmountTotal
+    - name: customer_id
+    - name: amount_total
+      type: DECIMAL
+    - name: notes
+    - name: date_shipped
+      type: DATE
+    description: Represents an order made by a customer, including a notes field.
+    info_list: Represents an order made by a customer, including a notes field.
     tab_groups:
     - direction: tomany
       fks:
-      - OrderID
+      - order_id
       name: ItemList
       resource: Item
     - direction: toone
       fks:
-      - CustomerID
-      name: Customer
+      - customer_id
+      name: customer
       resource: Customer
     type: Order
-    user_key: OrderID
+    user_key: id
   Product:
     attributes:
-    - label: ' Product Name*'
-      name: ProductName
-      required: true
+    - label: ' name*'
+      name: name
       search: true
       sort: true
-    - name: UnitPrice
-      required: true
-    - name: ProductID
-    - name: CarbonNeutral
-      type: Boolean
+    - name: unit_price
+      type: DECIMAL
+    - name: carbon_neutral
+      type: BOOLEAN
+    - name: id
+    description: Represents a product available in the system with a unit price.
+    info_list: Represents a product available in the system with a unit price.
     tab_groups:
     - direction: tomany
       fks:
-      - ProductID
+      - product_id
       name: ItemList
       resource: Item
     type: Product
-    user_key: ProductName
+    user_key: name
 settings:
-  HomeJS: http://localhost:5656/admin-app/home.js
+  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: '0'
+    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: OntimizeEE
+    startSessionPath: /auth/login
+    style: light
+    thousand_separator: ','
+    use_keycloak: 'false'

api_logic_server_cli/prototypes/manager/.vscode/launch.json

@@ -730,7 +730,7 @@
             "id": "runProjectName",
             "type": "promptString",
             "description": "Project Name (folder) to run",
-            "default": "samples/nw"
+            "default": "genai_demo"
         },
         {
             "id": "inputGenaiProjectName",

api_logic_server_cli/prototypes/manager/README.md

@@ -109,7 +109,7 @@ als genai --using=system/genai/examples/genai_demo/genai_demo.prompt --project-n
 
 
 ```bash
-als genai --repaired-response=system/genai/examples/genai_demo/genai_demo_iteration/005_create_db_models.response-example --project-name=genai_demo
+als genai --repaired-response=system/genai/examples/genai_demo/genai_demo.response_example --project-name=genai_demo
 ```
 
 Verify it's operating properly:

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo.prompt

@@ -4,13 +4,16 @@ Include a notes field for orders.
 
 Use LogicBank to enforce business logic.
 
-Use case: Check Credit
+Use case: Check Credit    
     1. The Customer's balance is less than the credit limit
     2. The Customer's balance is the sum of the Order amount_total where date_shipped is null
     3. The Order's amount_total is the sum of the Item amount
     4. The Item amount is the quantity * unit_price
     5. The Item unit_price is copied from the Product unit_price
 
+Use case: App Integration
+    1. Send the Order to Kafka topic 'order_shipping' if the date_shipped is not None.
+
 Ensure each customer has a unique name.
 
 Ensure each Item quantity is not null.

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo.response_example

@@ -60,25 +60,32 @@
             "use_case": "Store the Item.unit_price as a copy from Product.unit_price",
             "entity": "Item",
             "code": "Rule.copy(derive=Item.unit_price, from_parent=Product.unit_price)"
+        },
+        {
+            "name": "Order Kafka Integration",
+            "description": "Sends the order to Kafka topic 'order_shipping' if the date shipped is not None.",
+            "use_case": "App Integration",
+            "entity": "Order",
+            "code": "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\"})"
         }
     ],
     "test_data": "Insert test data into the tables with values compatible with the derived logic.",
     "test_data_rows": [
         {
             "test_data_row_variable": "test_customer_1",
-            "code": "test_customer_1 = Customer(name='Customer 1', balance=300, credit_limit=1000)"
+            "code": "test_customer_1 = Customer(name='Customer 1', balance=150, credit_limit=1000)"
         },
         {
             "test_data_row_variable": "test_customer_2",
-            "code": "test_customer_2 = Customer(name='Customer 2', balance=500, credit_limit=750)"
+            "code": "test_customer_2 = Customer(name='Customer 2', balance=275, credit_limit=750)"
         },
         {
             "test_data_row_variable": "test_customer_3",
-            "code": "test_customer_3 = Customer(name='Customer 3', balance=0, credit_limit=1500)"
+            "code": "test_customer_3 = Customer(name='Customer 3', balance=150, credit_limit=1500)"
         },
         {
             "test_data_row_variable": "test_customer_4",
-            "code": "test_customer_4 = Customer(name='Customer 4', balance=200, credit_limit=1200)"
+            "code": "test_customer_4 = Customer(name='Customer 4', balance=0, credit_limit=1200)"
         },
         {
             "test_data_row_variable": "test_order_1",
@@ -86,11 +93,11 @@
         },
         {
             "test_data_row_variable": "test_order_2",
-            "code": "test_order_2 = Order(customer_id=2, notes='Order 2 notes', amount_total=0)"
+            "code": "test_order_2 = Order(customer_id=2, notes='Order 2 notes', amount_total=225)"
         },
         {
             "test_data_row_variable": "test_order_3",
-            "code": "test_order_3 = Order(customer_id=2, notes='Order 3 notes', amount_total=0)"
+            "code": "test_order_3 = Order(customer_id=2, notes='Order 3 notes', amount_total=50)"
         },
         {
             "test_data_row_variable": "test_order_4",
@@ -102,11 +109,11 @@
         },
         {
             "test_data_row_variable": "test_item_2",
-            "code": "test_item_2 = Item(order_id=2, product_id=2, quantity=2, unit_price=0, amount=0)"
+            "code": "test_item_2 = Item(order_id=2, product_id=2, quantity=2, unit_price=25, amount=50)"
         },
         {
             "test_data_row_variable": "test_item_3",
-            "code": "test_item_3 = Item(order_id=3, product_id=3, quantity=1, unit_price=0, amount=0)"
+            "code": "test_item_3 = Item(order_id=3, product_id=3, quantity=3, unit_price=75, amount=225)"
         },
         {
             "test_data_row_variable": "test_item_4",

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_informal.prompt

@@ -11,6 +11,9 @@ Use case: Check Credit
     4. The Item amount is the quantity * unit_price
     5. The Item unit_price is copied from the Product unit_price
 
+Use case: App Integration
+    1. Send the Order to Kafka topic 'order_shipping' if the date_shipped is not None.
+
 Ensure each customer has a unique name.
 
 Ensure each Item quantity is not null.

api_logic_server_cli/prototypes/manager/system/genai/examples/time_tracking_billing/readme.md

@@ -1,8 +1,61 @@
-This example illustrates that it's often a good idea to be more specific in the prompt, 
-for example to specify exact table and column names.  Here, we create a time-tracking system, being specific about tables and columns in the [002_create_db_models.prompt](./).
+# Time Tracking and Billing 
+ Here, we create a time-tracking system, being specific about tables and columns in the [002_create_db_models.prompt](./).  Each table has additional attributes that are used to hold sums, counts, and formula.  Each table has a Use Case definition that describes the business logic using natural language.  
 
-To create this system:
+## Command Line - create this system:
 ```bash
-# create the time_tracking system
-als genai --project-name=track --using=system/genai/examples/time_tracking_billing/002_create_db_models.prompt
+# create the time_track system
+$als genai --project-name=time_track --using=system/genai/examples/time_tracking_billing/002_create_db_models.prompt
+```
+
+## Review the created system
+Open the time_track in VSCode or CodeSpaces and start the ApiLogicServer (F5). This will start the server and the react-admin site (http://localhost:5656). You should see Client, Project, Task, Timesheet, Person, and Invoice with sample data generated by WebGenAI.  
+
+## Review the Logic
+The /logic directory contains the generated logic (/logic/wg_rules).  This will show how natural language is translated into LogicBank rules (/logic/wg_rules/active_rules_export.py). The other rules[n].py in the wg_rules folder are used and tested by WebGenAI and can be ignored.
+
+```
+    # Exported Rules:
+    # Rule 1 
+    # Total Hours entered is sum of timesheet hours worked
+    Rule.sum(derive=Person.total_hours_entered, as_sum_of=Timesheet.hours_worked)
+    
+```
+
+## Add Security and Enable Defaults
+The authentication service can be added using the command line
+```
+$als add-auth --provider-type=sql # Local SQLIte
+$als add-auth --provider-type=keycloak # Local KeyCloak (see docs)
+$als add-auth --provider-type=sql --db-url={database config} # Use SQL database User/Role
+```
+To ensure defaults are applied (impacts rules) we need to add a global environment variable in the environment and restart the application.
+ALL_DEFAULTS=True
+
+## Add Ontimize Application
+To create an angular Ontimize application, you need to follow these steps.  Note the name 'app' is your project name which you can change or create another project.
+```
+$cd timetrack
+$als app-create --app=app #if the ui/app folder does not exist
+$als app-build --app=app # generates pages from the API entities
+$cd ui/app
+
+$npm install && npm start  # install and start the NodeJS/Angular app
+
+# Launch your new Ontimize application (http://localhost:4299)
+
+```
+
+## Testing Time Tracker and Billing
+You can delete the existing sample data or you can start by entering new data.  To test the logic - follow these steps:
+```
+1. Enter new Client
+2. Enter new Person (works for Client)
+3. Enter new Project for client (enter billing rate)
+4. Enter new Task for Project
+5. Enter new Timesheet - enter task and person for client (enter hours worked)
+
+Watch Rules fired in log and then review the sums, counts, formula and constraints.
+Note: The Client total amount should be the same value as Project, Task, and Timesheet.
+
+Bonus: Enter an Invoice for a Client/Project then add Invoice Item for a specific Client Task. Once the invoice is ready - we can add a new Event (logic) to send to Kafka.
 ```

api_logic_server_cli/prototypes/manager/system/genai/learning_requests/logic_bank_api.prompt

@@ -1,6 +1,6 @@
 Here is the simplified API for LogicBank:
 
-Create a function called declare_logic(), consisting of calls to Rule methods.
+Translate the user prompt into a series of calls to Rule methods, described here.
 
 Do not generate import statements.
 
@@ -126,6 +126,20 @@ class Rule:
         return Copy(derive=derive, from_parent=from_parent)
 
 
+    @staticmethod
+    def after_flush_row_event(on_class: object, calling: Callable = None,
+                              if_condition: any = None,
+                              when_condition: any = None,
+                              with_args: dict = None):
+
+        Example:
+            Prompt:
+                Send the Order to Kafka topic 'order_shipping' if the date_shipped is not None
+            Response:
+                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"})
+
 Expanded example:
 
 Prompt:

api_logic_server_cli/sqlacodegen_wrapper/sqlacodegen/sqlacodegen/codegen.py

@@ -480,6 +480,7 @@ class ManyToOneRelationship(Relationship):
                 parent_accessor_from_fk = True
             else:
                 self.preferred_name = inflect_engine.singular_noun(tablename) or tablename
+            # TODO - consider using the target class name as the preferred name (lower case fk -> a_child.parent)
 
         
         # Add uselist=False to One-to-One relationships
@@ -1512,7 +1513,7 @@ else:
                 child_accessor = f'    {child_accessor_name} : Mapped[List["{reln.source_cls}"]] = '\
                                  f'relationship({multi_reln_fix}back_populates="{reln.parent_accessor_name}")\n'
 
-                if model.name in ["Employee", "CharacterClass"]:  # Emp has Department and Department1
+                if model.name in ["Item", "Employee", "CharacterClass"]:  # Emp has Department and Department1
                     debug_str = "nice breakpoint"  # DND CharacterClass - check parent acceossor (class_ not class)
                 model.rendered_parent_relationships += parent_accessor
                 parent_model.rendered_child_relationships += child_accessor

api_logic_server_cli/prototypes/genai_demo/database/chatgpt/sample_ai.chatgpt

@@ -1,16 +0,0 @@
-
-Create a sqlite database for customers, orders, items and product
-
-Hints: use autonum keys, allow nulls, Decimal types, foreign keys, no check constraints.
-
-Include a notes field for orders.
-
-Create a few rows of only customer and product data.
-
-Enforce the Check Credit requirement (do not generate check constraints):
-
-1. Customer.Balance <= CreditLimit
-2. Customer.Balance = Sum(Order.AmountTotal where date shipped is null)
-3. Order.AmountTotal = Sum(Items.Amount)
-4. Items.Amount = Quantity * UnitPrice
-5. Store the Items.UnitPrice as a copy from Product.UnitPrice