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

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/admin/admin_loader.py

@@ -0,0 +1,217 @@
+""" flask event handlers for the admin app
+        * return minified app
+        * return admin.yaml file
+"""
+
+import logging, sys, io
+from flask import Flask, redirect, send_from_directory, send_file
+from config.config import Config
+from config.config import Args
+from pathlib import Path
+import os, inspect
+from safrs import ValidationError
+
+admin_logger = logging.getLogger(__name__)  # log levels: critical < error < warning(20) < info(30) < debug
+
+did_send_spa = False
+
+def get_sra_directory(args: Args) -> str:
+    """
+    return location of minified sra, which can be...
+
+    1. in the venv (from install or Docker) -- the normal case (small projects, less git)
+    2. local to project: ui/safrs-react-admin
+    3. in env(APILOGICSERVER_HOME | APILOGICPROJECT_APILOGICSERVER_HOME)
+        * eg, ...ApiLogicServer/venv/lib/python3.12/site-packages
+    
+    This enables the sra code to be re-used, reducing app size 32MB -> 2.5 MB
+    """
+    admin_logger.debug("get_sra_directory - finding sra")
+    directory = os.environ.get("APILOGICPROJECT_SRA", 'ui/safrs-react-admin')  # local project sra typical API Logic Server path (index.yaml)
+    if Path(directory).joinpath('robots.txt').is_file():
+        admin_logger.debug("return_spa - using local directory")
+    else:        # else use installed sra - from venv, or, for dev, in APILOGICSERVER_HOME
+        try:     # works for installed, docker, codespaces.  not Azure
+            from api_logic_server_cli.create_from_model import api_logic_server_utils as api_logic_server_utils
+        except:  # should not occur normally (means: venv does not include cli)
+            dev_home = os.getenv('APILOGICSERVER_HOME')
+            if dev_home:
+                admin_logger.debug("ApiLogicServer not in venv, trying APILOGICSERVER_HOME")
+            else:
+                dev_home = args.api_logic_server_home
+                if dev_home:
+                    admin_logger.debug("ApiLogicServer not in venv, trying APILOGICPROJECT_APILOGICSERVER_HOME")
+                else:
+                    dev_home = os.getenv('HOME')
+                    if not dev_home:
+                        raise Exception('ApiLogicServer not in venv, env APILOGICSERVER_HOME or HOME must be set')
+            sys.path.append(dev_home)
+            try:
+                from api_logic_server_cli.create_from_model import api_logic_server_utils as api_logic_server_utils
+            except:
+                raise Exception('\n\nWrong venv (ApiLogicServer not in venv), or env APILOGICSERVER_HOME or HOME must be set\n.. VSCode users: Ctrl-Shift-P, Python: Select Interpreter > Use Python from "python.defaultInterpreterPath"\n\n')
+        admin_logger.debug("return_spa - install directory")
+        utils_str = inspect.getfile(api_logic_server_utils)
+        sra_path = Path(utils_str).parent.joinpath('safrs-react-admin-npm-build')
+        directory = str(sra_path)
+    return directory
+
+
+def admin_events(flask_app: Flask, args: Args, validation_error: ValidationError):
+    """ events for serving minified safrs-admin, using admin.yaml
+    """
+
+    @flask_app.route("/admin/<path:path>")
+    def start_custom_app_return_spa(path=None):
+        """ Step 1 - Start Custom App, and return minified safrs-react-admin app (acquired from safrs-react-admin/build) 
+            Custom url: http://localhost:5656/admin/custom_app
+        """
+        global did_send_spa
+        admin_logger.debug(f'API Logic Server - Start Custom App, return minified sra')
+        if True or not did_send_spa:  # debug info
+            did_send_spa = True
+            admin_logger.info(f'\nStart Custom App ({path}): return spa "ui/safrs-react-admin", "index.html"\n')
+        directory = get_sra_directory(args)  # e.g, ...venv/lib/python3.11/site-packages/api_logic_server_cli/create_from_model/safrs-react-admin-npm-build
+        return send_from_directory(directory, 'index.html')  # unsure how admin finds custom url
+
+    @flask_app.route('/')
+    def start_default_app():
+        """ Step 1 - Start default Admin App 
+            Default URL: http://localhost:5656/ 
+        """
+        admin_logger.info(f'API Logic Server - Start Default App - redirect /admin-app/index.html')
+        return redirect('/admin-app/index.html')  # --> return_spa
+
+    @flask_app.route("/admin-app/<path:path>")
+    def return_spa(path=None):
+        """ Step 2 - return minified sra for default admin app
+        """
+        global did_send_spa
+        if path == "home.js":
+            directory = "ui/admin"
+        else:
+            directory = get_sra_directory(args)
+
+        if not did_send_spa:
+            did_send_spa = True
+            admin_logger.debug(f'return_spa - directory = {directory}, path= {path}')
+
+        return send_from_directory(directory, path)
+
+
+    @flask_app.route('/ui/admin/<path:path>')
+    def admin_yaml(path=None):
+        """ Step 3 - return admin file response (to now-running safrs-react-admin app)
+            and text-substitutes to get url args from startup args (avoid specify twice for *both* server & admin.yaml)
+
+            api_root: {http_type}://{swagger_host}:{port}/{api} (from ui_admin_creator)
+
+            authentication:
+                endpoint: {http_type}://{swagger_host}:{port}/api/auth/login     or...
+                    e.g. http://localhost:5656/ui/admin/admin.yaml
+
+            authentication:
+                keycloak:
+                    url: args.keycloak_url
+                    realm: args.realm
+                    clientId: args.alsclient
+
+        """
+        use_type = "mem"
+        if use_type == "mem":
+            with open(f'ui/admin/{path}', "r") as f:  # path is admin.yaml for default url/app
+                content = f.read()
+
+            if args.client_uri is not None:
+                content = content.replace(
+                    '{http_type}://{swagger_host}:{port}',
+                    args.client_uri
+                )
+                content = content.replace("{api}", args.api_prefix[1:])
+            else:
+                content = content.replace("{http_type}", args.http_scheme)
+                content = content.replace("{swagger_host}", args.swagger_host)
+                content = content.replace("{port}", str(args.swagger_port))  # note - codespaces requires 443 here (typically via args)
+                content = content.replace("{api}", args.api_prefix[1:])
+
+            if Config.SECURITY_ENABLED == False:
+                content = content.replace("authentication", 'no-authentication')
+                content = content.replace("'{system-default}'", 'no-authentication')
+            else:
+                provider_name = str(Config.SECURITY_PROVIDER)
+                if "keycloak" in provider_name:
+                    s = (f'\n'
+                        f'  keycloak:\n'
+                        f'    url: {args.keycloak_base}\n'
+                        f'    realm: {args.keycloak_realm}\n'
+                        f'    clientId: {args.keycloak_client_id}\n'
+                    )   
+                    content = content.replace("'{system-default}'", s)
+                elif "sql" in provider_name:
+                    sql_auth_config = f'\n  endpoint: {args.http_scheme}://{args.swagger_host}:{args.swagger_port}/{args.api_prefix[1:]}/auth/login\n'
+                    content = content.replace("'{system-default}'", sql_auth_config)
+                elif getattr(Config.SECURITY_PROVIDER, 'auth_config', None):
+                    content = content.replace("'{system-default}'", Config.SECURITY_PROVIDER.auth_config)
+                else:
+                    sys.exit(f"ERROR[admin_loader]: unknown security type: {Config.SECURITY_PROVIDER}")         
+
+            admin_logger.debug(f'loading ui/admin/admin.yaml')
+            mem = io.BytesIO(str.encode(content))
+            if debug_repoonse := False:  # debug, to verify url/security content
+                mem = io.BytesIO(str.encode(content))
+                mem_array = mem.getvalue().decode('utf-8').split('\n')
+                logging.info(f'admin_yaml() - response: \n{mem_array}')    
+            return send_file(mem, mimetype='text/yaml')
+        else:
+            response = send_file("ui/admin/admin.yaml", mimetype='text/yaml')
+            return response
+
+    @flask_app.route('/ui/images/<path:path>')
+    def get_image(path=None):
+        """ return requested image
+            data: Employee/janet.jpg
+            url:  http://localhost:5656/ui/images/Employee/janet.jpg
+        """
+        response = send_file(f'ui/images/{path}', mimetype='image/jpeg')
+        return response
+
+
+    @flask_app.errorhandler(ValidationError)
+    def handle_exception(e: ValidationError):
+        res = {'code': e.status_code,
+            'errorType': 'Validation Error',
+            'errorMessage': e.message}
+        #    if debug:
+        #        res['errorMessage'] = e.message if hasattr(e, 'message') else f'{e}'
+
+        return res, 400
+
+
+    @flask_app.after_request
+    def after_request(response):
+        '''
+        Enable CORS. Disable it if you don't need CORS or install Cors Library
+        https://parzibyte.me/blog
+        '''
+        response.headers[
+            "Access-Control-Allow-Origin"] = "*"  # <- You can change "*" for a domain for example "http://localhost"
+        response.headers["Access-Control-Allow-Credentials"] = "true"
+        response.headers["Access-Control-Allow-Methods"] = "POST, GET, OPTIONS, PUT, DELETE, PATCH"
+        response.headers["Access-Control-Allow-Headers"] = \
+            "Accept, Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token,  X-Requested-With, X-Auth-Token, Authorization, Access-Control-Allow-Origin"
+                #"access-control-allow-origin, authorization, content-type
+        response.headers["Access-Control-Expose-Headers"] = "X-Auth-Token, Content-disposition, X-Requested-With"
+        #response.headers["Content-Type"] = "application/json, text/html"
+        
+        # This is a short cut to auto login to Ontimize
+        try:
+            #from security.system.authentication import access_token
+            from flask import g
+            if "access_token" in g:
+                response.headers["X-Auth-Token"] = g.access_token  # required for Ontimize (kludge alert)
+        except:
+            logging.error('\nadmin_loader - after_request - access_token not set\n')
+
+        
+        admin_logger.debug(f'cors after_request - response: {str(response)}')
+        return response

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

@@ -0,0 +1,99 @@
+about:
+  date: June 20, 2024 16:59:24
+  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: 3
+  number_tables: 3
+resources:
+  authentication-Role:
+    attributes:
+    - label: ' name*'
+      name: name
+      required: true
+      search: true
+      sort: true
+    tab_groups:
+    - direction: tomany
+      fks:
+      - role_name
+      name: UserRoleList
+      resource: authentication-UserRole
+    type: authentication-Role
+    user_key: name
+  authentication-User:
+    attributes:
+    - label: ' name*'
+      name: name
+      search: true
+      sort: true
+    - name: username
+    - name: password_hash
+    - name: region
+    - name: client_id
+    - name: id
+      required: true
+    tab_groups:
+    - direction: tomany
+      fks:
+      - owner_id
+      name: ApiList
+      resource: authentication-Api
+    - direction: tomany
+      fks:
+      - user_id
+      name: UserRoleList
+      resource: authentication-UserRole
+    type: authentication-User
+    user_key: name
+  authentication-UserRole:
+    attributes:
+    - label: ' role_name*'
+      name: role_name
+      required: true
+      search: true
+      sort: true
+    - name: role_name
+      required: true
+    - name: user_id
+      required: true
+    - name: notes
+    tab_groups:
+    - direction: toone
+      fks:
+      - role_name
+      name: Role
+      resource: authentication-Role
+    - direction: toone
+      fks:
+      - user_id
+      name: user
+      resource: authentication-User
+    type: authentication-UserRole
+    user_key: role_name
+settings:
+  HomeJS: http://localhost:5656/admin-app/home.js
+  max_list_columns: 8
+  style_guide:
+    currency_symbol: $
+    currency_symbol_position: left
+    date_format: LL
+    decimal_max: '10000000'
+    decimal_min: '0'
+    decimal_separator: .
+    detail_mode: tab
+    edit_on_mode: dblclick
+    include_translation: 'false'
+    keycloak_client_id: alsclient
+    keycloak_realm: kcals
+    keycloak_url: http://localhost:8080
+    max_decimal_digits: '4'
+    min_decimal_digits: '2'
+    new_mode: dialog
+    pick_style: list
+    row_height: small,
+    style: light
+    thousand_separator: ','
+    use_keycloak: 'false'

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/admin/home.js

@@ -0,0 +1,48 @@
+const sla_doc =
+    '<div class="MuiTypography-root jss4" style="color: rgba(0, 0, 0, 0.66)">' +
+    '<div style="text-align:center">' +
+    '<h2>Welcome to API Logic Server</h2>' +
+    '</div><br>' +
+    '<h3><a class="custom" style="color: #3f51b5;"  rel="nofollow" href="https://apilogicserver.github.io/Docs/" target="_blank">API Logic Server</a> ' +
+    'creates <i>customizable</i> model-driven systems, instantly from your ' +
+    'database:' +
+    '</h3>' +
+    '<h4>1. Automatic Admin App</h4>' +
+    '<ul>' +
+    '   <li>For instant collaboration and Back Office data maintenance</li>' +
+    '   <li>Rich functionality: multi-page, multi-table</li>' +
+    '   <li>Explore this Admin App, ' +
+    '        and how to <a class="custom" style="color: #3f51b5" rel="nofollow" href="https://apilogicserver.github.io/Docs/Admin-Customization/" target="_blank">customize it</a></li>' +
+    '</ul>' +
+    '<h4>2. API, with <a class="custom" style="color: #3f51b5;"  rel="nofollow" href="/api" target="_blank">oas/Swagger</a></h4>' +
+    '<ul>' +
+    '   <li>For custom app dev, integration</li>' +
+    '   <li>Rich functionality: endpoint for each table, with filtering, pagination, related data</li>' +
+    '   <li><a class="custom" style="color: #3f51b5" rel="nofollow" href="https://apilogicserver.github.io/Docs/API-Customize/" target="_blank">Customizable</a>: add your own endpoints</li>' +
+    '   <li><a class="custom" style="color: #3f51b5" rel="nofollow" href="http://localhost:5656/stop" target="_blank">Stop</a> the server</li>' +
+    '</ul>' +
+    '<h4>3. Business Logic, for <span class="JoinedField" title="Often nearly half the app -- automation required"><span>backend processing</span> </span></h4>' +
+    '<ul>' +
+    '   <li>Spreadsheet-like rules for multi-table derivations and constraints</li>' +
+    '   <li>Extensible with Python events for email, messages, etc</li>' +
+    '   <li><a class="custom" style="color: #3f51b5" rel="nofollow" href="https://apilogicserver.github.io/Docs/Logic-Why/" target="_blank">Explore</a> ' +
+    '       how logic can meaningfully improve ' +
+    '       <a class="custom" style="color: #3f51b5" rel="nofollow" href="https://github.com/valhuber/LogicBank/wiki/by-code" title="Rules are 40X more concise than code, and address over 95% of database logic" target="_blank">conciseness</a> ' +
+    '       and quality</li>' +
+    '</ul>' +
+    '<h4>4. MCP-enabled, to <span class="JoinedField" title="Often nearly half the app -- automation required"><span>Enable Bus Users to use Natural Language to create multi-step execution flows</span> </span></h4>'+
+    '<ul>' +
+    '   <li>For more information, <a class="custom" style="color: #3f51b5" rel="nofollow" href="https://apilogicserver.github.io/Docs/Integration-MCP/" target="_blank">Click here</a></li>' +
+    '   <li>Create a new SysMcp, and enter: List the orders date_shipped is null and CreatedOn before 2023-07-14, and send a discount email (subject: \'Discount Offer\') to the customer for each one.</li>' +
+    '</ul>' +
+    '</div>'
+
+
+function getContent(){
+
+    let result = '<button class="MuiButtonBase-root MuiButton-root MuiButton-text makeStyles-widget-159 MuiButton-textPrimary" tabindex="0" type="button" ><span class="MuiButton-label">Loaded External Component. </span></button>';
+    result = ""
+    result += sla_doc;
+    return result;
+}
+

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

@@ -0,0 +1,53 @@
+about:
+  date: August 09, 2025 17:35:28
+  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: 0
+  number_tables: 1
+info_toggle_checked: true
+resources:
+  mcp-SysMcp:
+    attributes:
+    - label: ' id*'
+      name: id
+      search: true
+      sort: true
+    - name: request
+    - name: request_prompt
+    - name: completion
+    type: mcp-SysMcp
+    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'

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/app/.browserslistrc

@@ -0,0 +1,12 @@
+# This file is used by the build system to adjust CSS and JS output to support the specified browsers below.
+# For additional information regarding the format and rule options, please see:
+# https://github.com/browserslist/browserslist#queries
+
+# You can see what browsers were selected by your queries by running:
+#   npx browserslist
+
+last 2 Chrome versions
+last 1 Firefox version
+last 2 Edge major versions
+last 2 Safari major versions
+last 2 iOS major versions

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/app/.dockerignore

@@ -0,0 +1,47 @@
+# Compiled output
+/dist
+**/dist
+/tmp
+/out-tsc
+/bazel-out
+
+# Node
+/node_modules
+**/node_modules/
+npm-debug.log
+yarn-error.log
+
+# IDEs and editors
+.idea/
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# Visual Studio Code
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history/*
+
+# Miscellaneous
+/.angular/cache
+.sass-cache/
+/connect.lock
+/coverage
+/libpeerconnection.log
+testem.log
+/typings
+.git
+npm-debug.log
+.coverage
+.coverage.*
+.env
+
+# System files
+.DS_Store
+Thumbs.db

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/app/.editorconfig

@@ -0,0 +1,16 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.ts]
+quote_type = single
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/app/.eslintrc.json

@@ -0,0 +1,51 @@
+{
+  "root": true,
+  "ignorePatterns": [
+    "projects/**/*"
+  ],
+  "overrides": [
+    {
+      "files": [
+        "*.ts"
+      ],
+      "parserOptions": {
+        "project": [
+          "tsconfig.json",
+          "e2e/tsconfig.json"
+        ],
+        "createDefaultProgram": true
+      },
+      "extends": [
+        "plugin:@angular-eslint/recommended",
+        "plugin:@angular-eslint/template/process-inline-templates"
+      ],
+      "rules": {
+        "@angular-eslint/directive-selector": [
+          "error",
+          {
+            "type": "attribute",
+            "prefix": "app",
+            "style": "camelCase"
+          }
+        ],
+        "@angular-eslint/component-selector": [
+          "error",
+          {
+            "type": "element",
+            "prefix": "",
+            "style": "kebab-case"
+          }
+        ]
+      }
+    },
+    {
+      "files": [
+        "*.html"
+      ],
+      "extends": [
+        "plugin:@angular-eslint/template/recommended"
+      ],
+      "rules": {}
+    }
+  ]
+}

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/app/.gitignore

@@ -0,0 +1,47 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist
+/tmp
+/out-tsc
+# Only exists if Bazel was run
+/bazel-out
+
+# dependencies
+/node_modules
+
+# profiling files
+chrome-profiler-events*.json
+speed-measure-plugin*.json
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history/*
+
+# misc
+/.angular/cache
+/.sass-cache
+/connect.lock
+/coverage
+/libpeerconnection.log
+npm-debug.log
+yarn-error.log
+testem.log
+/typings
+
+# System Files
+.DS_Store
+Thumbs.db

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/app/README.md

@@ -0,0 +1,42 @@
+# ApiLogicServer Integrated Ontimize Angular Application
+ApiLogicServer technical preview using OntimizeWebNgx JEE Seed
+
+This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 15.2.9.
+
+Read the docs [Ontimize App Creation](https://apilogicserver.github.io/Docs/App-Custom-Ontimize-Overview/)
+
+## Requirements
+
+- Node: 18.10.0
+
+## Install
+
+Run `npm install` to install al required dependencies.
+
+## Local Development
+
+Run `npm run start` to serve the application in port 4299
+
+## Code scaffolding
+
+Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+
+## Build
+
+Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
+
+## Running unit tests
+
+Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+
+## Running end-to-end tests
+
+Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
+
+## Production
+
+Run `npm run production` to run the production script that will create the distribution folder with all necessary files to deployment.
+
+## Further help
+
+To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).