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

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/ApiLogicServer.code-workspace

@@ -9,7 +9,7 @@
 		"workbench.editorAssociations": {
 			"*.md": "vscode.markdown.preview.editor"
 		},
-		"workbench.colorTheme": "Office Theme (Excel)",
-		"workbench.preferredLightColorTheme": "Office Theme (Excel)"
+		"workbench.colorTheme": "Office Theme (Publisher)",
+		"workbench.preferredLightColorTheme": "Office Theme (Publisher)"
 	}
 }

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

@@ -24,7 +24,7 @@
             "internalConsoleOptions": "openOnSessionStart"
         },
         {
-            "name": "  1.1  GENAI - Iterate (first, add prompt to system/genai/temp/<project>)",
+            "name": "  - 1.1  GENAI - Iterate (first, add prompt to system/genai/temp/<project>)",
             "type": "debugpy",
             "request": "launch",
             "program": "${workspaceFolder}/venv/lib/python3.12/site-packages/api_logic_server_cli/cli.py",
@@ -43,7 +43,7 @@
             "internalConsoleOptions": "openOnSessionStart"
         },
         {
-            "name": "  1.2  GENAI - Retry from repaired chatgpt response",
+            "name": "  - 1.2  GENAI - Retry from repaired chatgpt response",
             "type": "debugpy",
             "request": "launch",
             "program": "${workspaceFolder}/venv/lib/python3.12/site-packages/api_logic_server_cli/cli.py",
@@ -63,7 +63,7 @@
             "internalConsoleOptions": "openOnSessionStart"
         },
         {
-            "name": "  1.3  GENAI - Retry from repaired model",
+            "name": "  - 1.3  GENAI - Retry from repaired model",
             "type": "debugpy",
             "request": "launch",
             "program": "${workspaceFolder}/venv/lib/python3.12/site-packages/api_logic_server_cli/cli.py",
@@ -84,7 +84,7 @@
             "internalConsoleOptions": "openOnSessionStart"
         },
         {
-            "name": "  1.4  GENAI - Postgresql",
+            "name": "  - 1.4  GENAI - Postgresql",
             "type": "debugpy",
             "request": "launch",
             "program": "${workspaceFolder}/venv/lib/python3.12/site-packages/api_logic_server_cli/cli.py",
@@ -124,21 +124,7 @@
             "internalConsoleOptions": "openOnSessionStart"
         },
         {
-            "name": "  - API Logic Server Run (run project from manager)",
-            "type": "debugpy",
-            "request": "launch",
-            "cwd": "${workspaceFolder}/${input:runProjectName}",
-            "env": {
-                "PYTHONHASHSEED": "0", 
-                "APILOGICSERVER_DEBUG": "False",
-                "OPT_LOCKING": "optional"},
-            "justMyCode": false,
-            "program": "api_logic_server_run.py",
-            "redirectOutput": true,
-            "console": "integratedTerminal"
-        },
-        {
-            "name": "ApiLogicServer Create nw_sample_nocust",
+            "name": "  - ApiLogicServer Create nw_sample_nocust",
             "type": "debugpy",
             "request": "launch",
             "program": "${workspaceFolder}/venv/lib/python3.12/site-packages/api_logic_server_cli/cli.py",
@@ -157,7 +143,7 @@
             "internalConsoleOptions": "openOnSessionStart"
         },
         {
-            "name": "ApiLogicServer Create nw_sample With Customizations",
+            "name": "  - ApiLogicServer Create nw_sample With Customizations",
             "type": "debugpy",
             "request": "launch",
             "program": "${workspaceFolder}/venv/lib/python3.12/site-packages/api_logic_server_cli/cli.py",
@@ -175,6 +161,20 @@
             "console": "internalConsole",
             "internalConsoleOptions": "openOnSessionStart"
         },
