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

api_logic_server_cli/prototypes/manager/samples/basic_demo/customizations/ui/reference_react_app/src/rav4-jsonapi-client/resourceLookup.ts

@@ -0,0 +1,124 @@
+interface Relationship {
+    data: null | { id: string; type: string } | Array<{ id: string; type: string }>;
+    relationships?: { [key: string]: Relationship };
+}
+
+/**
+ * A map-like class that maps resource linkage objects {id: 1, type: "user"} to concrete resources with attributes and
+ * relationships
+ */
+export default class ResourceLookup {
+    lookup: Map<any, any>;
+    includes: string[];
+
+    /**
+     * Constructs a new lookup map
+     * @param {Object} response A JSON API response, in JSON format
+     */
+    constructor(response: any) {
+        this.lookup = new Map();
+        this.includes = [];
+
+        // If the response wasn't a JSON dictionary, we can't and don't need to build a lookup
+        if (typeof response !== 'object') return;
+
+        let resources;
+        // if (response.hasOwnProperty('included')) {
+        if (Object.prototype.hasOwnProperty.call(response, 'included')) {
+            resources = [...response.data, ...response.included];
+        } else {
+            resources = response.data;
+        }
+
+        // Iterate over each resource returned and put each in the lookup
+        for (const entry of resources) {
+            const key = this.getKey(entry);
+            this.lookup.set(key, entry);
+        }
+    }
+
+    /**
+     * Calculates a hashable key for JSON API resources
+     * @param resource A resource linkage object
+     * @returns {string}
+     */
+    getKey(resource: any) {
+        return `${resource.type}:${resource.id}`;
+    }
+
+    /**
+     * Looks up a resource
+     * @param resource A resource linkage object
+     * @returns {Object}
+     */
+    get(resource: any) {
+        // If we don't have included data for this resource, just return the Resource Linkage object, since that's still
+        // useful
+        if (this.has(resource)) {
+            return this.lookup.get(this.getKey(resource));
+        } else {
+            return structuredClone(resource);
+        }
+    }
+
+    /**
+     * Returns true if the resource is in the lookup
+     * @param resource
+     * @returns {boolean}
+     */
+    has(resource: any) {
+        return this.lookup.has(this.getKey(resource));
+    }
+
+    /**
+     * Converts a JSON API data object (with id, type, and attributes fields) into a flattened object
+     * @param {Object} response A JSON API data object
+     */
+    unwrapData(response: any) {
+        // The base resource object, merge the attributes and the id/type fields
+        const result = Object.assign(
+            {
+                id: response?.id,
+                ja_type: response?.type,
+                type: response?.Type || response?.type,
+                attributes: response.attributes || {},
+            },
+            response.attributes
+        );
+
+        // Deal with relationships
+        if (Object.prototype.hasOwnProperty.call(response, 'relationships')) {
+            result.relationships = response.relationships;
+            for (const [relationshipName, relationship] of Object.entries(response.relationships)) {
+                if ((relationship as Relationship).data === null) {
+                    result[relationshipName] = null;
+                }
+
+                if (!(relationship as Relationship).data) {
+                    continue;
+                } else if (Array.isArray((relationship as Relationship).data && (relationship as Relationship).data)) {
+                    result[relationshipName] = (relationship as Relationship).data?.map((linkage: any) => {
+                        const resource = this.get(linkage);
+                        const lresult = structuredClone(this.unwrapData(resource));
+                        Object.entries(lresult.attributes || {}).map(([key, value]) => {
+                            lresult[key] = value;
+                        });
+                        result.relationships[relationshipName].data = result[relationshipName];
+                        return lresult;
+                    });
+                } else if ((relationship as Relationship).data?.id) {
+                    const resource = this.get((relationship as Relationship).data);
+                    result[relationshipName] = this.unwrapData(resource);
+                    result.relationships[relationshipName].data = result[relationshipName];
+                }
+            }
+        }
+
+        try {
+            JSON.stringify(structuredClone(result));
+        } catch (e) {
+            return null;
+        }
+        return structuredClone(result);
+    }
+}

api_logic_server_cli/prototypes/manager/samples/basic_demo/customizations/ui/reference_react_app/src/rav4-jsonapi-client/styles.module.css

@@ -0,0 +1,9 @@
+/* add css module styles here (optional) */
+
+.test {
+  margin: 2em;
+  padding: 0.5em;
+  border: 2px solid #000;
+  font-size: 2em;
+  text-align: center;
+}

api_logic_server_cli/prototypes/manager/samples/basic_demo/customizations/ui/reference_react_app/src/reportWebVitals.js

@@ -0,0 +1,13 @@
+const reportWebVitals = onPerfEntry => {
+  if (onPerfEntry && onPerfEntry instanceof Function) {
+    import('web-vitals').then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => {
+      getCLS(onPerfEntry);
+      getFID(onPerfEntry);
+      getFCP(onPerfEntry);
+      getLCP(onPerfEntry);
+      getTTFB(onPerfEntry);
+    });
+  }
+};
+
+export default reportWebVitals;

api_logic_server_cli/prototypes/manager/samples/basic_demo/customizations/ui/reference_react_app/src/setupTests.js

@@ -0,0 +1,5 @@
+// jest-dom adds custom jest matchers for asserting on DOM nodes.
+// allows you to do things like:
+// expect(element).toHaveTextContent(/react/i)
+// learn more: https://github.com/testing-library/jest-dom
+import '@testing-library/jest-dom';

api_logic_server_cli/prototypes/manager/samples/basic_demo/database/alembic/alembic_run.py

@@ -0,0 +1,98 @@
+import os
+import subprocess
+import sys
+
+'''
+Pushes the current database/models.py to the database.
+python database/alembic/alembic_run.py [--non-interactive]
+'''
+
+def prompt(msg, non_interactive=False):
+    if non_interactive:
+        print(f"{msg}")
+        print("Running in non-interactive mode...")
+        return
+    try:
+        input(f"{msg}\nPress Enter to continue or Ctrl+C to abort...")
+    except EOFError:
+        print("Running in non-interactive mode (no stdin available)...")
+        return
+
+def run(cmd, env=None):
+    print(f"Running: {cmd}")
+    result = subprocess.run(cmd, shell=True, env=env)
+    if result.returncode != 0:
+        print(f"Command failed: {cmd}")
+        sys.exit(result.returncode)
+
+def main():
+    # Check for non-interactive mode more safely
+    non_interactive = "--non-interactive" in sys.argv
+    if not non_interactive:
+        try:
+            non_interactive = not sys.stdin.isatty()
+        except:
+            # If we can't check stdin, assume non-interactive
+            non_interactive = True
+    
+    orig_dir = os.getcwd()
+    # Change to the database directory (parent of alembic directory) where alembic.ini is located
+    db_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+    print(f"Changing directory to {db_dir}")
+    os.chdir(db_dir)
+
+    env = os.environ.copy()
+    env["APILOGICPROJECT_NO_FLASK"] = "True"  # ~ export APILOGICPROJECT_NO_FLASK=True
+
+    print("\n\nThis script will update your database schema to match models.py using Alembic.")
+    print("Steps:")
+    print("1. Set APILOGICPROJECT_NO_FLASK=True -- eg, export APILOGICPROJECT_NO_FLASK=True")
+    print("2. Run: alembic upgrade head")
+    print("3. Run: alembic revision --autogenerate -m \"message\"")
+    prompt("Ready to proceed?", non_interactive)
+
+    run("alembic upgrade head", env=env)
+    print("Database schema updated to latest migration.")
+
+    prompt("Now, a new migration will be generated to match models.py.", non_interactive)
+    if non_interactive:
+        msg = "autogenerated"
+    else:
+        try:
+            msg = input("Enter a message for the migration (default: 'autogenerated'): ") or "autogenerated"
+        except EOFError:
+            msg = "autogenerated"
+    run(f'alembic revision --autogenerate -m "{msg}"', env=env)
+
+    # Find the latest migration file
+    versions_dir = os.path.join(db_dir, "alembic", "versions")
+    migration_files = sorted(
+        [f for f in os.listdir(versions_dir) if f.endswith(".py")],
+        key=lambda x: os.path.getmtime(os.path.join(versions_dir, x)),
+        reverse=True
+    )
+    if migration_files:
+        latest_file = os.path.join(versions_dir, migration_files[0])
+        with open(latest_file, "r") as f:
+            lines = f.readlines()
+        with open(latest_file, "w") as f:
+            for line in lines:
+                f.write(line)
+                if line.strip().startswith("def downgrade"):
+                    f.write("    return\n")
+                    break
+    else:
+        print("No migration file found.")
+        sys.exit(1)
+
+    # Apply the newly generated migration after modifying the migration file
+    prompt(f"Migration file generated: {latest_file}\nIt is recommended to review this migration file before proceeding.", non_interactive)
+    run("alembic upgrade head", env=env)
+
+    print("Migration file updated: downgrade will do nothing.")
+    print("Consider updating ui/admin/admin.yaml to reflect schema changes.")
+    os.chdir(orig_dir)
+    print("\nSuccess! Database schema and migrations are up to date.\n\n")
+
+if __name__ == "__main__":
+    main()

api_logic_server_cli/prototypes/manager/samples/basic_demo/database/alembic/env.py

@@ -0,0 +1,78 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+from alembic import context
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# customized for ApiLogicServer
+from database.models import Base
+target_metadata = Base.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline():
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online():
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection, target_metadata=target_metadata
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+print("hello")
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

api_logic_server_cli/prototypes/manager/samples/basic_demo/database/alembic/readme_alembic.md

@@ -0,0 +1,36 @@
+You can push changes to `database/models.py' to your database automatically, or manually.
+
+<br>
+
+## Automatic
+
+Use:
+
+```bash
+python database/alembic/alembic_run.py [--non-interactive]
+```
+
+<br>
+
+## Manual
+
+The diagram below illustrates a path for enacting changes to the data model, and using [Alembic](https://alembic.sqlalchemy.org/en/latest/index.html) to automate the database changes:
+
+1. Update `database/models.py` (e.g., add columns, tables)
+2. Use alembic to compute the revisions
+```bash
+cd database
+export APILOGICPROJECT_NO_FLASK=True
+alembic revision --autogenerate -m "Added Tables and Columns"
+```
+3. **Edit the revision file** to signify your understanding (see below)
+4. Activate the change
+```bash
+alembic upgrade head 
+unset APILOGICPROJECT_NO_FLASK
+```
+
+![alembic example](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/database/alembic/alembic-overview.png?raw=true)
+
+
+To update your admin app, run `rebuild-from-model`.  For more information, see [Database Design Changes](https://apilogicserver.github.io/Docs/Database-Changes/).

api_logic_server_cli/prototypes/manager/samples/basic_demo/database/alembic/script.py.mako

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

api_logic_server_cli/prototypes/manager/samples/basic_demo/database/alembic/versions/ae6a5c2fdc47_autogenerated.py

@@ -0,0 +1,34 @@
+"""autogenerated
+
+Revision ID: ae6a5c2fdc47
+Revises: 
+Create Date: 2025-08-09 17:24:49.300803
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'ae6a5c2fdc47'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('sysemail',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('message', sa.String(), nullable=True),
+    sa.Column('subject', sa.String(), nullable=True),
+    sa.Column('customer_id', sa.Integer(), nullable=False),
+    sa.Column('CreatedOn', sa.DateTime(), nullable=True),
+    sa.ForeignKeyConstraint(['customer_id'], ['customer.id'], ),
+    sa.PrimaryKeyConstraint('id')
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    return

api_logic_server_cli/prototypes/manager/samples/basic_demo/database/alembic/versions/readme.md

@@ -0,0 +1 @@
+Python scripts for database migrations, for use by alembic.

api_logic_server_cli/prototypes/manager/samples/basic_demo/database/alembic.ini

@@ -0,0 +1,103 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = alembic
+
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+# ApiLogicServer - structure is <project>/database
+prepend_sys_path = ../
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+# sqlalchemy.url = driver://user:pass@localhost/dbname -- set by ApiLogicServer 
+sqlalchemy.url = sqlite:////Users/val/dev/ApiLogicServer/ApiLogicServer-dev/build_and_test/ApiLogicServer/basic_demo/database/db.sqlite
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

api_logic_server_cli/prototypes/manager/samples/basic_demo/database/bind_dbs.py

@@ -0,0 +1,25 @@
+from safrs import SAFRSAPI
+import logging as logging  # additional per-database imports
+
+# TODO remove from api import mcp_expose_api_models
+from database import mcp_models
+        
+app_logger = logging.getLogger("api_logic_server_app")
+
+'''
+For multi-database support, this is called by Config/server_setup to
+* create the SQLAlchemy binds for each database
+  * NB: must do all binds in 1 call (not 1 call per db): https://www.youtube.com/watch?v=SB5BfYYpXjE
+'''
+
+
+def bind_dbs(flask_app):
+    """ called by api_logic_server_run to open/bind each additional database"""
+
+    flask_app.config.update(SQLALCHEMY_BINDS = {
+      'authentication': flask_app.config['SQLALCHEMY_DATABASE_URI_AUTHENTICATION'],
+      'landing_page' : flask_app.config['SQLALCHEMY_DATABASE_URI_LANDING']
+, 		'mcp': flask_app.config['SQLALCHEMY_DATABASE_URI_MCP']
+    })  # make multiple databases available to SQLAlchemy
+
+    return

api_logic_server_cli/prototypes/manager/samples/basic_demo/database/customize_models.py

@@ -0,0 +1,19 @@
+from database import models
+from safrs import jsonapi_attr
+from sqlalchemy.orm import relationship, remote, foreign
+import logging
+
+app_logger = logging.getLogger(__name__)
+
+from database.database_discovery.auto_discovery import discover_models
+discover_models()
+
+"""
+If you wish to drive models from the database schema,
+you can use this file to customize your schema (add relationships, derived attributes),
+and preserve customizations over iterations (regenerations of models.py).
+
+Called from models.py (classes describing schema, per introspection).
+
+Your Code Goes Here
+"""