@sava-info-systems/api-maker-with-extensions 2.3.0 → 3.0.0

package/dist/assets/schema-types/types.ts

@@ -66,6 +66,8 @@ export interface ISandboxReqAuthObj {
     authAMUser?: any;
     /** API Maker database user authentication token. */
     authAMDB?: any;
+    /** Custom authorization provided by user */
+    authCustom?: any;
 
     /** Google authentication token. */
     authGoogle?: any;
@@ -202,6 +204,11 @@ export interface IAuthInfoObjects {
     /** Groups/roles assigned to the API Maker database user. */
     authAMDBGroups?: any[]; // IGroup[]
 
+    /** Custom authorization token information */
+    authCustomInfo?: any;
+    /** Groups/roles assigned to the API Maker database user. */
+    authCustomGroups?: any[]; // IGroup[]
+
     /** Google authentication token information. */
     authGoogleInfo?: IAuthTokenGoogle;
     /** Groups/roles assigned to the Google authenticated user. */
@@ -788,7 +795,7 @@ export interface ISecretType {
     common?: ISecretTypeCommon; // it is general purpose secret key section.
 }
 
-export interface ISecretTypeCommon extends Pick<IAuthTokenInfoCommon, 'authTokenInfo'> {
+export interface ISecretTypeCommon extends Pick<IAuthTokenInfoCommon, 'authProviders'> {
     hashingAlgorithm?: 'SHA256'; // change in IPropertyHashing also
     nonce?: string; // if it is available, it will be used for hashing, if not available secret will be used for hashing
 
@@ -811,8 +818,9 @@ export interface ISecretTypeCommon extends Pick<IAuthTokenInfoCommon, 'authToken
 
 export interface IAuthTokenInfo {
     authTokenType?: EAuthTokenType;
-    authTokenAM?: IAuthTokenAM | IRefreshTokenAM;
-    authTokenAMDB?: IAuthTokenAMDB | IRefreshTokenAM;
+    authTokenAM?: IAuthTokenAM;
+    authTokenAMDB?: IAuthTokenAMDBRequest;
+    authTokenCustom?: IAuthTokenAMDBRequest;
 
     authTokenAWS?: IAuthTokenAWS;
     authTokenAzureAD?: IAuthTokenAzureAD;
@@ -832,14 +840,18 @@ export interface IAuthTokenAM {
     expiresInSeconds?: number;
 }
 
-export interface IRefreshTokenAM {
-    refresh_token: string;
-}
+// export interface IRefreshTokenAM {
+//     name?: string;
+//     refresh_token: string;
+// }
 
 /**
  * API Maker database user authentication configuration.
  */
-export interface IAuthTokenAMDB extends Partial<IAuthTokenAM> {
+export interface IAuthTokenAMDB {
+    /** Name of DB authorization token generator. It will be used in get-token api with username & pass to generate token. */
+    name?: string;
+
     /** Database instance name. */
     instance?: string;
     /** Database name. */
@@ -860,9 +872,9 @@ export interface IAuthTokenAMDB extends Partial<IAuthTokenAM> {
     passwordChangedAtColumn?: string;
 
     /**
-     * Column containing comma-separated group assignments.
-     * Use "*" to grant access to all API user groups.
-     * DB users can access APIs if they belong to at least one of the required groups.
+     * column name which holds values of, comma separated groups assigned to this db user.
+     * "*" = means all groups of api user.
+     * DB user can hit API if he/she has access in any of these groups.
      */
     groupsColumn?: string;
     /**
@@ -877,12 +889,19 @@ export interface IAuthTokenAMDB extends Partial<IAuthTokenAM> {
     sortUsersForTesting?: any;
     /** Fields to select from user records. */
     select?: any;
+    /** Token expiration time in seconds. */
+    expiresInSeconds?: number;
+    /** If true, code will be executed on native process otherwise executed on sandbox. */
+    runOnNativeProcess?: boolean;
+}
 
-    /**
-     * Stringified request JSON data.
-     * Internal field populated by the system.
-     */
-    __amDBRequestData?: string;
+export interface IAuthTokenAMDBRequest {
+    /** Name of token generator */
+    name?: string;
+    /** Username. */
+    u: string;
+    /** Password. */
+    p: string;
 }
 
 /**
@@ -1332,6 +1351,22 @@ export interface IArrayOperation {
     upsert?: boolean;
 }
 
+/**
+ * Request structure for token generation API calls.
+ */
+export interface IGetTokenRequest {
+    /** Name of token generator */
+    name?: string;
+    /** Username. */
+    u: string;
+    /** Password. */
+    p: string;
+    /** Refresh token for obtaining a new access token without re-authenticating. */
+    refresh_token?: string;
+    /** Token expiration time in seconds. Used to get only AM user token. */
+    expiresInSeconds?: number;
+}
+
 /**
  * Response structure for token generation API calls.
  */
@@ -1349,10 +1384,14 @@ export interface IGetTokenResponse {
 
 export interface IAuthTokenInfoCommon {
     apiAccessType?: EAPIAccessType; // api level setting
-    authTokenInfo?: IAuthTokenInfo[] | string; // string will point to secret path.
+
+    /** Provide names of token generators */
+    authProviders?: string[];
 }
 
 export interface IInstanceApiSettingsTypes extends IAuthTokenInfoCommon {
+    /** Folder name of this item in git. It has to be unique, and it can contain [a-zA-Z0-9_ -] characters only. */
+    name?: string;
     enableCaching?: boolean; // collection level setting
     acceptOnlyEncryptedData?: boolean; // database & collection & api level setting
 }
@@ -1415,6 +1454,13 @@ export interface ICustomApiSettingsTypes extends IAuthTokenInfoCommon {
      */
     runOnNativeProcess?: boolean;
 
+    /**
+     * Maximum time (in seconds) the system will allow this custom API to complete its operation.
+     * Converted to milliseconds and sent as the 'x-am-sandbox-timeout' header.
+     * @default 10
+     */
+    customApiTimeoutInSeconds?: number;
+
     /**
      * List of all possible error messages this API can return.
      * Used for API documentation and client-side error handling.
@@ -1612,6 +1658,8 @@ export enum EAuthTokenType {
     AM = 'AM',
     /** Database-backed user authentication. */
     AM_DB = 'AM_DB',
+    /** Write your own logic to generate token and validate token */
+    CUSTOM_TOKEN_GENERATOR = 'CUSTOM_TOKEN_GENERATOR',
     /** Google OAuth authentication. */
     GOOGLE = 'GOOGLE',
     /** AWS Cognito authentication. */
@@ -1829,7 +1877,7 @@ export interface IAMGlobalSysSystem {
     getSecret(): any; // we can call it without any param also, in store and in tp it will return object of that part.
     callExternalApi<T>(data: ICallApiFromBackend | ICallApiFromBackend[] | ICallApiFromBackendProcess | ICallApiFromBackendProcess[] | (ICallApiFromBackend | ICallApiFromBackendProcess)[]): Promise<ICallExternalApiResp<T>>;
     callExternalApi(data: ICallApiFromBackend | ICallApiFromBackend[] | ICallApiFromBackendProcess | ICallApiFromBackendProcess[] | (ICallApiFromBackend | ICallApiFromBackendProcess)[]): Promise<ICallExternalApiResp<any>>;
-    getToken(data: IAuthTokenInfo | IAuthTokenInfo[]): any;
+    getToken(data: IGetTokenRequest | IGetTokenRequest[]): any;
     executeQuery(query: IExecuteQuery): any;
     /**
      * It should be used SQL based databases only.

package/dist/assets/styles/bootstrap-overrides.scss

@@ -9,7 +9,7 @@
 .card { border-radius: 0 !important;}
 
 .card-header {
-    padding: .25rem .5rem;
+    padding: .25rem 1rem;
     font-weight: bold;
     border-radius: 0 !important;
 }
@@ -43,20 +43,136 @@
 .modal-header {
     line-height: 1.5rem; // to keep header text in vertically center.
     font-weight: bold;
+    align-items: center; // vertically centre the title + close button (Bootstrap defaults to flex-start)
 }
 
-.modal-header .close {
-    padding: .25rem .5rem;
-    margin: -0.25rem -0.5rem -0.25rem auto;
-    //border-left: $border-style;
+// New UI standard: round close button. Geometry here is theme-agnostic (same in
+// dark & light); the surface/border/hover colours live in colors-dark/-light.scss.
+// Covers both the in-header close button AND the absolutely-positioned close that
+// some full-screen modals (e.g. the test-case layout) drop straight into .modal-content.
+.modal-header .close,
+.modal-content > .close {
+    display: inline-flex;
+    align-items: center;
+    justify-content: center;
+    width: 1.75rem;
+    height: 1.75rem;
+    padding: 0;
+    vertical-align: middle;     // centre against sibling inline content (some headers wrap it in a float-right div)
+    border-radius: 50%;
+    line-height: 1;
+    opacity: 1;                 // Bootstrap dims .close to 0.5 by default
+    transition: background-color 0.15s ease, color 0.15s ease, border-color 0.15s ease, box-shadow 0.15s ease;
+
+    // the X glyph sits centred; sized to the round button
+    span { display: inline-flex; }
+    i { font-size: 0.95rem; line-height: 1; }
+
+    // Normalise the close glyph app-wide. Modals use three different close icons:
+    //   fa-window-close (\f410, boxy square) · fa-times-circle (\f057, circled X)
+    //   · fa-times (\f00d, plain X). The first two read as a "box/circle inside the
+    // round button". Force them all to a clean plain X (\f00d) so every modal's
+    // round close button is identical, without editing each template.
+    // (Font Awesome 5 Free, solid weight 900.)
+    i.fa-window-close::before,
+    i.fa-times-circle::before { content: "\f00d"; }
+}
+// Flush-right only when it's a flex child of the header (not the absolutely-positioned variant).
+.modal-header .close { margin: 0 0 0 auto; }
+// Absolutely-positioned corner close (test-case / system-logs full-screen modals): its sibling
+// action icons sit at the same inline `top: 0.25rem` but on a 1.3rem (`line-height-1-3`) line, so
+// their centre is at 0.9rem; the 1.75rem round button pinned at the same top centres at 1.125rem —
+// ~0.225rem lower. Pull it up by exactly that half-height difference so it lines up with the icons.
+.modal-content > .close { margin-top: -0.225rem; }
+.modal-header .close:hover,
+.modal-header .close:focus { opacity: 1; outline: none; }
+
+// Some modals group the close button with a docs link / info icon in a
+// `float-right` wrapper. Those children have different heights (e.g. the 25px
+// docs logo), so on a shared inline baseline the round close button reads as
+// off-centre. Lay the wrapper out as a centred flex row so every action—incl.
+// the close button—sits on one vertically-centred line. Order keeps Close last.
+.modal-header > .float-right {
+    float: none !important;
+    display: inline-flex;
+    align-items: center;
+    gap: 0.65rem;               // even, comfortable spacing between header actions (docs / info / close)
+    margin-left: auto;          // push the action group to the right edge…
+    padding-left: 1rem;         // …but never let it crowd the title text
+}
+.modal-header > .float-right .close { margin: 0; order: 1; }
+
+// New UI standard: header action icons (docs logo + info / help glyphs) share a
+// consistent size and sit centred next to the round close button. Drop the ad-hoc
+// inline sizing/margins (font-size:25px, ml-2/3, mt-n1/n2) the templates carry.
+.modal-header > .float-right {
+    // Docs wordmark logo — fixed height (the SVG is 235×145, so width auto keeps ratio),
+    // a touch recessed, brightening on hover like a link.
+    a {
+        display: inline-flex;
+        align-items: center;
+        margin: 0 !important;
+    }
+    img {
+        height: 20px !important;
+        width: auto !important;
+        margin: 0 !important;        // neutralise mt-n1/n2 + ml/mr that skewed centring
+        opacity: 0.9;
+        transition: opacity 0.15s ease;
+    }
+    a:hover img { opacity: 1; }
+
+    // Info / help action — normalise the inline font-size:1.4em + harsh text-info to
+    // a consistent glyph that matches the close button's scale and brand colour.
+    > span {
+        font-size: 1rem !important;
+        display: inline-flex;
+        align-items: center;
+        margin: 0 !important;
+    }
+    > span i { font-size: 1.15rem; line-height: 1; transition: color 0.15s ease; }
 }
 
 .nav-link { padding: 0.5rem 1rem !important;}
 
+// Pin navbar item metrics so swapping bootswatch themes (slate <-> cerulean) can't reflow the
+// navbar (prevents the menu "dancing" on dark/light toggle). Theme-agnostic — same in both modes.
+.navbar { min-height: 44px; }
+.navbar-nav .nav-link {
+    padding: 0.5rem 1rem !important;
+    line-height: 1.5 !important;
+    font-size: $font-size !important;
+    font-weight: 400 !important;
+}
+.navbar-nav .nav-link.active,
+.navbar-nav .nav-item.show > .nav-link { font-weight: 400 !important; } // no bold jump on active
+
+// Menu (dropdown) separator — brand-tinted hairline, visible in both themes.
+.dropdown-divider {
+    border-top: 1px solid rgba(97, 175, 239, 0.20);
+    margin: 0.3rem 0.5rem;
+}
+
+// Pin heading sizes so the bootswatch slate/cerulean swap renders them identically (same in dark & light).
+h1, .h1 { font-size: 2.5rem !important; }
+h2, .h2 { font-size: 2rem !important; }
+h3, .h3 { font-size: 1.75rem !important; }
+h4, .h4 { font-size: 1.40625rem !important; }
+h5, .h5 { font-size: 1.171875rem !important; }
+h6, .h6 { font-size: 0.9375rem !important; }
+
+// Heading standard (theme-agnostic) — spacing/weight/line-height. Color is set per theme.
+h1, h2, h3, h4, h5, h6, .h1, .h2, .h3, .h4, .h5, .h6 {
+    margin-bottom: 0.5rem;
+    font-weight: 500;
+    line-height: 1.2;
+}
+
 .nav-pills .nav-link, .nav-tabs .nav-link, .nav-tabs .nav-link:hover {color: var(--content-primary--shade--four);}
 
 .navbar-brand {
-    padding-top: 0.3125rem !important;
+    //padding-top: 0.3125rem !important;
+    padding-top: 0 !important;
     padding-bottom: 0.3125rem !important;
     font-size: 1.25rem !important;
 }
@@ -67,7 +183,28 @@
     border: none !important;
 }
 
-.form-control-sm, .col-form-label-sm { font-size: $font-size;}
+// ==== Consistent input HEIGHT across both themes ====
+// bootswatch slate (dark) and cerulean (light) ship DIFFERENT .form-control padding +
+// font-size, and since the height is calc(1.5em + padding + 2px) (em-based) the inputs
+// render at different heights per theme. Pin font-size + padding + line-height + border
+// so every input is identical in dark & light, everywhere in the app.
+.form-control {
+    font-size: $font-size !important;          // 0.875rem
+    padding: 0.375rem 0.75rem !important;
+    line-height: 1.5 !important;
+    border-width: 1px !important;
+    height: calc(1.5em + 0.75rem + 2px) !important;
+}
+.form-control-sm, .col-form-label-sm { font-size: $font-size !important; }
+.form-control-sm {
+    padding: 0.25rem 0.5rem !important;
+    line-height: 1.5 !important;
+    border-width: 1px !important;
+    height: calc(1.5em + 0.5rem + 2px) !important;
+}
+// input-group prefix/suffix boxes must match the input height (same padding/line-height/font).
+.input-group-sm .input-group-text, .input-group-sm .form-control { font-size: $font-size !important; }
+textarea.form-control, textarea.form-control-sm { height: auto !important; } // textareas size to rows
 
 //.modal-content { max-height: calc(100vh - 72px);}
 .modal-content { max-height: calc(100vh - 68px); } // 72px is giving scroll in case of log profile.
@@ -92,3 +229,29 @@
 
 // file upload classes
 .custom-file-input:lang(en) ~ .custom-file-label::after {padding: 5px; height: 30px;}
+
+// Override Bootswatch's harsh .btn black border + text-shadow (doesn't suit the brand gradient buttons).
+.btn {
+    border-color: transparent;
+    text-shadow: none;
+}
+
+// ==== Consistent button HEIGHT + font across both themes ====
+// Same root cause as inputs: bootswatch slate (dark) uses padding 0.75rem 1rem / font 0.9375rem,
+// cerulean (light) uses 0.375rem 0.75rem / font 1rem — so buttons render at different heights per
+// theme. Pin font-size + padding + line-height + border so buttons are identical in dark & light.
+// EXCLUDE explicitly-sized icon buttons (.btn-xsm-custom, .btn-icon-only) — they set their
+// own width/height/padding and must not be re-padded by these consistency rules.
+.btn:not(.btn-xsm-custom):not(.btn-icon-only) {
+    font-size: $font-size !important;          // 0.875rem
+    padding: 0.375rem 0.75rem !important;
+    line-height: 1.5 !important;
+    border-width: 1px !important;
+}
+.btn-sm:not(.btn-xsm-custom):not(.btn-icon-only),
+.btn-group-sm > .btn:not(.btn-xsm-custom):not(.btn-icon-only) {
+    font-size: $font-size !important;
+    padding: 0.25rem 0.5rem !important;
+    line-height: 1.5 !important;
+    border-width: 1px !important;
+}