+        {
+            "name": "API Logic Server Run (run project from manager)",
+            "type": "debugpy",
+            "request": "launch",
+            "cwd": "${workspaceFolder}/${input:runProjectName}",
+            "env": {
+                "PYTHONHASHSEED": "0", 
+                "APILOGICSERVER_DEBUG": "False",
+                "OPT_LOCKING": "optional"},
+            "justMyCode": false,
+            "program": "api_logic_server_run.py",
+            "redirectOutput": true,
+            "console": "integratedTerminal"
+        },
         {
             "name": "App Model Editor - Prepare",
             "type": "node",
@@ -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/002_create_db_models.prompt

@@ -1,6 +1,4 @@
-Use SQLAlchemy to create a sqlite database named system/genai/temp/create_db_models.sqlite for the following requirements. These requirements are very important!
-Requirements:
-<Requirements>
+
 Generate a project time tracking and invoice application
 
 Use these names for tables and attributes:
@@ -53,142 +51,15 @@ Formula: is_paid when invoice balance is than or equal to zero
 Task Count is count of InvoiceItem 
 Task completed count is count of InvoiceItem where is_completed is True
 Formula: is ready when Task Count is equal to Task Completed Count
+When Invoice is_ready send row to Kafka with topic 'invoice_ready'
 
 
 Use Case: InvoiceItem
 InvoiceItem task amount is copied from Task total task amount billed
-InvoiceItem is_completed is sum of Task is_completed when True
+Task is_completed is sum of InvoiceItem is_completed
 
 
 
 .
 Create at least 8 tables (models)
 .
-</Requirements>
-
-Hints: use autonum keys (for all tables - including for link/join/junction/intersection tables), allow nulls, foreign keys, no check constraints.
-
-Be sure to create classes, never tables.
-Class names are singular, and first letter is capitalized.
-
-If you create sum, count or formula Logic Bank rules, then you MUST create a corresponding column in the data model.
-
-Remember that SQLite DateTime type only accepts Python datetime and date objects as input, 
-this means you can not enter string attributes where a date or datetime object is expected.
-
-Don't install additional packages.
-Don't use the faker pip package.
-
-When creating SQLAlchemy data model classes, follow these guidelines carefully:
-* Use foreign key columns instead of relationship names for the data.  
-* Do not specify nullable unless explicitly specified.
-* Do not use unique unless explicitly specified.
-* Do not use Float unless explicitly specified.
-* Generate the classes ONLY.
-* Do NOT generate imports.
-* Do NOT generate connect statements.
-* Do NOT generate engines.
-
-Create 4 rows of test data for each table, and follow these guidelines carefully:
-* Create separate objects for each test data row, not in arrays. 
-* Be sure to initialize derived attributes for test data rows - including all sums and counts, but do not rely on Logic Bank,
-and do not generate db.execute statements.
-* Do not create arrays of test data.
-* Do not create a function to load test data.  
-* Do not print the test data. 
-* Use double quotes " for strings.
-* For test data, format dates as date(year, month, day).
-
-<responseFormat>
-class Rule(BaseModel):
-    name: str
-    description: str
-    use_case: str # specified use case or requirement name (use 'General' if missing)
-    entity: str # the entity being constrained or derived
-    code: str # logicbank rule code
-    
-class Model(BaseModel):
-    classname: str
-    code: str # sqlalchemy model code
-    sqlite_create: str # sqlite create table statement
-    description: str
-    name: str
-
-class TestDataRow(BaseModel):
-    test_data_row_variable: str  # the Python test data row variable
-    code: str  # Python code to create a test data row instance
-
-class WGResult(BaseModel):  # must match system/genai/prompt_inserts/response_format.prompt
-    # response: str # result
-    models : List[Model] # list of sqlalchemy classes in the response
-    rules : List[Rule] # list rule declarations
-    test_data: str
-    test_data_rows: List[TestDataRow]  # list of test data rows
-    test_data_sqlite: str # test data as sqlite INSERT statements
-    name: str  # suggest a short name for the project
-
-Format the response as a WGResult.
-
-</responseFormat>
-
-<responseFormat>
-
-class Rule(BaseModel):
-
-    name: str
-
-    description: str
-
-    use_case: str # specified use case or requirement name (use 'General' if missing)
-
-    entity: str # the entity being constrained or derived
-
-    code: str # logicbank rule code
-
-    
-
-class Model(BaseModel):
-
-    classname: str
-
-    code: str # sqlalchemy model code
-
-    sqlite_create: str # sqlite create table statement
-
-    description: str
-
-    name: str
-
-
-
-class TestDataRow(BaseModel):
-
-    test_data_row_variable: str  # the Python test data row variable
-
-    code: str  # Python code to create a test data row instance
-
-
-
-class WGResult(BaseModel):  # must match system/genai/prompt_inserts/response_format.prompt
-
-    # response: str # result
-
-    models : List[Model] # list of sqlalchemy classes in the response
-
-    rules : List[Rule] # list rule declarations
-
-    test_data: str
-
-    test_data_rows: List[TestDataRow]  # list of test data rows
-
-    test_data_sqlite: str # test data as sqlite INSERT statements
-
-    name: str  # suggest a short name for the project
-
-
-
-Format the response as a WGResult.
-
-
-
-</responseFormat>

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, Billing Rate 100)
+3. Enter new Project for client
+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,27 @@ 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"})
+            Prompt:
+                Send the Product to Kafka topic 'ready_to_ship' if the is_complete is True
+            Response:
+                Rule.after_flush_row_event(on_class=Product, calling=kafka_producer.send_row_to_kafka,
+                               if_condition=lambda row: row.is_complete is True,
+                               with_args={"topic": "ready_to_ship"})
+
+
 Expanded example:
 
 Prompt: