Compare commits
103
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
96862bf6f1 | ||
|
|
2427dbeeba | ||
|
|
ce80326e30 | ||
|
|
0b35383fd2 | ||
|
|
463da833d2 | ||
|
|
3d08dc7f12 | ||
|
|
91ea8e6385 | ||
|
|
6aefb654e4 | ||
|
|
5464627053 | ||
|
|
4a3d9dc477 | ||
|
|
c5b1a58ca1 | ||
|
|
29fd6e11b2 | ||
|
|
6bb4b3286d | ||
|
|
d82fa30a6c | ||
|
|
f1c646605a | ||
|
|
2513b651e3 | ||
|
|
35a75b166c | ||
|
|
6c72f2e805 | ||
|
|
7d6428e046 | ||
|
|
8406d8af57 | ||
|
|
86546fa919 | ||
|
|
883dd300c0 | ||
|
|
b6f0af7cb3 | ||
|
|
71e7daffdf | ||
|
|
ca72cf2a29 | ||
|
|
aa8c53c6f9 | ||
|
|
74c9c8e6c5 | ||
|
|
2af455f2ab | ||
|
|
c6252fc1f8 | ||
|
|
6a18604811 | ||
|
|
10f91c7adc | ||
|
|
f4b6b5adce | ||
|
|
07b6b23111 | ||
|
|
d17e4e9f20 | ||
|
|
030d78f454 | ||
|
|
560b00c109 | ||
|
|
f60d45c325 | ||
|
|
e8ec0e6bbe | ||
|
|
e136eb4f52 | ||
|
|
7ddf61dfd5 | ||
|
|
74f64e7b17 | ||
|
|
e0652f4b9a | ||
|
|
f6016558b6 | ||
|
|
3e69e81d30 | ||
|
|
182b6f5e5a | ||
|
|
1809736416 | ||
|
|
be74f6485a | ||
|
|
52ef938cfe | ||
|
|
1ea9058d63 | ||
|
|
3db2c19a49 | ||
|
|
405583ea63 | ||
|
|
83630fe536 | ||
|
|
caade04633 | ||
|
|
e980f2bded | ||
|
|
3a97a808dc | ||
|
|
aa2e9adf68 | ||
|
|
a93e513847 | ||
|
|
8de50fbf59 | ||
|
|
e323b332b4 | ||
|
|
80dedc6c20 | ||
|
|
642c6ed223 | ||
|
|
51c59958d6 | ||
|
|
215856dc4d | ||
|
|
13f4116dd4 | ||
|
|
55b1ba4ff5 | ||
|
|
e39a67dd1b | ||
|
|
8ff1ae642b | ||
|
|
948bccaace | ||
|
|
db0b0e3e24 | ||
|
|
a97e05e2ce | ||
|
|
2bc7719b0f | ||
|
|
9576463f42 | ||
|
|
65becd0425 | ||
|
|
cf932e8655 | ||
|
|
fec6c55333 | ||
|
|
d9587dbcae | ||
|
|
552546fd9e | ||
|
|
750d9e82cd | ||
|
|
c838d378f8 | ||
|
|
49c9eaf8a9 | ||
|
|
359912252b | ||
|
|
31ba2d7780 | ||
|
|
a2bb2fe577 | ||
|
|
e162bbc127 | ||
|
|
6d1d175de9 | ||
|
|
1ea3bc54ec | ||
|
|
739c78f52f | ||
|
|
1b4e9c1bc7 | ||
|
|
5d76e1544d | ||
|
|
4f2e66ffd1 | ||
|
|
d4cb33db3b | ||
|
|
a3084f10ca | ||
|
|
b6eec5df5e | ||
|
|
1a32c3a4fd | ||
|
|
144f057fa6 | ||
|
|
29f748c1b9 | ||
|
|
efd60358af | ||
|
|
a62adc460d | ||
|
|
f9ca2b13c2 | ||
|
|
9bead086d6 | ||
|
|
afce853921 | ||
|
|
2aba630a78 | ||
|
|
1a3c51a90e |
No files matched your search
+23
-9
@@ -1,34 +1,48 @@
|
||||
---
|
||||
|
||||
version: 2.1
|
||||
|
||||
orbs:
|
||||
qqq-orb: kingsrook/qqq-orb@0.3.1
|
||||
qqq-orb: kingsrook/qqq-orb@0.6
|
||||
|
||||
workflows:
|
||||
|
||||
test_only:
|
||||
jobs:
|
||||
- qqq-orb/node_test_only:
|
||||
context: [ qqq-maven-registry-credentials, build-qqq-sample-app ]
|
||||
context: [qqq-maven-registry-credentials, build-qqq-sample-app]
|
||||
filters:
|
||||
branches:
|
||||
ignore: /(develop|main|release/.*|hotfix/.*|integration.*)/
|
||||
tags:
|
||||
only: []
|
||||
only: []
|
||||
|
||||
publish_snapshot:
|
||||
jobs:
|
||||
- qqq-orb/node_publish:
|
||||
context: [ qqq-maven-registry-credentials, build-qqq-sample-app ]
|
||||
context: [qqq-maven-registry-credentials, build-qqq-sample-app]
|
||||
branch_type: snapshot
|
||||
filters:
|
||||
branches:
|
||||
only:
|
||||
- develop
|
||||
|
||||
publish_feature:
|
||||
jobs:
|
||||
- qqq-orb/node_publish:
|
||||
context: [qqq-maven-registry-credentials, build-qqq-sample-app]
|
||||
branch_type: feature
|
||||
filters:
|
||||
branches:
|
||||
only:
|
||||
- feature/.*
|
||||
tags:
|
||||
only: [/publish.*/]
|
||||
|
||||
publish_release_candidate:
|
||||
jobs:
|
||||
- qqq-orb/node_publish:
|
||||
context: [ qqq-maven-registry-credentials, build-qqq-sample-app ]
|
||||
context: [qqq-maven-registry-credentials, build-qqq-sample-app]
|
||||
branch_type: release_candidate
|
||||
filters:
|
||||
branches:
|
||||
@@ -38,18 +52,18 @@ workflows:
|
||||
publish_release:
|
||||
jobs:
|
||||
- qqq-orb/node_publish:
|
||||
context: [ qqq-maven-registry-credentials, build-qqq-sample-app ]
|
||||
context: [qqq-maven-registry-credentials, build-qqq-sample-app]
|
||||
branch_type: release
|
||||
filters:
|
||||
branches:
|
||||
only: [ main ]
|
||||
only: [main]
|
||||
tags:
|
||||
only: [ /v.*/ ]
|
||||
only: [/v.*/]
|
||||
|
||||
publish_hotfix_release:
|
||||
jobs:
|
||||
- qqq-orb/node_publish:
|
||||
context: [ qqq-maven-registry-credentials, build-qqq-sample-app ]
|
||||
context: [qqq-maven-registry-credentials, build-qqq-sample-app]
|
||||
branch_type: hotfix
|
||||
filters:
|
||||
branches:
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
*.iml
|
||||
.env
|
||||
.yalc
|
||||
yalc*
|
||||
|
||||
node_modules
|
||||
coverage
|
||||
@@ -11,3 +13,7 @@ lib
|
||||
|
||||
**/.DS_Store
|
||||
*.iml
|
||||
|
||||
# Claude Code local settings
|
||||
.claude/
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
# Session State - qqq-frontend-core
|
||||
|
||||
## Last Session
|
||||
- **Date:** 2026-01-12
|
||||
- **Branch:** develop
|
||||
- **Version:** 0.40.2-SNAPSHOT (auto-bumped by CI)
|
||||
- **Status:** All tasks complete, ready to continue
|
||||
|
||||
## Completed This Session
|
||||
|
||||
### 1. qqq-frontend-core (npm)
|
||||
- Fixed stale `lib/` build issue (theme properties were missing)
|
||||
- Committed `f60d45c`: fix(build): ensure yalc-push rebuilds lib before pushing
|
||||
- Pipeline #341 succeeded
|
||||
- Published `@qrunio/qqq-frontend-core@0.40.1-SNAPSHOT` to npm
|
||||
- Verified 90+ QThemeMetaData properties in published package
|
||||
|
||||
### 2. qqq-frontend-material-dashboard (Maven)
|
||||
- Bumped to `0.40.1-SNAPSHOT` (commit `aadcb599`)
|
||||
- Fixed BOM dependency: `qqq.version=0.40.0-SNAPSHOT` (commit `cb6331a`)
|
||||
- Pipeline #1370 succeeded (21 min, includes Playwright tests)
|
||||
- Published to Maven Central snapshots
|
||||
|
||||
### 3. Views Dropdown Investigation
|
||||
- **Not a bug** - permission-based visibility
|
||||
- Requires `querySavedView`, `storeSavedView`, `deleteSavedView` process permissions
|
||||
- Documented in `docs/troubleshooting.md`
|
||||
|
||||
## Current State
|
||||
- All frontend artifacts at 0.40.1-SNAPSHOT and published
|
||||
- No pending code changes
|
||||
- Documentation created in `docs/` and `CLAUDE.md`
|
||||
|
||||
## To Continue
|
||||
Say "continue from last session" - Claude will read this file and CLAUDE.md.
|
||||
|
||||
## Open Items
|
||||
None - all tasks complete.
|
||||
@@ -0,0 +1,70 @@
|
||||
# QQQ Frontend Core - Project Context
|
||||
|
||||
## Overview
|
||||
TypeScript client library for QQQ frontends. Framework-agnostic (React, Vue, Angular, plain JS).
|
||||
|
||||
- **Package:** `@qrunio/qqq-frontend-core`
|
||||
- **Registry:** npm
|
||||
- **Current Version:** 0.40.1-SNAPSHOT
|
||||
|
||||
## Build System
|
||||
|
||||
### Key Scripts
|
||||
```bash
|
||||
npm run prepublishOnly # Clean rebuild: rm -rf lib/ && tsc -p ./ --outDir lib/
|
||||
npm run yalc-push # Local dev: rebuild + yalc push
|
||||
```
|
||||
|
||||
### Build Guarantee
|
||||
The `prepublishOnly` npm lifecycle hook ensures `lib/` is always rebuilt before publishing. This prevents stale build issues.
|
||||
|
||||
## Related Repositories
|
||||
|
||||
| Repo | Type | Relationship |
|
||||
|------|------|--------------|
|
||||
| `qqq-frontend-material-dashboard` | Maven JAR | React frontend, depends on this library |
|
||||
| `qqq` | Maven multi-module | Backend framework |
|
||||
|
||||
## Version Strategy
|
||||
Frontend repos can version independently from backend:
|
||||
- `qqq-frontend-core` and `qqq-frontend-material-dashboard` share version (currently 0.40.1-SNAPSHOT)
|
||||
- `qqq-frontend-material-dashboard` can use different `qqq.version` for backend deps (currently 0.40.0-SNAPSHOT)
|
||||
|
||||
## Key Classes
|
||||
|
||||
### QInstance (`src/model/metaData/QInstance.ts`)
|
||||
Main metaData container. Contains:
|
||||
- `tables: Map<string, QTableMetaData>`
|
||||
- `processes: Map<string, QProcessMetaData>`
|
||||
- `reports`, `widgets`, `apps`, `branding`, `theme`, etc.
|
||||
|
||||
### QThemeMetaData (`src/model/metaData/QThemeMetaData.ts`)
|
||||
90+ theme properties for UI customization. Includes colors, typography, component-specific styling.
|
||||
|
||||
## CI/CD
|
||||
|
||||
- **Platform:** CircleCI
|
||||
- **Orb:** `kingsrook/qqq-orb`
|
||||
- **Workflows:**
|
||||
- `test_only` - feature branches
|
||||
- `publish_snapshot` - develop branch
|
||||
- `publish_release` - main branch + tags
|
||||
|
||||
## Common Issues
|
||||
|
||||
### Stale lib/ Build
|
||||
**Symptom:** Published package missing recent changes
|
||||
**Cause:** `lib/` not rebuilt before publish
|
||||
**Fix:** `prepublishOnly` hook handles this automatically
|
||||
|
||||
### Views Dropdown Missing (Frontend)
|
||||
**Symptom:** "Views" dropdown not showing on table pages
|
||||
**Cause:** Permission-based visibility - requires process permissions
|
||||
**Fix:** Grant permissions for:
|
||||
- `querySavedView` (required to show dropdown)
|
||||
- `storeSavedView` (save functionality)
|
||||
- `deleteSavedView` (delete functionality)
|
||||
|
||||
## Session Continuity
|
||||
Session state is stored in `.session-state.md` (local to this repo).
|
||||
To continue: say "continue from last session"
|
||||
@@ -1,619 +1,202 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to the Licensor for inclusion in the Work by the copyright
|
||||
owner or by an individual or Legal Entity authorized to submit on
|
||||
behalf of the copyright owner. For the purposes of this definition,
|
||||
"submitted" means any form of electronic, verbal, or written
|
||||
communication sent to the Licensor or its representatives, including
|
||||
but not limited to communication on electronic mailing lists, source
|
||||
code control systems, and issue tracking systems that are managed by,
|
||||
or on behalf of, the Licensor for the purpose of discussing and
|
||||
improving the Work, but excluding communication that is conspicuously
|
||||
marked or otherwise designated in writing by the copyright owner as
|
||||
"Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 2022-2025 QRunIO, LLC
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@@ -0,0 +1,15 @@
|
||||
QQQ Frontend Core
|
||||
Copyright 2022-2025 QRunIO, LLC
|
||||
|
||||
This product includes software developed at QRunIO, LLC (https://qrun.io/).
|
||||
|
||||
Licensed under the Apache License, Version 2.0.
|
||||
|
||||
================================================================================
|
||||
|
||||
Trademarks:
|
||||
|
||||
QQQ, qBits, qRun, qStudio, and the QRunIO logo are trademarks of QRunIO, LLC.
|
||||
Use of these trademarks must comply with QRunIO's Trademark Guidelines.
|
||||
|
||||
================================================================================
|
||||
@@ -1,516 +1,155 @@
|
||||
# QQQ Frontend Core
|
||||
# qqq-frontend-core
|
||||
|
||||
[](https://github.com/Kingsrook/qqq-frontend-core)
|
||||
[](https://www.gnu.org/licenses/agpl-3.0.en.html)
|
||||
[](https://www.typescriptlang.org/)
|
||||
[](https://www.npmjs.com/package/@qrunio/qqq-frontend-core)
|
||||
TypeScript client library for building frontends on QQQ applications.
|
||||
|
||||
> **Core Frontend Library for QQQ - Low-code Application Framework for Engineers**
|
||||
**For:** Developers building custom UIs or integrating QQQ into existing applications
|
||||
**Status:** Stable
|
||||
|
||||
A TypeScript/JavaScript library that provides the core client-side functionality for interacting with QQQ backend servers. This library is framework-agnostic and can be used in any JavaScript environment, including React, Vue, Angular, or vanilla JavaScript applications.
|
||||
## Why This Exists
|
||||
|
||||
## 🚀 Overview
|
||||
QQQ applications expose a backend API for metadata, records, and processes. If you're building a custom frontend instead of using the standard dashboard, you need a client that:
|
||||
|
||||
QQQ Frontend Core is the **foundational library** that enables frontend applications to communicate with QQQ backend servers. It provides:
|
||||
- Understands QQQ's metadata-driven architecture
|
||||
- Handles authentication flows (OAuth2, tokens)
|
||||
- Provides typed interfaces for records, queries, and processes
|
||||
- Manages API communication reliably
|
||||
|
||||
- **HTTP Client**: Axios-based HTTP client for QQQ API interactions
|
||||
- **Data Models**: TypeScript interfaces and classes for QQQ data structures
|
||||
- **Controllers**: High-level abstractions for common QQQ operations
|
||||
- **Exception Handling**: Standardized error handling for QQQ operations
|
||||
- **Authentication**: Built-in authentication management and token handling
|
||||
This library is that client. It's framework-agnostic - use it with React, Vue, Angular, or plain JavaScript.
|
||||
|
||||
### What This Repository Contains
|
||||
If you want a ready-to-use admin UI, use [qqq-frontend-material-dashboard](https://github.com/QRun-IO/qqq-frontend-material-dashboard) instead. It's built on this library.
|
||||
|
||||
- **Core Library**: TypeScript/JavaScript library for QQQ client operations
|
||||
- **Data Models**: Complete type definitions for QQQ metadata and data structures
|
||||
- **HTTP Controllers**: Controllers for interacting with QQQ backend APIs
|
||||
- **Exception Classes**: Standardized error handling for QQQ operations
|
||||
- **Type Definitions**: Full TypeScript support with strict typing
|
||||
## Features
|
||||
|
||||
### What This Repository Does NOT Contain
|
||||
- **Typed API client** - Full TypeScript support for QQQ operations
|
||||
- **Metadata loading** - Fetch table, process, and app definitions from QQQ
|
||||
- **Record CRUD** - Create, read, update, delete with query filters
|
||||
- **Process execution** - Run backend processes with parameter passing
|
||||
- **Auth handling** - OAuth2, bearer tokens, and custom auth flows
|
||||
- **Error normalization** - Consistent exception handling across operations
|
||||
|
||||
- **QQQ Server**: The actual low-code engine and backend
|
||||
- **UI Components**: Visual components or user interface elements
|
||||
- **Framework Bindings**: React, Vue, or Angular specific implementations
|
||||
- **Business Logic**: Application-specific business rules or processes
|
||||
## Quick Start
|
||||
|
||||
## 🏗️ Architecture
|
||||
|
||||
### Technology Stack
|
||||
|
||||
- **Language**: TypeScript with strict typing
|
||||
- **HTTP Client**: Axios for HTTP requests
|
||||
- **Build Tool**: TypeScript compiler with ES modules
|
||||
- **Testing**: Jest with TypeScript support
|
||||
- **Linting**: ESLint with TypeScript rules
|
||||
|
||||
### Core Dependencies
|
||||
|
||||
- **axios**: HTTP client for API communication
|
||||
- **form-data**: Form data handling for file uploads
|
||||
- **TypeScript**: Type safety and modern JavaScript features
|
||||
|
||||
### Development Dependencies
|
||||
|
||||
- **jest**: Testing framework
|
||||
- **eslint**: Code quality and style enforcement
|
||||
- **typescript**: TypeScript compiler and tools
|
||||
|
||||
## 📁 Project Structure
|
||||
|
||||
```
|
||||
src/
|
||||
├── controllers/ # HTTP controllers for QQQ operations
|
||||
│ ├── QController.ts # Main controller for QQQ interactions
|
||||
│ └── QControllerV1.ts # Version 1 controller implementation
|
||||
├── model/ # Data models and type definitions
|
||||
│ ├── metaData/ # QQQ metadata models
|
||||
│ │ ├── QInstance.ts # QQQ instance metadata
|
||||
│ │ ├── QTableMetaData.ts # Table structure definitions
|
||||
│ │ ├── QProcessMetaData.ts # Process definitions
|
||||
│ │ ├── QAppMetaData.ts # Application metadata
|
||||
│ │ └── ... # Other metadata models
|
||||
│ ├── query/ # Query and filter models
|
||||
│ ├── processes/ # Process execution models
|
||||
│ ├── QRecord.ts # Data record model
|
||||
│ └── QPossibleValue.ts # Possible value model
|
||||
├── exceptions/ # Exception handling
|
||||
│ └── QException.ts # Standard QQQ exception class
|
||||
└── qqq-frontend-core.ts # Main library entry point
|
||||
```
|
||||
|
||||
## 🎯 Core Functionality
|
||||
|
||||
### HTTP Controllers
|
||||
|
||||
The library provides high-level controllers for common QQQ operations:
|
||||
|
||||
```typescript
|
||||
import { QController } from '@qrunio/qqq-frontend-core';
|
||||
|
||||
const controller = new QController('https://your-qqq-server.com');
|
||||
|
||||
// Load metadata
|
||||
const metadata = await controller.loadMetaData();
|
||||
|
||||
// Query records
|
||||
const records = await controller.queryRecords('tableName', filters);
|
||||
|
||||
// Execute processes
|
||||
const result = await controller.executeProcess('processName', parameters);
|
||||
```
|
||||
|
||||
### Data Models
|
||||
|
||||
Complete TypeScript models for all QQQ data structures:
|
||||
|
||||
```typescript
|
||||
import {
|
||||
QInstance,
|
||||
QTableMetaData,
|
||||
QProcessMetaData
|
||||
} from '@qrunio/qqq-frontend-core';
|
||||
|
||||
// Instance metadata
|
||||
const instance: QInstance = new QInstance(rawData);
|
||||
|
||||
// Table metadata
|
||||
const table: QTableMetaData = new QTableMetaData(tableData);
|
||||
|
||||
// Process metadata
|
||||
const process: QProcessMetaData = new QProcessMetaData(processData);
|
||||
```
|
||||
|
||||
### Exception Handling
|
||||
|
||||
Standardized error handling for QQQ operations:
|
||||
|
||||
```typescript
|
||||
import { QException } from '@qrunio/qqq-frontend-core';
|
||||
|
||||
try {
|
||||
const result = await controller.executeProcess('processName', params);
|
||||
} catch (error) {
|
||||
if (error instanceof QException) {
|
||||
console.error(`QQQ Error: ${error.message} (Status: ${error.status})`);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
### Installation
|
||||
**Prerequisites:** Node.js 18+
|
||||
|
||||
```bash
|
||||
npm install @qrunio/qqq-frontend-core
|
||||
```
|
||||
|
||||
### Basic Usage
|
||||
|
||||
```typescript
|
||||
import { QController } from '@qrunio/qqq-frontend-core';
|
||||
|
||||
// Create controller instance
|
||||
const controller = new QController('https://your-qqq-server.com');
|
||||
const api = new QController('https://your-qqq-server.com');
|
||||
|
||||
// Set authentication (if required)
|
||||
controller.setAuthorizationHeaderValue('Bearer your-token');
|
||||
|
||||
// Load QQQ instance metadata
|
||||
const metadata = await controller.loadMetaData();
|
||||
|
||||
// Query records from a table
|
||||
const records = await controller.queryRecords('users', {
|
||||
filters: [{ field: 'active', operator: '=', value: true }],
|
||||
limit: 100
|
||||
});
|
||||
|
||||
// Execute a process
|
||||
const result = await controller.executeProcess('sendNotification', {
|
||||
userId: 123,
|
||||
message: 'Hello World'
|
||||
});
|
||||
```
|
||||
|
||||
### Advanced Usage
|
||||
|
||||
```typescript
|
||||
// Custom exception handler
|
||||
const controller = new QController('https://your-qqq-server.com', (error) => {
|
||||
console.error('Custom error handling:', error);
|
||||
// Handle error appropriately
|
||||
});
|
||||
|
||||
// Set custom timeout
|
||||
controller.setStepTimeoutMillis(120000); // 2 minutes
|
||||
|
||||
// Handle authentication
|
||||
controller.setAuthenticationMetaData({
|
||||
type: 'OAUTH2',
|
||||
clientId: 'your-client-id',
|
||||
// ... other auth config
|
||||
});
|
||||
```
|
||||
|
||||
## 🔧 Configuration
|
||||
|
||||
### Environment Setup
|
||||
|
||||
```typescript
|
||||
// Development
|
||||
const controller = new QController('http://localhost:8080');
|
||||
|
||||
// Production
|
||||
const controller = new QController('https://api.yourdomain.com');
|
||||
|
||||
// With custom configuration
|
||||
const controller = new QController('https://api.yourdomain.com', {
|
||||
timeout: 30000,
|
||||
headers: {
|
||||
'X-Custom-Header': 'value'
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Authentication Configuration
|
||||
|
||||
```typescript
|
||||
// OAuth2
|
||||
controller.setAuthenticationMetaData({
|
||||
type: 'OAUTH2',
|
||||
clientId: 'your-client-id',
|
||||
clientSecret: 'your-client-secret',
|
||||
authorizationUrl: 'https://auth.yourdomain.com/oauth2/authorize',
|
||||
tokenUrl: 'https://auth.yourdomain.com/oauth2/token'
|
||||
});
|
||||
|
||||
// Custom token
|
||||
controller.setAuthorizationHeaderValue('Bearer your-jwt-token');
|
||||
```
|
||||
|
||||
## 🧪 Testing
|
||||
|
||||
### Running Tests
|
||||
|
||||
```bash
|
||||
# Run all tests
|
||||
npm test
|
||||
|
||||
# Run tests in watch mode
|
||||
npm test -- --watch
|
||||
|
||||
# Run tests with coverage
|
||||
npm test -- --coverage
|
||||
```
|
||||
|
||||
### Test Structure
|
||||
|
||||
- **Unit Tests**: Individual component testing
|
||||
- **Integration Tests**: Controller and model testing
|
||||
- **Mock Data**: Comprehensive test fixtures
|
||||
|
||||
## 📦 Building for Production
|
||||
|
||||
### Build Process
|
||||
|
||||
```bash
|
||||
# Clean and build
|
||||
npm run clean-and-install
|
||||
npm run prepublishOnly
|
||||
```
|
||||
|
||||
The build process:
|
||||
- Compiles TypeScript to JavaScript
|
||||
- Generates ES modules and CommonJS outputs
|
||||
- Creates optimized production bundles
|
||||
- Generates type definitions
|
||||
|
||||
### Output Files
|
||||
|
||||
- **lib/**: Compiled JavaScript files
|
||||
- **qqq-frontend-core.js**: CommonJS bundle
|
||||
- **qqq-frontend-core.esm.js**: ES module bundle
|
||||
- **Type definitions**: Full TypeScript support
|
||||
|
||||
## 🔐 Authentication
|
||||
|
||||
### Supported Authentication Methods
|
||||
|
||||
1. **OAuth2**: Standard OAuth2 flow
|
||||
2. **Custom Tokens**: JWT or other token-based auth
|
||||
3. **API Keys**: Simple API key authentication
|
||||
|
||||
### Authentication Flow
|
||||
|
||||
```typescript
|
||||
// OAuth2 flow
|
||||
await controller.authenticateOAuth2({
|
||||
username: 'user@example.com',
|
||||
password: 'password'
|
||||
});
|
||||
|
||||
// Custom token
|
||||
controller.setAuthorizationHeaderValue('Bearer token');
|
||||
|
||||
// Check authentication status
|
||||
const isAuthenticated = controller.isAuthenticated();
|
||||
```
|
||||
|
||||
## 📊 Data Management
|
||||
|
||||
### Record Operations
|
||||
|
||||
```typescript
|
||||
// Create record
|
||||
const newRecord = await controller.createRecord('users', {
|
||||
name: 'John Doe',
|
||||
email: 'john@example.com'
|
||||
});
|
||||
|
||||
// Update record
|
||||
const updatedRecord = await controller.updateRecord('users', 123, {
|
||||
name: 'John Smith'
|
||||
});
|
||||
|
||||
// Delete record
|
||||
await controller.deleteRecord('users', 123);
|
||||
// Load what tables and processes exist
|
||||
const metadata = await api.loadMetaData();
|
||||
console.log('Tables:', [...metadata.tables.keys()]);
|
||||
|
||||
// Query records
|
||||
const records = await controller.queryRecords('users', {
|
||||
filters: [{ field: 'active', operator: '=', value: true }],
|
||||
sort: [{ field: 'name', direction: 'ASC' }],
|
||||
limit: 50,
|
||||
offset: 0
|
||||
const users = await api.queryRecords('user', {
|
||||
filters: [{ field: 'isActive', operator: '=', value: true }],
|
||||
limit: 10
|
||||
});
|
||||
```
|
||||
|
||||
### Process Execution
|
||||
## Usage
|
||||
|
||||
### Authentication
|
||||
|
||||
```typescript
|
||||
// Execute process
|
||||
const result = await controller.executeProcess('sendEmail', {
|
||||
to: 'user@example.com',
|
||||
subject: 'Welcome',
|
||||
body: 'Welcome to our platform!'
|
||||
// Bearer token (simplest)
|
||||
api.setAuthorizationHeaderValue('Bearer your-jwt-token');
|
||||
|
||||
// OAuth2
|
||||
api.setAuthenticationMetaData({
|
||||
type: 'OAUTH2',
|
||||
clientId: 'your-client-id',
|
||||
tokenUrl: 'https://auth.example.com/token'
|
||||
});
|
||||
|
||||
// Monitor process status
|
||||
const status = await controller.getProcessStatus('process-id');
|
||||
|
||||
// Cancel process
|
||||
await controller.cancelProcess('process-id');
|
||||
```
|
||||
|
||||
## 🎨 Integration Examples
|
||||
|
||||
### React Integration
|
||||
### Working with Records
|
||||
|
||||
```typescript
|
||||
import React, { useEffect, useState } from 'react';
|
||||
import { QController, QInstance } from '@qrunio/qqq-frontend-core';
|
||||
// Create
|
||||
const order = await api.createRecord('order', {
|
||||
customerId: 42,
|
||||
status: 'pending'
|
||||
});
|
||||
|
||||
function QQQApp() {
|
||||
const [metadata, setMetadata] = useState<QInstance | null>(null);
|
||||
const [loading, setLoading] = useState(true);
|
||||
// Read
|
||||
const record = await api.getRecord('order', order.id);
|
||||
|
||||
useEffect(() => {
|
||||
const controller = new QController('https://your-qqq-server.com');
|
||||
|
||||
controller.loadMetaData()
|
||||
.then(setMetadata)
|
||||
.finally(() => setLoading(false));
|
||||
}, []);
|
||||
// Update
|
||||
await api.updateRecord('order', order.id, { status: 'shipped' });
|
||||
|
||||
if (loading) return <div>Loading...</div>;
|
||||
if (!metadata) return <div>No metadata available</div>;
|
||||
// Delete
|
||||
await api.deleteRecord('order', order.id);
|
||||
|
||||
return (
|
||||
<div>
|
||||
<h1>QQQ Application</h1>
|
||||
<p>Tables: {metadata.tables?.size || 0}</p>
|
||||
<p>Processes: {metadata.processes?.size || 0}</p>
|
||||
</div>
|
||||
);
|
||||
// Query with filters
|
||||
const pending = await api.queryRecords('order', {
|
||||
filters: [{ field: 'status', operator: '=', value: 'pending' }],
|
||||
sort: [{ field: 'createdAt', direction: 'DESC' }],
|
||||
limit: 50
|
||||
});
|
||||
```
|
||||
|
||||
### Running Processes
|
||||
|
||||
```typescript
|
||||
const result = await api.executeProcess('generateInvoice', {
|
||||
orderId: 123,
|
||||
format: 'pdf'
|
||||
});
|
||||
```
|
||||
|
||||
### Error Handling
|
||||
|
||||
```typescript
|
||||
import { QException } from '@qrunio/qqq-frontend-core';
|
||||
|
||||
try {
|
||||
await api.executeProcess('riskyOperation', params);
|
||||
} catch (e) {
|
||||
if (e instanceof QException) {
|
||||
console.error(`QQQ error: ${e.message} (${e.status})`);
|
||||
}
|
||||
throw e;
|
||||
}
|
||||
```
|
||||
|
||||
### Vue Integration
|
||||
## Configuration
|
||||
|
||||
```typescript
|
||||
import { defineComponent, ref, onMounted } from 'vue';
|
||||
import { QController, QInstance } from '@qrunio/qqq-frontend-core';
|
||||
// Custom timeout (default: 60s)
|
||||
api.setStepTimeoutMillis(120000);
|
||||
|
||||
export default defineComponent({
|
||||
setup() {
|
||||
const metadata = ref<QInstance | null>(null);
|
||||
const loading = ref(true);
|
||||
|
||||
onMounted(async () => {
|
||||
const controller = new QController('https://your-qqq-server.com');
|
||||
|
||||
try {
|
||||
metadata.value = await controller.loadMetaData();
|
||||
} finally {
|
||||
loading.value = false;
|
||||
}
|
||||
});
|
||||
|
||||
return { metadata, loading };
|
||||
}
|
||||
// Global error handler
|
||||
const api = new QController('https://...', (error) => {
|
||||
logToMonitoring(error);
|
||||
});
|
||||
```
|
||||
|
||||
### Vanilla JavaScript
|
||||
## Project Status
|
||||
|
||||
```javascript
|
||||
import { QController } from '@qrunio/qqq-frontend-core';
|
||||
**Maturity:** Stable, used in production
|
||||
**Breaking changes:** Follow semver; major versions may break API
|
||||
|
||||
const controller = new QController('https://your-qqq-server.com');
|
||||
**Roadmap:**
|
||||
- WebSocket support for real-time updates
|
||||
- Request batching for bulk operations
|
||||
- Offline queue for intermittent connectivity
|
||||
|
||||
// Load metadata
|
||||
controller.loadMetaData()
|
||||
.then(metadata => {
|
||||
console.log('Tables:', metadata.tables);
|
||||
console.log('Processes:', metadata.processes);
|
||||
})
|
||||
.catch(error => {
|
||||
console.error('Error loading metadata:', error);
|
||||
});
|
||||
## Contributing
|
||||
|
||||
```bash
|
||||
git clone https://github.com/QRun-IO/qqq-frontend-core
|
||||
cd qqq-frontend-core
|
||||
npm install
|
||||
npm test
|
||||
```
|
||||
|
||||
## 🚀 Performance
|
||||
Submit issues and PRs to the [main QQQ repository](https://github.com/QRun-IO/qqq/issues).
|
||||
|
||||
### Optimization Features
|
||||
|
||||
- **Memoization**: Cached metadata promises
|
||||
- **Connection Reuse**: Persistent HTTP connections
|
||||
- **Batch Operations**: Efficient bulk operations
|
||||
- **Lazy Loading**: On-demand metadata loading
|
||||
|
||||
### Best Practices
|
||||
|
||||
- **Reuse Controllers**: Don't create new controllers unnecessarily
|
||||
- **Cache Metadata**: Use cached metadata when possible
|
||||
- **Handle Errors**: Implement proper error handling
|
||||
- **Monitor Performance**: Track API response times
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
**Important**: This repository is a core component of the QQQ framework. All contributions, issues, and discussions should go through the main QQQ repository.
|
||||
|
||||
### Development Workflow
|
||||
|
||||
1. **Fork the main QQQ repository**: https://github.com/Kingsrook/qqq
|
||||
2. **Create a feature branch**: `git checkout -b feature/amazing-feature`
|
||||
3. **Make your changes** (including core library changes if applicable)
|
||||
4. **Run tests**: `npm test`
|
||||
5. **Commit your changes**: `git commit -m 'Add amazing feature'`
|
||||
6. **Push to the branch**: `git push origin feature/amazing-feature`
|
||||
7. **Open a Pull Request** to the main QQQ repository
|
||||
|
||||
### Code Standards
|
||||
|
||||
- **TypeScript**: Strict type checking enabled
|
||||
- **ESLint**: Code quality and style enforcement
|
||||
- **Testing**: Comprehensive test coverage
|
||||
- **Documentation**: Clear API documentation
|
||||
|
||||
## 📄 License
|
||||
|
||||
This project is licensed under the GNU Affero General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
```
|
||||
QQQ Frontend Core
|
||||
Copyright (C) 2021-2022 Kingsrook, LLC
|
||||
651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
contact@kingsrook.com | https://github.com/Kingsrook/
|
||||
```
|
||||
|
||||
**Note**: This is a core component of the QQQ framework. For the complete license and more information, see the main QQQ repository: https://github.com/Kingsrook/qqq
|
||||
|
||||
## 🆘 Support & Community
|
||||
|
||||
### ⚠️ Important: Use Main QQQ Repository
|
||||
|
||||
**All support, issues, discussions, and community interactions should go through the main QQQ repository:**
|
||||
|
||||
- **Main Repository**: https://github.com/Kingsrook/qqq
|
||||
- **Issues**: https://github.com/Kingsrook/qqq/issues
|
||||
- **Discussions**: https://github.com/Kingsrook/qqq/discussions
|
||||
- **Wiki**: https://github.com/Kingsrook/qqq.wiki
|
||||
|
||||
### Why This Repository Exists
|
||||
|
||||
This repository is maintained separately from the main QQQ repository to:
|
||||
- **Enable independent library development** and versioning
|
||||
- **Allow library-specific CI/CD** and deployment pipelines
|
||||
- **Provide clear separation** between core library and framework concerns
|
||||
- **Support different release cycles** for library vs. framework updates
|
||||
|
||||
### Getting Help
|
||||
|
||||
- **Documentation**: Check the [QQQ Wiki](https://github.com/Kingsrook/qqq.wiki)
|
||||
- **Issues**: Report bugs and feature requests on [Main QQQ Issues](https://github.com/Kingsrook/qqq/issues)
|
||||
- **Discussions**: Join community discussions on [Main QQQ Discussions](https://github.com/Kingsrook/qqq/discussions)
|
||||
- **Questions**: Ask questions in the main QQQ repository
|
||||
|
||||
### Contact Information
|
||||
|
||||
- **Company**: Kingsrook, LLC
|
||||
- **Email**: contact@kingsrook.com
|
||||
- **Website**: https://kingsrook.com
|
||||
- **Main GitHub**: https://github.com/Kingsrook/qqq
|
||||
|
||||
## 🙏 Acknowledgments
|
||||
|
||||
- **TypeScript Team**: For the powerful type system
|
||||
- **Axios Team**: For the excellent HTTP client library
|
||||
- **QQQ Framework Team**: For the underlying low-code platform
|
||||
- **Open Source Community**: For the tools and libraries that make this possible
|
||||
|
||||
---
|
||||
|
||||
**Built with ❤️ by the Kingsrook Team**
|
||||
|
||||
**This is a core library component of the QQQ framework. For complete information, support, and community, visit: https://github.com/Kingsrook/qqq**
|
||||
## License
|
||||
|
||||
AGPL-3.0
|
||||
@@ -0,0 +1,55 @@
|
||||
# Troubleshooting
|
||||
|
||||
## Views Dropdown Missing on Table Pages
|
||||
|
||||
### Symptom
|
||||
The "Views" dropdown (for saving/loading filter presets) is not visible on table pages.
|
||||
|
||||
### Root Cause
|
||||
The SavedViews component visibility is **permission-based**. It checks:
|
||||
|
||||
```typescript
|
||||
const hasQueryPermission = metaData?.processes.has("querySavedView");
|
||||
// Only renders if hasQueryPermission && tableMetaData
|
||||
```
|
||||
|
||||
### Solution
|
||||
Grant users permission to these processes:
|
||||
|
||||
| Process | Purpose |
|
||||
|---------|---------|
|
||||
| `querySavedView` | **Required** - show dropdown, load views |
|
||||
| `storeSavedView` | Save/update views |
|
||||
| `deleteSavedView` | Delete views |
|
||||
|
||||
In your QQQ app's permission configuration:
|
||||
```java
|
||||
.withProcessPermission("querySavedView", true)
|
||||
.withProcessPermission("storeSavedView", true)
|
||||
.withProcessPermission("deleteSavedView", true)
|
||||
```
|
||||
|
||||
### Related Files
|
||||
- Frontend: `SavedViews.tsx` in qqq-frontend-material-dashboard
|
||||
- Backend: `SavedViewsMetaDataProvider.java` in qqq-backend-core
|
||||
|
||||
---
|
||||
|
||||
## Stale lib/ Build
|
||||
|
||||
### Symptom
|
||||
Published npm package is missing recent TypeScript changes.
|
||||
|
||||
### Root Cause
|
||||
The `lib/` directory wasn't rebuilt before publishing.
|
||||
|
||||
### Solution
|
||||
The `prepublishOnly` hook in `package.json` now handles this:
|
||||
```json
|
||||
"prepublishOnly": "rm -rf lib/ && tsc -p ./ --outDir lib/"
|
||||
```
|
||||
|
||||
For local development with yalc:
|
||||
```bash
|
||||
npm run yalc-push # Runs prepublishOnly first
|
||||
```
|
||||
@@ -0,0 +1,42 @@
|
||||
# Version Management
|
||||
|
||||
## Current Versions (as of 2026-01-12)
|
||||
|
||||
| Package | Version | Registry |
|
||||
|---------|---------|----------|
|
||||
| `@qrunio/qqq-frontend-core` | 0.40.1-SNAPSHOT | npm |
|
||||
| `qqq-frontend-material-dashboard` | 0.40.1-SNAPSHOT | Maven Central |
|
||||
| `qqq` (backend) | 0.40.0-SNAPSHOT | Maven Central |
|
||||
|
||||
## Frontend vs Backend Versioning
|
||||
|
||||
Frontend repos can version independently from the backend. In `qqq-frontend-material-dashboard`:
|
||||
|
||||
```xml
|
||||
<properties>
|
||||
<revision>0.40.1-SNAPSHOT</revision> <!-- This artifact's version -->
|
||||
<qqq.version>0.40.0-SNAPSHOT</qqq.version> <!-- Backend dependency version -->
|
||||
</properties>
|
||||
```
|
||||
|
||||
This allows frontend-only releases without requiring a full backend release.
|
||||
|
||||
## Version Bump Process
|
||||
|
||||
### qqq-frontend-core (npm)
|
||||
1. Update `version` in `package.json`
|
||||
2. Push to develop branch
|
||||
3. CI automatically publishes to npm
|
||||
|
||||
### qqq-frontend-material-dashboard (Maven)
|
||||
1. Update `revision` property in `pom.xml`
|
||||
2. Optionally update `qqq.version` if backend changes needed
|
||||
3. Push to develop branch
|
||||
4. CI runs Playwright tests + publishes to Maven Central
|
||||
|
||||
## CI/CD Orb Behavior
|
||||
|
||||
The `kingsrook/qqq-orb` `calculate_version.sh` script:
|
||||
- For develop branch with existing SNAPSHOT: keeps current version
|
||||
- Only bumps version on release merges or RC versions
|
||||
- Each repo manages its own version independently
|
||||
Generated
+4
-4
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "@kingsrook/qqq-frontend-core",
|
||||
"version": "1.0.127-SNAPSHOT",
|
||||
"name": "@qrunio/qqq-frontend-core",
|
||||
"version": "0.40.6-SNAPSHOT",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@kingsrook/qqq-frontend-core",
|
||||
"version": "1.0.127-SNAPSHOT",
|
||||
"name": "@qrunio/qqq-frontend-core",
|
||||
"version": "0.40.6-SNAPSHOT",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"axios": "0.28.1",
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@qrunio/qqq-frontend-core",
|
||||
"version": "1.1.0",
|
||||
"version": "0.40.11-SNAPSHOT",
|
||||
"description": "",
|
||||
"main": "qqq-frontend-core.js",
|
||||
"module": "lib/qqq-frontend-core.esm.js",
|
||||
@@ -11,7 +11,7 @@
|
||||
"clean-and-install": "rm -rf node_modules/ && rm -rf package-lock.json && rm -rf lib/ && npm install",
|
||||
"prepublishOnly": "rm -rf lib/ && tsc -p ./ --outDir lib/",
|
||||
"test": "jest",
|
||||
"yalc-push": "yalc push --private",
|
||||
"yalc-push": "npm run prepublishOnly && yalc push --private",
|
||||
"yalc-watch": "yalc-watch"
|
||||
},
|
||||
"dependencies": {
|
||||
|
||||
+101
-12
@@ -19,7 +19,7 @@
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import {AxiosError, AxiosResponse} from "axios";
|
||||
import {AxiosError, AxiosRequestConfig, AxiosResponse} from "axios";
|
||||
import FormData from "form-data";
|
||||
import {QException} from "../exceptions/QException";
|
||||
import {QAuthenticationMetaData} from "../model/metaData/QAuthenticationMetaData";
|
||||
@@ -783,13 +783,15 @@ export class QController
|
||||
}
|
||||
}
|
||||
|
||||
const axiosConfigExtras: AxiosRequestConfig = {};
|
||||
if (dontGoAsyncOnBackend)
|
||||
{
|
||||
formDataOrQueryString.append("_qStepTimeoutMillis", 300 * 1000);
|
||||
axiosConfigExtras.timeout = 300 * 1000;
|
||||
}
|
||||
|
||||
return this.axiosInstance
|
||||
.post(url, formDataOrQueryString, {headers: formDataHeaders})
|
||||
.post(url, formDataOrQueryString, {headers: formDataHeaders, ...axiosConfigExtras})
|
||||
.then((response: AxiosResponse) =>
|
||||
{
|
||||
const responseObject = this.parseProcessResponse(response);
|
||||
@@ -899,7 +901,7 @@ export class QController
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Fetch the data for a specific widget.
|
||||
** Fetch the data about variants for a table
|
||||
*******************************************************************************/
|
||||
async tableVariants(tableName: string): Promise<QTableVariant[]>
|
||||
{
|
||||
@@ -933,24 +935,48 @@ export class QController
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Fetch the data for a specific widget.
|
||||
* Fetch the data for a specific widget.
|
||||
*
|
||||
* Originally, this was a GET request, with params passed on the query string.
|
||||
* However, that fails if params get too long. So, in 10/2025, qqq-javalin
|
||||
* is being updated to serve /widget/{widgetName} as a POST.
|
||||
*
|
||||
* This method, for some attempted backward compatibility, will first *try* a
|
||||
* POST. If it fails with a 404 (which an older version (w/o the POST endpoint)
|
||||
* would return), then, assuming the params are a string (not FormData), then
|
||||
* this method will automatically re-try the request as a GET.
|
||||
*******************************************************************************/
|
||||
async widget(widgetName: string, urlParams?: string): Promise<any>
|
||||
async widget(widgetName: string, params?: string | FormData, overrideAbortName?: string): Promise<any>
|
||||
{
|
||||
let url = `/widget/${encodeURIComponent(widgetName)}`;
|
||||
if (urlParams)
|
||||
const abortName = overrideAbortName ?? widgetName;
|
||||
|
||||
const paramsAreFormData = params instanceof FormData
|
||||
let postBody: FormData;
|
||||
if (paramsAreFormData)
|
||||
{
|
||||
url += `?${urlParams}`;
|
||||
postBody = params;
|
||||
}
|
||||
else
|
||||
{
|
||||
postBody = new FormData();
|
||||
if (params)
|
||||
{
|
||||
for (let pair of params.split("&"))
|
||||
{
|
||||
let [name, value] = pair.split("=");
|
||||
postBody.append(name, decodeURIComponent(value));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////////////////////
|
||||
// see if an abort controller was created for this widget name //
|
||||
/////////////////////////////////////////////////////////////////
|
||||
console.log("Looking for controller for widget [" + widgetName + "]");
|
||||
let controller = QController.widgetAbortControllerMap.get(widgetName);
|
||||
let controller = QController.widgetAbortControllerMap.get(abortName);
|
||||
if (controller)
|
||||
{
|
||||
console.log(`Found existing abort controller for widget '${widgetName}', aborting...`);
|
||||
console.log(`Found existing abort controller for widget '${abortName}', aborting...`);
|
||||
controller.abort();
|
||||
}
|
||||
|
||||
@@ -959,7 +985,69 @@ export class QController
|
||||
/////////////////////////////////////////
|
||||
controller = new AbortController();
|
||||
const signal = controller.signal;
|
||||
QController.widgetAbortControllerMap.set(widgetName, controller);
|
||||
QController.widgetAbortControllerMap.set(abortName, controller);
|
||||
|
||||
return this.axiosInstance
|
||||
.post(url, postBody, {signal})
|
||||
.then((response: AxiosResponse) =>
|
||||
{
|
||||
///////////////////////////////////////////////////
|
||||
// make sure to clear out the request controller //
|
||||
///////////////////////////////////////////////////
|
||||
QController.widgetAbortControllerMap.set(abortName, null);
|
||||
return response.data;
|
||||
})
|
||||
.catch(async (e: any) =>
|
||||
{
|
||||
///////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// if the server responded with 404, assume this could be due to the backend not supporting POST for //
|
||||
// the widget endpoint - so if we took in params as a string (not FormData), then try to do a GET //
|
||||
///////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
if(e?.response?.status == 404)
|
||||
{
|
||||
if(!paramsAreFormData)
|
||||
{
|
||||
return await this.getWidget(widgetName, params, overrideAbortName);
|
||||
}
|
||||
else
|
||||
{
|
||||
console.log("widget POST request failed with 404 - but params are FormData, so we cannot attempt a fallback-GET...");
|
||||
}
|
||||
}
|
||||
|
||||
if (e.code && e.code === "ERR_CANCELED")
|
||||
{
|
||||
console.log("Controller request cancellation successful!");
|
||||
return;
|
||||
}
|
||||
this.handleException(e);
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
* Fetch the data for a specific widget, doing a GET.
|
||||
* This HTTP method is being deprecated for rendering widgets, due to query
|
||||
* string being too limited in size, compared to the relative unlimited size of
|
||||
* POST body - but this method is here for a backward-compatibility later - in
|
||||
* case hitting a backend server that 404'ed for the POST call.
|
||||
*******************************************************************************/
|
||||
private async getWidget(widgetName: string, urlParams?: string, overrideAbortName?: string): Promise<any>
|
||||
{
|
||||
const abortName = overrideAbortName ?? widgetName;
|
||||
|
||||
let url = `/widget/${encodeURIComponent(widgetName)}`;
|
||||
if(urlParams)
|
||||
{
|
||||
url += `?${urlParams}`;
|
||||
}
|
||||
|
||||
/////////////////////////////////////////
|
||||
// keep track of this widget's request //
|
||||
/////////////////////////////////////////
|
||||
const controller = new AbortController();
|
||||
const signal = controller.signal;
|
||||
QController.widgetAbortControllerMap.set(abortName, controller);
|
||||
|
||||
return this.axiosInstance
|
||||
.get(url, {signal})
|
||||
@@ -968,7 +1056,7 @@ export class QController
|
||||
///////////////////////////////////////////////////
|
||||
// make sure to clear out the request controller //
|
||||
///////////////////////////////////////////////////
|
||||
QController.widgetAbortControllerMap.set(widgetName, null);
|
||||
QController.widgetAbortControllerMap.set(abortName, null);
|
||||
return response.data;
|
||||
})
|
||||
.catch((e: any) =>
|
||||
@@ -983,6 +1071,7 @@ export class QController
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
* overload 1 of possibleValues function - this is its "original" signature
|
||||
* that took several params, many optional, and kept evolving and getting
|
||||
|
||||
@@ -34,5 +34,16 @@ export class QPossibleValue
|
||||
this.id = object.id;
|
||||
this.label = object.label;
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QPossibleValue
|
||||
{
|
||||
const clone = new QPossibleValue({
|
||||
...this
|
||||
});
|
||||
return (clone);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -35,6 +35,7 @@ export enum AdornmentType
|
||||
FILE_DOWNLOAD = "FILE_DOWNLOAD",
|
||||
FILE_UPLOAD = "FILE_UPLOAD",
|
||||
TOOLTIP = "TOOLTIP",
|
||||
WIDGET = "WIDGET",
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
// keep these values in sync with AdornmentType.java in qqq-backend-core //
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
|
||||
@@ -23,14 +23,16 @@
|
||||
** Things that can be done to tables, fields.
|
||||
**
|
||||
*******************************************************************************/
|
||||
export enum Capability {
|
||||
TABLE_QUERY = "TABLE_QUERY",
|
||||
TABLE_GET = "TABLE_GET",
|
||||
TABLE_COUNT = "TABLE_COUNT",
|
||||
TABLE_INSERT = "TABLE_INSERT",
|
||||
TABLE_UPDATE = "TABLE_UPDATE",
|
||||
TABLE_DELETE = "TABLE_DELETE"
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
// keep these values in sync with Capability.java in qqq-backend-core //
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
export enum Capability
|
||||
{
|
||||
TABLE_QUERY = "TABLE_QUERY",
|
||||
TABLE_GET = "TABLE_GET",
|
||||
TABLE_COUNT = "TABLE_COUNT",
|
||||
TABLE_INSERT = "TABLE_INSERT",
|
||||
TABLE_UPDATE = "TABLE_UPDATE",
|
||||
TABLE_DELETE = "TABLE_DELETE",
|
||||
TABLE_EXPORT = "TABLE_EXPORT"
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
// keep these values in sync with Capability.java in qqq-backend-core //
|
||||
////////////////////////////////////////////////////////////////////////
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2022. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/*******************************************************************************
|
||||
** Meta-Data to define Collapsible state, e.g., for a section or widget
|
||||
**
|
||||
*******************************************************************************/
|
||||
export class Collapsible
|
||||
{
|
||||
isCollapsible: boolean;
|
||||
initiallyOpen: boolean;
|
||||
|
||||
constructor(object: any)
|
||||
{
|
||||
////////////////////////////////////////////////////////////////////////////
|
||||
// use value === true to let undefined (or any other) values become false //
|
||||
////////////////////////////////////////////////////////////////////////////
|
||||
this.isCollapsible = object.isCollapsible === true;
|
||||
this.initiallyOpen = object.initiallyOpen === true;
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): Collapsible
|
||||
{
|
||||
const clone = new Collapsible({
|
||||
...this
|
||||
});
|
||||
return (clone);
|
||||
}
|
||||
}
|
||||
@@ -53,4 +53,23 @@ export class FieldAdornment
|
||||
}
|
||||
return (null);
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): FieldAdornment
|
||||
{
|
||||
const valuesClone = this.values ? new Map<string, any>() : undefined;
|
||||
if(this.values && valuesClone)
|
||||
{
|
||||
this.values.forEach((value, key) =>
|
||||
{
|
||||
valuesClone.set(key, value);
|
||||
});
|
||||
}
|
||||
|
||||
const clone = new FieldAdornment({type: this.type});
|
||||
clone.values = valuesClone;
|
||||
return (clone);
|
||||
}
|
||||
}
|
||||
@@ -21,6 +21,7 @@
|
||||
|
||||
import {QAppSection} from "./QAppSection";
|
||||
import {QAppTreeNode} from "./QAppTreeNode";
|
||||
import {QHelpContent} from "./QHelpContent";
|
||||
|
||||
/*******************************************************************************
|
||||
** Meta-Data to define an app in a QQQ instance.
|
||||
@@ -36,6 +37,7 @@ export class QAppMetaData
|
||||
widgets?: string[];
|
||||
sections?: QAppSection[];
|
||||
supplementalAppMetaData: Map<String, any> = new Map();
|
||||
helpContent?: Map<string, QHelpContent[]>;
|
||||
|
||||
constructor(object: any)
|
||||
{
|
||||
@@ -64,13 +66,17 @@ export class QAppMetaData
|
||||
}
|
||||
}
|
||||
|
||||
if(object.supplementalAppMetaData)
|
||||
if (object.supplementalAppMetaData)
|
||||
{
|
||||
for (const key in object.supplementalAppMetaData)
|
||||
{
|
||||
this.supplementalAppMetaData.set(key, object.supplementalAppMetaData[key]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (object.helpContents)
|
||||
{
|
||||
this.helpContent = QHelpContent.buildMap(object.helpContents);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -31,6 +31,7 @@ export class QAppSection
|
||||
label: string;
|
||||
icon?: QIcon;
|
||||
tables?: string[];
|
||||
apps?: string[];
|
||||
processes?: string[];
|
||||
reports?: string[];
|
||||
|
||||
@@ -54,5 +55,9 @@ export class QAppSection
|
||||
{
|
||||
this.tables = object.tables;
|
||||
}
|
||||
if (object.apps)
|
||||
{
|
||||
this.apps = object.apps;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -33,8 +33,10 @@ export class QAppTreeNode
|
||||
label: string;
|
||||
type: QAppNodeType;
|
||||
children?: QAppTreeNode[];
|
||||
hideChildrenFromNavigation?: boolean;
|
||||
iconName?: string;
|
||||
icon?: QIcon;
|
||||
appAffinity?: number;
|
||||
|
||||
constructor(object: any)
|
||||
{
|
||||
@@ -42,6 +44,8 @@ export class QAppTreeNode
|
||||
this.label = object.label;
|
||||
this.type = object.type;
|
||||
this.iconName = object.iconName;
|
||||
this.appAffinity = object.appAffinity;
|
||||
this.hideChildrenFromNavigation = object.hideChildrenFromNavigation;
|
||||
|
||||
if (object.icon)
|
||||
{
|
||||
|
||||
@@ -33,6 +33,8 @@ export class QBrandingMetaData
|
||||
logo?: string;
|
||||
icon?: string;
|
||||
accentColor?: string;
|
||||
accentColorLight?: string;
|
||||
gravatarDefault?: string;
|
||||
|
||||
// Deprecated
|
||||
environmentBannerText?: string;
|
||||
@@ -50,6 +52,8 @@ export class QBrandingMetaData
|
||||
this.logo = object.logo;
|
||||
this.icon = object.icon;
|
||||
this.accentColor = object.accentColor;
|
||||
this.accentColorLight = object.accentColorLight;
|
||||
this.gravatarDefault = object.gravatarDefault;
|
||||
this.environmentBannerText = object.environmentBannerText;
|
||||
this.environmentBannerColor = object.environmentBannerColor;
|
||||
|
||||
|
||||
@@ -36,13 +36,37 @@ export class QExposedJoin
|
||||
|
||||
constructor(object: any)
|
||||
{
|
||||
this.label = object.label;
|
||||
this.isMany = object.isMany;
|
||||
this.joinTable = new QTableMetaData(object.joinTable);
|
||||
this.label = object?.label;
|
||||
this.isMany = object?.isMany;
|
||||
this.joinTable = new QTableMetaData(object?.joinTable);
|
||||
this.joinPath = [];
|
||||
for (let i = 0; i < object.joinPath.length; i++)
|
||||
for (let i = 0; i < object?.joinPath?.length; i++)
|
||||
{
|
||||
this.joinPath.push(new QJoinMetaData(object.joinPath[i]));
|
||||
}
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QExposedJoin
|
||||
{
|
||||
const joinTableClone = this.joinTable?.clone();
|
||||
|
||||
const joinPathClone: QJoinMetaData[] = [];
|
||||
for (let joinMetaData of this.joinPath ?? [])
|
||||
{
|
||||
joinPathClone.push(joinMetaData.clone());
|
||||
}
|
||||
|
||||
const clone = new QExposedJoin({
|
||||
...this,
|
||||
joinTable: joinTableClone,
|
||||
joinPath: joinPathClone
|
||||
});
|
||||
// overwrite joinTable — the constructor re-wraps it in new QTableMetaData(),
|
||||
// which loses Map-based fields/virtualFields from the already-cloned object
|
||||
clone.joinTable = joinTableClone;
|
||||
return (clone);
|
||||
}
|
||||
}
|
||||
@@ -91,11 +91,12 @@ export class QFieldMetaData
|
||||
this.helpContents = QHelpContent.buildArray(object.helpContents);
|
||||
this.behaviors = object.behaviors;
|
||||
|
||||
if (object.supplementalFieldMetaData)
|
||||
const supplementalFieldMetaData = object.supplementalFieldMetaData || object.supplementalMetaData;
|
||||
if (supplementalFieldMetaData)
|
||||
{
|
||||
for (const key in object.supplementalFieldMetaData)
|
||||
for (const key in supplementalFieldMetaData)
|
||||
{
|
||||
this.supplementalFieldMetaData.set(key, object.supplementalFieldMetaData[key]);
|
||||
this.supplementalFieldMetaData.set(key, supplementalFieldMetaData[key]);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -135,4 +136,65 @@ export class QFieldMetaData
|
||||
return (null);
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QFieldMetaData
|
||||
{
|
||||
const inlinePossibleValueSourceClone: QPossibleValue[] | undefined = this.inlinePossibleValueSource ? [] : undefined;
|
||||
if(this.inlinePossibleValueSource && inlinePossibleValueSourceClone)
|
||||
{
|
||||
for (let qPossibleValue of this.inlinePossibleValueSource)
|
||||
{
|
||||
inlinePossibleValueSourceClone.push((qPossibleValue as any).clone());
|
||||
}
|
||||
}
|
||||
|
||||
const adornmentsClone: FieldAdornment[] | undefined = this.adornments ? [] : undefined;
|
||||
if(this.adornments && adornmentsClone)
|
||||
{
|
||||
for (let adornment of this.adornments)
|
||||
{
|
||||
adornmentsClone.push((adornment as any).clone());
|
||||
}
|
||||
}
|
||||
|
||||
const helpContentsClone: QHelpContent[] | undefined = this.helpContents ? [] : undefined;
|
||||
if(this.helpContents && helpContentsClone)
|
||||
{
|
||||
for (let helpContent of this.helpContents)
|
||||
{
|
||||
helpContentsClone.push((helpContent as any).clone());
|
||||
}
|
||||
}
|
||||
|
||||
const behaviorsClone: any[] | undefined = this.behaviors ? [...this.behaviors] : undefined;
|
||||
|
||||
const supplementalFieldMetaDataClone: Map<String, any> = new Map();
|
||||
this.supplementalFieldMetaData.forEach((value, key) =>
|
||||
{
|
||||
supplementalFieldMetaDataClone.set(key, value);
|
||||
});
|
||||
|
||||
const possibleValueSourceFilterClone = this.possibleValueSourceFilter ? (this.possibleValueSourceFilter as any).clone() : undefined;
|
||||
|
||||
const clone = new QFieldMetaData({
|
||||
...this,
|
||||
inlinePossibleValueSource: inlinePossibleValueSourceClone,
|
||||
behaviors: behaviorsClone,
|
||||
possibleValueSourceFilter: possibleValueSourceFilterClone
|
||||
});
|
||||
|
||||
if(adornmentsClone)
|
||||
{
|
||||
clone.adornments = adornmentsClone;
|
||||
}
|
||||
|
||||
clone.helpContents = helpContentsClone;
|
||||
|
||||
clone.supplementalFieldMetaData = supplementalFieldMetaDataClone;
|
||||
return (clone);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -105,4 +105,26 @@ export class QHelpContent
|
||||
return (rs);
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QHelpContent
|
||||
{
|
||||
const rolesClone = new Set<string>();
|
||||
this.roles.forEach((role) =>
|
||||
{
|
||||
rolesClone.add(role);
|
||||
});
|
||||
|
||||
const clone = new QHelpContent({...this});
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
// sets don't quite work as expected for this kind of clone, so copy manually //
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
clone.roles = rolesClone;
|
||||
|
||||
return (clone);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -35,4 +35,15 @@ export class QIcon
|
||||
this.path = object.path;
|
||||
this.color = object.color;
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QIcon
|
||||
{
|
||||
const clone = new QIcon({
|
||||
...this
|
||||
});
|
||||
return (clone);
|
||||
}
|
||||
}
|
||||
@@ -45,6 +45,8 @@ export class QInstance
|
||||
environmentValues?: Map<string, string>;
|
||||
helpContent?: Map<string, QHelpContent[]>;
|
||||
supplementalInstanceMetaData: Map<String, any> = new Map();
|
||||
redirects: Map<string, string> = new Map();
|
||||
private pathsMap: Record<string, {path: string, affinity: number}[]> = {};
|
||||
|
||||
constructor(object: any)
|
||||
{
|
||||
@@ -125,6 +127,44 @@ export class QInstance
|
||||
}
|
||||
|
||||
this.helpContent = QHelpContent.buildMap(object.helpContents);
|
||||
|
||||
if (object.redirects)
|
||||
{
|
||||
for (const key in object.redirects)
|
||||
{
|
||||
this.redirects.set(key, object.redirects[key]);
|
||||
}
|
||||
}
|
||||
|
||||
this.buildPathsMap(this.appTree || []);
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
* populate the private/internal "pathsMap" - with lists of all available
|
||||
* paths to tables, processes, etc (where a table in more than 1 app will
|
||||
* have more than 1 entry). This is used to help determine which app to
|
||||
* open when a user clicks on a table name. To select a path, they should
|
||||
* be sorted by affinity, so that the most preferred app is first.
|
||||
***************************************************************************/
|
||||
buildPathsMap(nodes: QAppTreeNode[], path: string = ""): void
|
||||
{
|
||||
for (let i = 0; i < nodes.length; i++)
|
||||
{
|
||||
const node = nodes[i];
|
||||
if(node.type === QAppNodeType.APP && node.children)
|
||||
{
|
||||
this.buildPathsMap(node.children, path + "/" + node.name);
|
||||
}
|
||||
else
|
||||
{
|
||||
if(!this.pathsMap[node.name])
|
||||
{
|
||||
this.pathsMap[node.name] = [];
|
||||
}
|
||||
this.pathsMap[node.name].push({path: path + "/" + node.name, affinity: node.appAffinity ?? Number.MIN_SAFE_INTEGER});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -142,7 +182,7 @@ export class QInstance
|
||||
*******************************************************************************/
|
||||
getTablePath(table: QTableMetaData): string | null
|
||||
{
|
||||
return QInstance.searchAppTreeForPath(this.appTree, table.name, QAppNodeType.TABLE, 1, "");
|
||||
return this.getTablePathByName(table.name);
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
@@ -150,7 +190,14 @@ export class QInstance
|
||||
*******************************************************************************/
|
||||
getTablePathByName(tableName: string): string | null
|
||||
{
|
||||
return QInstance.searchAppTreeForPath(this.appTree, tableName, QAppNodeType.TABLE, 1, "");
|
||||
const value = this.pathsMap[tableName];
|
||||
if(value)
|
||||
{
|
||||
value.sort((a, b) => b.affinity - a.affinity);
|
||||
return (value[0].path);
|
||||
}
|
||||
|
||||
return (null);
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
|
||||
@@ -37,4 +37,15 @@ export class QJoinMetaData
|
||||
this.leftTable = object.leftTable;
|
||||
this.rightTable = object.rightTable;
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QJoinMetaData
|
||||
{
|
||||
const clone = new QJoinMetaData({
|
||||
...this
|
||||
});
|
||||
return (clone);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,69 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2022. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import {QIcon} from "./QIcon";
|
||||
import {QMenuItem} from "./QMenuItem";
|
||||
|
||||
/*******************************************************************************
|
||||
* Meta-Data that defines a Menu in a QQQ Instance
|
||||
*
|
||||
*******************************************************************************/
|
||||
export class QMenu
|
||||
{
|
||||
label: string;
|
||||
icon?: QIcon;
|
||||
slot: string;
|
||||
items?: QMenuItem[];
|
||||
|
||||
constructor(object: any)
|
||||
{
|
||||
this.label = object.label;
|
||||
if (object.icon)
|
||||
{
|
||||
this.icon = new QIcon(object.icon);
|
||||
}
|
||||
this.slot = object.slot;
|
||||
if (object.items)
|
||||
{
|
||||
this.items = object.items.map((item: any) => new QMenuItem(item));
|
||||
}
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QMenu
|
||||
{
|
||||
const clone = new QMenu({
|
||||
label: this.label,
|
||||
slot: this.slot
|
||||
});
|
||||
|
||||
clone.icon = this.icon?.clone();
|
||||
|
||||
if (this.items)
|
||||
{
|
||||
clone.items = this.items.map((item: QMenuItem) => item.clone());
|
||||
}
|
||||
|
||||
return (clone);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,75 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2022. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import {QIcon} from "./QIcon";
|
||||
|
||||
/*******************************************************************************
|
||||
* Meta-Data that defines a MenuItem in a QQQ Instance
|
||||
*
|
||||
*******************************************************************************/
|
||||
export class QMenuItem
|
||||
{
|
||||
label: string;
|
||||
icon?: QIcon;
|
||||
itemType: string;
|
||||
values?: Map<string, any>;
|
||||
|
||||
constructor(object: any)
|
||||
{
|
||||
this.label = object.label;
|
||||
if (object.icon)
|
||||
{
|
||||
this.icon = new QIcon(object.icon);
|
||||
}
|
||||
this.itemType = object.itemType;
|
||||
|
||||
if (object.values)
|
||||
{
|
||||
this.values = new Map<string, any>();
|
||||
|
||||
for (let key in object.values)
|
||||
{
|
||||
this.values?.set(key, object.values[key]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QMenuItem
|
||||
{
|
||||
const clone = new QMenuItem({
|
||||
label: this.label,
|
||||
itemType: this.itemType
|
||||
});
|
||||
|
||||
clone.icon = this.icon?.clone();
|
||||
|
||||
if (this.values)
|
||||
{
|
||||
clone.values = new Map<string, any>();
|
||||
this.values.forEach((value: any, key: string) => clone.values?.set(key, value));
|
||||
}
|
||||
|
||||
return (clone);
|
||||
}
|
||||
}
|
||||
@@ -22,7 +22,9 @@
|
||||
import {QExposedJoin} from "./QExposedJoin";
|
||||
import {QFieldMetaData} from "./QFieldMetaData";
|
||||
import {QHelpContent} from "./QHelpContent";
|
||||
import {QMenu} from "./QMenu";
|
||||
import {QTableSection} from "./QTableSection";
|
||||
import {QVirtualFieldMetaData} from "./QVirtualFieldMetaData";
|
||||
|
||||
/*******************************************************************************
|
||||
** Meta-Data to define a table in a QQQ instance.
|
||||
@@ -35,6 +37,7 @@ export class QTableMetaData
|
||||
isHidden: boolean = false;
|
||||
primaryKeyField: string;
|
||||
fields?: Map<string, QFieldMetaData>;
|
||||
virtualFields?: Map<string, QVirtualFieldMetaData>;
|
||||
iconName?: string;
|
||||
sections?: QTableSection[];
|
||||
exposedJoins?: QExposedJoin[];
|
||||
@@ -48,6 +51,7 @@ export class QTableMetaData
|
||||
supplementalTableMetaData: Map<String, any> = new Map();
|
||||
shareableTableMetaData: any;
|
||||
helpContent?: Map<string, QHelpContent[]>;
|
||||
menus?: QMenu[];
|
||||
|
||||
constructor(object: any)
|
||||
{
|
||||
@@ -72,6 +76,15 @@ export class QTableMetaData
|
||||
}
|
||||
}
|
||||
|
||||
if (object.virtualFields)
|
||||
{
|
||||
this.virtualFields = new Map<string, QVirtualFieldMetaData>();
|
||||
for (const key in object.virtualFields)
|
||||
{
|
||||
this.virtualFields.set(key, new QVirtualFieldMetaData(object.virtualFields[key]));
|
||||
}
|
||||
}
|
||||
|
||||
if (object.sections)
|
||||
{
|
||||
this.sections = [];
|
||||
@@ -93,7 +106,7 @@ export class QTableMetaData
|
||||
this.capabilities = new Set<string>();
|
||||
if (object.capabilities)
|
||||
{
|
||||
for (var i = 0; i < object.capabilities.length; i++)
|
||||
for (let i = 0; i < object.capabilities.length; i++)
|
||||
{
|
||||
this.capabilities.add(object.capabilities[i]);
|
||||
}
|
||||
@@ -110,5 +123,113 @@ export class QTableMetaData
|
||||
this.shareableTableMetaData = object.shareableTableMetaData;
|
||||
|
||||
this.helpContent = QHelpContent.buildMap(object.helpContents);
|
||||
|
||||
if(object.menus)
|
||||
{
|
||||
this.menus = [];
|
||||
for(let i = 0; i < object.menus.length; i++)
|
||||
{
|
||||
this.menus.push(new QMenu(object.menus[i]));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QTableMetaData
|
||||
{
|
||||
const fieldsClone = this.fields ? new Map() : undefined;
|
||||
if (this.fields && fieldsClone)
|
||||
{
|
||||
this.fields.forEach((field, name) =>
|
||||
{
|
||||
fieldsClone.set(name, field.clone());
|
||||
});
|
||||
}
|
||||
|
||||
const virtualFieldsClone = this.virtualFields ? new Map() : undefined;
|
||||
if (this.virtualFields && virtualFieldsClone)
|
||||
{
|
||||
this.virtualFields.forEach((field, name) =>
|
||||
{
|
||||
virtualFieldsClone.set(name, field.clone());
|
||||
});
|
||||
}
|
||||
|
||||
const sectionsClone: QTableSection[] | undefined = this.sections ? [] : undefined;
|
||||
if (this.sections && sectionsClone)
|
||||
{
|
||||
for (let section of this.sections)
|
||||
{
|
||||
sectionsClone.push((section as any).clone());
|
||||
}
|
||||
}
|
||||
|
||||
const exposedJoinsClone: QExposedJoin[] | undefined = this.exposedJoins ? [] : undefined;
|
||||
if (this.exposedJoins && exposedJoinsClone)
|
||||
{
|
||||
for (let exposedJoin of this.exposedJoins)
|
||||
{
|
||||
exposedJoinsClone.push((exposedJoin as any).clone());
|
||||
}
|
||||
}
|
||||
|
||||
const capabilitiesClone = new Set<string>();
|
||||
if (this.capabilities && capabilitiesClone)
|
||||
{
|
||||
this.capabilities.forEach((capability) =>
|
||||
{
|
||||
capabilitiesClone.add(capability);
|
||||
});
|
||||
}
|
||||
|
||||
const helpContentsClone = this.helpContent ? new Map() : undefined;
|
||||
if (this.helpContent && helpContentsClone)
|
||||
{
|
||||
this.helpContent.forEach((helpContentArray, name) =>
|
||||
{
|
||||
if (helpContentArray)
|
||||
{
|
||||
const helpContentArrayClone: QHelpContent[] = [];
|
||||
for (let qHelpContent of helpContentArray)
|
||||
{
|
||||
helpContentArrayClone.push((qHelpContent as any).clone());
|
||||
}
|
||||
helpContentsClone.set(name, helpContentArrayClone);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
const supplementalTableMetaDataClone = new Map<String, any>();
|
||||
this.supplementalTableMetaData.forEach((value, name) =>
|
||||
{
|
||||
supplementalTableMetaDataClone.set(name, Object.assign({}, value));
|
||||
});
|
||||
|
||||
const menusClone: QMenu[] | undefined = this.menus ? [] : undefined;
|
||||
if (this.menus && menusClone)
|
||||
{
|
||||
for (let i = 0; i < this.menus.length; i++)
|
||||
{
|
||||
menusClone.push(this.menus[i].clone());
|
||||
}
|
||||
}
|
||||
|
||||
const clone = new QTableMetaData({...this});
|
||||
|
||||
clone.fields = fieldsClone;
|
||||
clone.virtualFields = virtualFieldsClone;
|
||||
clone.sections = sectionsClone;
|
||||
clone.exposedJoins = exposedJoinsClone;
|
||||
clone.capabilities = capabilitiesClone;
|
||||
clone.supplementalTableMetaData = supplementalTableMetaDataClone;
|
||||
clone.helpContent = helpContentsClone;
|
||||
clone.menus = menusClone;
|
||||
|
||||
return (clone);
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
@@ -19,6 +19,7 @@
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import {Collapsible} from "./Collapsible";
|
||||
import {QHelpContent} from "./QHelpContent";
|
||||
|
||||
/*******************************************************************************
|
||||
@@ -36,6 +37,8 @@ export class QTableSection
|
||||
isHidden: boolean;
|
||||
gridColumns?: number;
|
||||
helpContents?: QHelpContent[];
|
||||
alternatives?: Map<string, QTableSection>;
|
||||
collapsible?: Collapsible;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
@@ -46,7 +49,7 @@ export class QTableSection
|
||||
this.name = object.name;
|
||||
this.label = object.label;
|
||||
this.tier = object.tier;
|
||||
this.iconName = object.icon ? object.icon.name : null;
|
||||
this.iconName = object.icon ? object.icon.name : object.iconName;
|
||||
|
||||
if (object.fieldNames)
|
||||
{
|
||||
@@ -58,6 +61,59 @@ export class QTableSection
|
||||
this.gridColumns = object.gridColumns;
|
||||
|
||||
this.helpContents = QHelpContent.buildArray(object.helpContents)
|
||||
|
||||
if (object.alternatives)
|
||||
{
|
||||
this.alternatives = new Map<string, QTableSection>();
|
||||
for (let type in object.alternatives)
|
||||
{
|
||||
this.alternatives.set(type, new QTableSection(object.alternatives[type]));
|
||||
}
|
||||
}
|
||||
|
||||
if (object.collapsible)
|
||||
{
|
||||
this.collapsible = new Collapsible(object.collapsible);
|
||||
}
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QTableSection
|
||||
{
|
||||
let fieldNamesClone: string[] | undefined = undefined;
|
||||
if(this.fieldNames)
|
||||
{
|
||||
fieldNamesClone = [...this.fieldNames];
|
||||
}
|
||||
|
||||
const helpContentsClone: QHelpContent[] = (this.helpContents ? [] : undefined) as QHelpContent[];
|
||||
if(this.helpContents && helpContentsClone)
|
||||
{
|
||||
for (let helpContent of this.helpContents)
|
||||
{
|
||||
helpContentsClone.push((helpContent as any).clone());
|
||||
}
|
||||
}
|
||||
|
||||
const alternativesClone: Map<string, QTableSection> | undefined = (this.alternatives ? new Map<string, QTableSection> : undefined)
|
||||
if(this.alternatives && alternativesClone)
|
||||
{
|
||||
this.alternatives.forEach((value: QTableSection, key: string) =>
|
||||
alternativesClone.set(key, value.clone()));
|
||||
}
|
||||
|
||||
const collapsibleClone: Collapsible | undefined = (this.collapsible ? this.collapsible.clone() : undefined);
|
||||
|
||||
const clone = new QTableSection({...this});
|
||||
|
||||
clone.fieldNames = fieldNamesClone;
|
||||
clone.helpContents = helpContentsClone;
|
||||
clone.alternatives = alternativesClone;
|
||||
clone.collapsible = collapsibleClone;
|
||||
|
||||
return (clone);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2026. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import {QFieldMetaData} from "./QFieldMetaData";
|
||||
|
||||
/***************************************************************************
|
||||
* Meta-data to represent a virtual field in a table.
|
||||
*
|
||||
* This is a subclass of QFieldMetaData, as it is on the QQQ backend.
|
||||
***************************************************************************/
|
||||
export class QVirtualFieldMetaData extends QFieldMetaData
|
||||
{
|
||||
isQueryCriteria: boolean = false;
|
||||
isQuerySelectable: boolean = false;
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
constructor(object: any)
|
||||
{
|
||||
super(object);
|
||||
|
||||
this.isQueryCriteria = object.isQueryCriteria;
|
||||
this.isQuerySelectable = object.isQuerySelectable;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QVirtualFieldMetaData
|
||||
{
|
||||
const clone = super.clone() as QVirtualFieldMetaData;
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////////
|
||||
// any time we do a super clone, we want to set the prototype to our subtype //
|
||||
///////////////////////////////////////////////////////////////////////////////
|
||||
Object.setPrototypeOf(clone, QVirtualFieldMetaData.prototype)
|
||||
|
||||
clone.isQueryCriteria = this.isQueryCriteria;
|
||||
clone.isQuerySelectable = this.isQuerySelectable;
|
||||
|
||||
return (clone);
|
||||
}
|
||||
}
|
||||
@@ -19,6 +19,7 @@
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import {Collapsible} from "./Collapsible";
|
||||
import {QHelpContent} from "./QHelpContent";
|
||||
import {QIcon} from "./QIcon";
|
||||
|
||||
@@ -51,6 +52,7 @@ export class QWidgetMetaData
|
||||
|
||||
helpContent?: Map<string, QHelpContent[]>;
|
||||
defaultValues?: Map<string, any>;
|
||||
collapsible?: Collapsible;
|
||||
|
||||
constructor(object: any)
|
||||
{
|
||||
@@ -89,5 +91,9 @@ export class QWidgetMetaData
|
||||
}
|
||||
}
|
||||
|
||||
if (object.collapsible)
|
||||
{
|
||||
this.collapsible = new Collapsible(object.collapsible);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,54 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2022. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/*******************************************************************************
|
||||
** Define a field function being used in a QQQ application
|
||||
**
|
||||
*******************************************************************************/
|
||||
export class FieldFunction
|
||||
{
|
||||
fieldName: string;
|
||||
functionTypeIdentifierName: string;
|
||||
arguments: Record<string, any>
|
||||
|
||||
constructor(fieldName: string, functionTypeIdentifierName: string, _arguments: Record<string, any>)
|
||||
{
|
||||
this.fieldName = fieldName;
|
||||
this.functionTypeIdentifierName = functionTypeIdentifierName;
|
||||
this.arguments = _arguments;
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): FieldFunction
|
||||
{
|
||||
const cloneArguments = (this.arguments === null ? null : this.arguments === undefined ? undefined : {...this.arguments}) as Record<string, any>;
|
||||
|
||||
const clone = new FieldFunction(
|
||||
this.fieldName,
|
||||
this.functionTypeIdentifierName,
|
||||
cloneArguments
|
||||
);
|
||||
|
||||
return (clone);
|
||||
}
|
||||
}
|
||||
@@ -19,6 +19,7 @@
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import {FieldFunction} from "./FieldFunction";
|
||||
import {QCriteriaOperator} from "./QCriteriaOperator";
|
||||
|
||||
/*******************************************************************************
|
||||
@@ -31,6 +32,7 @@ export class QFilterCriteria
|
||||
operator: QCriteriaOperator;
|
||||
values!: any[];
|
||||
otherFieldName?: string;
|
||||
fieldFunction?: FieldFunction;
|
||||
|
||||
constructor(fieldName: string, operator: QCriteriaOperator, values: any[])
|
||||
{
|
||||
@@ -38,4 +40,27 @@ export class QFilterCriteria
|
||||
this.operator = operator;
|
||||
this.values = values;
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QFilterCriteria
|
||||
{
|
||||
const cloneValues = (this.values === null ? null : this.values === undefined ? undefined : [...this.values]) as any[];
|
||||
|
||||
const clone = new QFilterCriteria(
|
||||
this.fieldName,
|
||||
this.operator,
|
||||
cloneValues
|
||||
);
|
||||
|
||||
clone.otherFieldName = this.otherFieldName;
|
||||
|
||||
if(this.fieldFunction)
|
||||
{
|
||||
clone.fieldFunction = this.fieldFunction.clone();
|
||||
}
|
||||
|
||||
return (clone);
|
||||
}
|
||||
}
|
||||
@@ -33,4 +33,16 @@ export class QFilterOrderBy
|
||||
this.fieldName = fieldName;
|
||||
this.isAscending = isAscending;
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QFilterOrderBy
|
||||
{
|
||||
const clone = new QFilterOrderBy(
|
||||
this.fieldName,
|
||||
this.isAscending
|
||||
);
|
||||
return (clone);
|
||||
}
|
||||
}
|
||||
@@ -107,4 +107,47 @@ export class QQueryFilter
|
||||
}
|
||||
this.subFilters.push(subFilter);
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
public clone(): QQueryFilter
|
||||
{
|
||||
const criteriaClone: QFilterCriteria[] | undefined = this.criteria ? [] : undefined;
|
||||
if(this.criteria && criteriaClone)
|
||||
{
|
||||
for (let criteria of this.criteria)
|
||||
{
|
||||
criteriaClone.push((criteria as any).clone());
|
||||
}
|
||||
}
|
||||
|
||||
const orderBysClone: QFilterOrderBy[] | undefined = this.orderBys ? [] : undefined;
|
||||
if(this.orderBys && orderBysClone)
|
||||
{
|
||||
for (let orderBy of this.orderBys)
|
||||
{
|
||||
orderBysClone.push((orderBy as any).clone());
|
||||
}
|
||||
}
|
||||
|
||||
const subFiltersClone: QQueryFilter[] | undefined = this.subFilters ? [] : undefined;
|
||||
if(this.subFilters && subFiltersClone)
|
||||
{
|
||||
for (let subFilter of this.subFilters)
|
||||
{
|
||||
subFiltersClone.push((subFilter as any).clone());
|
||||
}
|
||||
}
|
||||
|
||||
const clone = new QQueryFilter(
|
||||
criteriaClone,
|
||||
orderBysClone,
|
||||
subFiltersClone,
|
||||
this.booleanOperator,
|
||||
this.skip,
|
||||
this.limit
|
||||
);
|
||||
return (clone);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2025. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import {Collapsible} from "../../../src/model/metaData/Collapsible";
|
||||
|
||||
describe("Collapsible", () =>
|
||||
{
|
||||
describe("constructor", () =>
|
||||
{
|
||||
it("should construct with all properties from object", () =>
|
||||
{
|
||||
const collapsible = new Collapsible({
|
||||
isCollapsible: true,
|
||||
initiallyOpen: true
|
||||
});
|
||||
|
||||
expect(collapsible.isCollapsible).toBe(true);
|
||||
expect(collapsible.initiallyOpen).toBe(true);
|
||||
});
|
||||
|
||||
it("should handle empty object", () =>
|
||||
{
|
||||
const collapsible = new Collapsible({});
|
||||
|
||||
//////////////////////////////////////
|
||||
// both attributes default to false //
|
||||
//////////////////////////////////////
|
||||
expect(collapsible.isCollapsible).toBe(false);
|
||||
expect(collapsible.initiallyOpen).toBe(false);
|
||||
});
|
||||
|
||||
it("should treat non-true values as false", () =>
|
||||
{
|
||||
const collapsible = new Collapsible({
|
||||
isCollapsible: 1,
|
||||
initiallyOpen: "true"
|
||||
});
|
||||
|
||||
//////////////////////////////////////
|
||||
// both attributes default to false //
|
||||
//////////////////////////////////////
|
||||
expect(collapsible.isCollapsible).toBe(false);
|
||||
expect(collapsible.initiallyOpen).toBe(false);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,89 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2025. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import {QAppMetaData} from "../../../src/model/metaData/QAppMetaData";
|
||||
import {QAppNodeType} from "../../../src/model/metaData/QAppNodeType";
|
||||
import {QAppTreeNode} from "../../../src/model/metaData/QAppTreeNode";
|
||||
import {QInstance} from "../../../src/model/metaData/QInstance";
|
||||
import {QTableMetaData} from "../../../src/model/metaData/QTableMetaData";
|
||||
|
||||
describe("QInstance", () =>
|
||||
{
|
||||
describe("getTablePath", () =>
|
||||
{
|
||||
it("should work for basic case (tables in only 1 app)", () =>
|
||||
{
|
||||
const qInstance = buildTestQInstance();
|
||||
expect(qInstance.getTablePathByName("order")).toBe("/oms/order");
|
||||
expect(qInstance.getTablePathByName("group")).toBe("/admin/usermgr/group");
|
||||
expect(qInstance.getTablePathByName("role")).toBe("/setup/role");
|
||||
});
|
||||
|
||||
it("should use app affinity when table is in two apps", () =>
|
||||
{
|
||||
const qInstance1 = buildTestQInstance({user: {admin: 50, setup: 100}});
|
||||
expect(qInstance1.getTablePathByName("user")).toBe("/setup/user");
|
||||
|
||||
const qInstance2 = buildTestQInstance({user: {admin: 1}});
|
||||
expect(qInstance2.getTablePathByName("user")).toBe("/admin/usermgr/user");
|
||||
});
|
||||
|
||||
});
|
||||
|
||||
});
|
||||
|
||||
|
||||
function buildTestQInstance(affinityValues: Record<string, Record<string, number>> = {}): QInstance
|
||||
{
|
||||
const qInstance = new QInstance({});
|
||||
|
||||
qInstance.tables = new Map<string, QTableMetaData>();
|
||||
qInstance.tables.set("order", new QTableMetaData({name: "order"}));
|
||||
qInstance.tables.set("user", new QTableMetaData({name: "user"})); // will be under both /admin/usermgr and /setup
|
||||
qInstance.tables.set("group", new QTableMetaData({name: "group"})); // will just be under /admin/usermgr
|
||||
qInstance.tables.set("role", new QTableMetaData({name: "role"})); // will just be under /setup
|
||||
|
||||
qInstance.apps = new Map<string, QAppMetaData>();
|
||||
qInstance.apps.set("oms", new QAppMetaData({name: "oms"}));
|
||||
qInstance.apps.set("usermgr", new QAppMetaData({name: "usermgr"})); // will go under setup
|
||||
qInstance.apps.set("admin", new QAppMetaData({name: "admin"}));
|
||||
qInstance.apps.set("setup", new QAppMetaData({name: "setup"}));
|
||||
|
||||
const orderTableNode = new QAppTreeNode({name: "order", type: QAppNodeType.TABLE});
|
||||
const userTableNodeForAdminUsermgr = new QAppTreeNode({name: "user", type: QAppNodeType.TABLE, appAffinity: affinityValues["user"]?.["admin"] ?? undefined});
|
||||
const userTableNodeForSetup = new QAppTreeNode({name: "user", type: QAppNodeType.TABLE, appAffinity: affinityValues["user"]?.["setup"] ?? undefined});
|
||||
const groupTableNode = new QAppTreeNode({name: "group", type: QAppNodeType.TABLE});
|
||||
const roleTableNode = new QAppTreeNode({name: "role", type: QAppNodeType.TABLE});
|
||||
|
||||
const omsAppNode = new QAppTreeNode({name: "oms", type: QAppNodeType.APP, children: [orderTableNode]});
|
||||
const usermgrAppNode = new QAppTreeNode({name: "usermgr", type: QAppNodeType.APP, children: [userTableNodeForAdminUsermgr, groupTableNode]});
|
||||
const adminAppNode = new QAppTreeNode({name: "admin", type: QAppNodeType.APP, children: [usermgrAppNode]});
|
||||
const setupAppNode = new QAppTreeNode({name: "setup", type: QAppNodeType.APP, children: [userTableNodeForSetup, roleTableNode]});
|
||||
|
||||
qInstance.appTree = [];
|
||||
qInstance.appTree.push(omsAppNode);
|
||||
qInstance.appTree.push(adminAppNode);
|
||||
qInstance.appTree.push(setupAppNode);
|
||||
|
||||
qInstance.buildPathsMap(qInstance.appTree);
|
||||
|
||||
return (qInstance);
|
||||
}
|
||||
@@ -0,0 +1,451 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2026. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
|
||||
import {QHelpContent} from "../../../src/model/metaData/QHelpContent";
|
||||
import {QMenu} from "../../../src/model/metaData/QMenu";
|
||||
import {QMenuItem} from "../../../src/model/metaData/QMenuItem";
|
||||
import {QTableMetaData} from "../../../src/model/metaData/QTableMetaData";
|
||||
import {QVirtualFieldMetaData} from "../../../src/model/metaData/QVirtualFieldMetaData";
|
||||
|
||||
describe("QTableMetaData tests", () =>
|
||||
{
|
||||
it("it should read field supplementalFieldMetaData", () =>
|
||||
{
|
||||
const table = new QTableMetaData({
|
||||
"name": "myTable",
|
||||
"label": "My Table",
|
||||
"primaryKeyField": "id",
|
||||
"fields": {
|
||||
"warehouseId": {
|
||||
"name": "warehouseId",
|
||||
"label": "Warehouse",
|
||||
"type": "INTEGER",
|
||||
"displayFormat": "%s",
|
||||
"supplementalFieldMetaData": {
|
||||
"materialDashboard": {
|
||||
"formAdjusterIdentifier": "process:myProcess;field:warehouseId",
|
||||
"type": "materialDashboard"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
expect(table.fields?.get("warehouseId")?.supplementalFieldMetaData.get("materialDashboard")).toEqual(
|
||||
expect.objectContaining({
|
||||
formAdjusterIdentifier: "process:myProcess;field:warehouseId",
|
||||
type: "materialDashboard"
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
it("it should read field supplementalMetaData", () =>
|
||||
{
|
||||
const table = new QTableMetaData({
|
||||
"name": "myTable",
|
||||
"label": "My Table",
|
||||
"primaryKeyField": "id",
|
||||
"fields": {
|
||||
"warehouseId": {
|
||||
"name": "warehouseId",
|
||||
"label": "Warehouse",
|
||||
"type": "INTEGER",
|
||||
"displayFormat": "%s",
|
||||
"supplementalMetaData": {
|
||||
"materialDashboard": {
|
||||
"formAdjusterIdentifier": "process:myProcess;field:warehouseId",
|
||||
"type": "materialDashboard"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
expect(table.fields?.get("warehouseId")?.supplementalFieldMetaData.get("materialDashboard")).toEqual(
|
||||
expect.objectContaining({
|
||||
formAdjusterIdentifier: "process:myProcess;field:warehouseId",
|
||||
type: "materialDashboard"
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
it("it should clone", () =>
|
||||
{
|
||||
/////////////////////////////////////
|
||||
// build a table with lots of data //
|
||||
/////////////////////////////////////
|
||||
const table = new QTableMetaData(
|
||||
{
|
||||
"name": "myTable",
|
||||
"label": "My Table",
|
||||
"isHidden": false,
|
||||
"primaryKeyField": "id",
|
||||
"icon": {"name": "link"},
|
||||
"fields": {
|
||||
"id": {
|
||||
"name": "id",
|
||||
"label": "Id",
|
||||
"type": "INTEGER",
|
||||
"isRequired": false,
|
||||
"isEditable": true,
|
||||
"isHeavy": false,
|
||||
"isHidden": false,
|
||||
"gridColumns": -1,
|
||||
"displayFormat": "%s"
|
||||
},
|
||||
"name": {
|
||||
"name": "name",
|
||||
"label": "Name",
|
||||
"type": "STRING",
|
||||
"isRequired": false,
|
||||
"isEditable": true,
|
||||
"isHeavy": false,
|
||||
"isHidden": false,
|
||||
"gridColumns": -1,
|
||||
"displayFormat": "%s",
|
||||
"maxLength": 100
|
||||
},
|
||||
"clientId": {
|
||||
"name": "clientId",
|
||||
"label": "Client",
|
||||
"type": "INTEGER",
|
||||
"isRequired": false,
|
||||
"isEditable": true,
|
||||
"isHeavy": false,
|
||||
"isHidden": false,
|
||||
"gridColumns": -1,
|
||||
"possibleValueSourceName": "client",
|
||||
"displayFormat": "%s",
|
||||
"adornments": [
|
||||
{
|
||||
"type": "LINK",
|
||||
"values": {
|
||||
"toRecordFromTable": "client"
|
||||
}
|
||||
}
|
||||
],
|
||||
"possibleValueSourceFilter": {
|
||||
"criteria": [
|
||||
{
|
||||
"fieldName": "isActive",
|
||||
"operator": "EQUALS",
|
||||
"values": [
|
||||
true
|
||||
]
|
||||
}
|
||||
],
|
||||
"booleanOperator": "AND",
|
||||
"subFilters": [
|
||||
{
|
||||
"criteria": [
|
||||
{
|
||||
"fieldName": "clientId",
|
||||
"operator": "EQUALS",
|
||||
"values": [
|
||||
"${input.clientId}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"fieldName": "clientId",
|
||||
"operator": "IS_BLANK"
|
||||
}
|
||||
],
|
||||
"booleanOperator": "OR"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"apiKey": {
|
||||
"name": "apiKey",
|
||||
"label": "API Key",
|
||||
"type": "PASSWORD",
|
||||
"isRequired": false,
|
||||
"isEditable": true,
|
||||
"isHeavy": false,
|
||||
"isHidden": false,
|
||||
"gridColumns": -1,
|
||||
"displayFormat": "%s",
|
||||
"helpContents": [
|
||||
{
|
||||
"content": "Field Help",
|
||||
"format": "MARKDOWN",
|
||||
"roles": ["READ_SCREENS"],
|
||||
"contentAsHtml": "Field Help"
|
||||
}
|
||||
],
|
||||
"supplementalMetaData": {
|
||||
"materialDashboard": {
|
||||
"formAdjusterIdentifier": "table:connection;field:externalSystemId",
|
||||
"onChangeFormAdjuster": {
|
||||
"name": "com.coldtrack.live.tables.setup.customizers.ConnectionTableMetaDataAdjuster",
|
||||
"codeType": "JAVA"
|
||||
},
|
||||
"type": "materialDashboard"
|
||||
}
|
||||
},
|
||||
"adornments": [
|
||||
{
|
||||
"type": "LINK",
|
||||
"values": {"toRecordFromTable": "foreignTable"}
|
||||
}
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"name": "type",
|
||||
"label": "Type",
|
||||
"type": "BOOLEAN",
|
||||
"isRequired": false,
|
||||
"isEditable": true,
|
||||
"isHeavy": false,
|
||||
"isHidden": false,
|
||||
"gridColumns": -1,
|
||||
"displayFormat": "%s",
|
||||
"possibleValueSourceName": "type",
|
||||
"supplementalMetaData": {
|
||||
"materialDashboard": {
|
||||
"formAdjusterIdentifier": "table:myTable;field:type",
|
||||
"onChangeFormAdjuster": {
|
||||
"name": "com.qqq.MyTableFormAdjuster",
|
||||
"codeType": "JAVA"
|
||||
},
|
||||
"type": "materialDashboard"
|
||||
}
|
||||
}
|
||||
},
|
||||
},
|
||||
"virtualFields": {
|
||||
"nameLength": {
|
||||
"name": "nameLength",
|
||||
"label": "Name Length",
|
||||
"type": "INTEGER",
|
||||
"isRequired": false,
|
||||
"isEditable": false,
|
||||
"isHeavy": false,
|
||||
"isHidden": false,
|
||||
"gridColumns": -1,
|
||||
"isQueryCriteria": true,
|
||||
"isQuerySelectable": false
|
||||
},
|
||||
"createDateWeekday": {
|
||||
"name": "createDateWeekday",
|
||||
"label": "Create Date Weekday",
|
||||
"type": "DATE",
|
||||
"isRequired": false,
|
||||
"isEditable": false,
|
||||
"isHeavy": false,
|
||||
"isHidden": false,
|
||||
"gridColumns": -1,
|
||||
"isQueryCriteria": false,
|
||||
"isQuerySelectable": true
|
||||
},
|
||||
},
|
||||
"sections": [
|
||||
{
|
||||
"name": "identity",
|
||||
"label": "Identity",
|
||||
"tier": "T1",
|
||||
"fieldNames": ["id", "name"],
|
||||
"icon": {"name": "badge"},
|
||||
"isHidden": false,
|
||||
"alternatives": {
|
||||
"RECORD_VIEW": {
|
||||
"name": "identityView",
|
||||
"label": "Identity",
|
||||
"fieldNames": ["id", "specialName"]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "authentication",
|
||||
"label": "Authentication",
|
||||
"tier": "T2",
|
||||
"fieldNames": ["apiKey",],
|
||||
"icon": {"name": "edit_attributes"},
|
||||
"isHidden": false
|
||||
},
|
||||
],
|
||||
"exposedJoins": [
|
||||
{
|
||||
"label": "Parcel",
|
||||
"isMany": false,
|
||||
"joinTable": {
|
||||
"name": "parcel",
|
||||
"label": "Parcel",
|
||||
"primaryKeyField": "id",
|
||||
"fields": {
|
||||
"id": {"name": "id", "label": "Id", "type": "INTEGER", "isEditable": false, "isHidden": false},
|
||||
"trackingNumber": {"name": "trackingNumber", "label": "Tracking Number", "type": "STRING", "isEditable": true, "isHidden": false},
|
||||
"status": {"name": "status", "label": "Status", "type": "STRING", "isEditable": true, "isHidden": false}
|
||||
},
|
||||
"sections": [],
|
||||
"capabilities": []
|
||||
},
|
||||
"joinPath": [
|
||||
{"name": "orderShipmentJoinParcel", "leftTable": "orderShipment", "rightTable": "parcel", "type": "ONE_TO_ONE", "joinOns": []}
|
||||
]
|
||||
}
|
||||
],
|
||||
"supplementalTableMetaData": {
|
||||
"materialDashboard": {
|
||||
"onLoadFormAdjuster": {
|
||||
"name": "com.qqq.MyTableFormAdjuster",
|
||||
"codeType": "JAVA"
|
||||
},
|
||||
"type": "materialDashboard"
|
||||
}
|
||||
},
|
||||
"capabilities": [
|
||||
"TABLE_COUNT",
|
||||
"TABLE_GET",
|
||||
"TABLE_QUERY",
|
||||
"QUERY_STATS",
|
||||
"TABLE_INSERT",
|
||||
"TABLE_UPDATE",
|
||||
"TABLE_DELETE",
|
||||
"TABLE_EXPORT"
|
||||
],
|
||||
"readPermission": true,
|
||||
"insertPermission": true,
|
||||
"editPermission": true,
|
||||
"deletePermission": true,
|
||||
"usesVariants": false,
|
||||
"iconName": "link",
|
||||
"helpContents": {
|
||||
"key": [
|
||||
{
|
||||
"content": "Table Help",
|
||||
"format": "MARKDOWN",
|
||||
"roles": ["WRITE_SCREENS"],
|
||||
"contentAsHtml": "Table Help"
|
||||
}
|
||||
]
|
||||
},
|
||||
"menus": [
|
||||
{
|
||||
label: "My Menu",
|
||||
icon: {name: "hotdog"},
|
||||
slot: "VIEW_SCREEN_ADDITIONAL",
|
||||
items: [
|
||||
{label: "Cars", icon: {name: "car"}, itemType: "RUN_PROCESS", values: {processName: "runCarsProcess"}},
|
||||
{label: "Apples", icon: {name: "download"}, itemType: "DOWNLOAD_FILE", values: {fieldName: "appleFileUrl"}},
|
||||
]
|
||||
}
|
||||
]
|
||||
});
|
||||
|
||||
////////////////////////////////////////////////////////////////
|
||||
// clone it - make a few assertions about data being the same //
|
||||
////////////////////////////////////////////////////////////////
|
||||
const cloneTable = table.clone();
|
||||
expect(cloneTable.name).toEqual(table.name);
|
||||
|
||||
expect(cloneTable.virtualFields?.size).toEqual(2);
|
||||
expect(cloneTable.virtualFields?.get("nameLength") instanceof QVirtualFieldMetaData).toBeTruthy();
|
||||
|
||||
expect(cloneTable.sections?.length).toEqual(2);
|
||||
expect(cloneTable.sections?.length).toEqual(table.sections?.length);
|
||||
expect(cloneTable.sections?.[0].name).toEqual(table.sections?.[0].name);
|
||||
expect(cloneTable.sections?.[0].iconName).toEqual(table.sections?.[0].iconName);
|
||||
expect(cloneTable.sections?.[0].alternatives?.size).toEqual(1);
|
||||
|
||||
expect(cloneTable.capabilities.size).toEqual(table.capabilities.size);
|
||||
|
||||
expect(cloneTable.helpContent?.size).toEqual(table.helpContent?.size);
|
||||
expect(cloneTable.helpContent?.get("key")?.[0].roles.size).not.toEqual(0);
|
||||
expect(cloneTable.helpContent?.get("key")?.[0].roles.size).toEqual(table.helpContent?.get("key")?.[0].roles.size);
|
||||
|
||||
expect(cloneTable.supplementalTableMetaData.size).not.toEqual(0);
|
||||
expect(cloneTable.supplementalTableMetaData.size).toEqual(table.supplementalTableMetaData.size);
|
||||
|
||||
const apiKeyField = table.fields?.get("apiKey");
|
||||
const cloneApiKeyField = cloneTable.fields?.get("apiKey");
|
||||
expect(cloneApiKeyField?.supplementalFieldMetaData.size).not.toEqual(0);
|
||||
expect(cloneApiKeyField?.supplementalFieldMetaData.size).toEqual(apiKeyField?.supplementalFieldMetaData.size);
|
||||
expect(cloneApiKeyField?.adornments?.length).not.toEqual(0);
|
||||
expect(cloneApiKeyField?.adornments?.length).toEqual(apiKeyField?.adornments?.length);
|
||||
expect(cloneApiKeyField?.adornments?.[0].values?.size).not.toEqual(0);
|
||||
expect(cloneApiKeyField?.adornments?.[0].values?.size).toEqual(apiKeyField?.adornments?.[0].values?.size);
|
||||
|
||||
expect(cloneTable.menus?.length).toEqual(1);
|
||||
expect(cloneTable.menus?.[0].items?.length).toEqual(2);
|
||||
|
||||
expect(cloneTable.exposedJoins?.length).toEqual(1);
|
||||
expect(cloneTable.exposedJoins?.[0].joinTable.name).toEqual("parcel");
|
||||
expect(cloneTable.exposedJoins?.[0].joinTable.fields?.size).toEqual(3);
|
||||
expect(cloneTable.exposedJoins?.[0].joinTable.fields?.get("trackingNumber")?.name).toEqual("trackingNumber");
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// turns out toEqual will do a deep equality test, so, we could have just done this all along //
|
||||
////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
expect(cloneTable).toEqual(table);
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////////////////////
|
||||
// change some things in the clone - assert that they are then not equal to the original //
|
||||
///////////////////////////////////////////////////////////////////////////////////////////
|
||||
cloneTable.name = "changed";
|
||||
expect(cloneTable.name).not.toEqual(table.name);
|
||||
|
||||
cloneTable.virtualFields?.set("new", new QVirtualFieldMetaData({}));
|
||||
expect(cloneTable.virtualFields?.size).toEqual(3);
|
||||
expect(table.virtualFields?.size).toEqual(2);
|
||||
|
||||
cloneTable.virtualFields!.get("nameLength")!.gridColumns = 6;
|
||||
cloneTable.virtualFields!.get("nameLength")!.isQuerySelectable = !cloneTable.virtualFields!.get("nameLength")!.isQuerySelectable;
|
||||
cloneTable.virtualFields!.get("nameLength")!.isQueryCriteria = !cloneTable.virtualFields!.get("nameLength")!.isQueryCriteria;
|
||||
expect(cloneTable.virtualFields?.get("nameLength")?.gridColumns).not.toEqual(table.virtualFields?.get("nameLength")?.gridColumns);
|
||||
expect(cloneTable.virtualFields?.get("nameLength")?.isQuerySelectable).not.toEqual(table.virtualFields?.get("nameLength")?.isQuerySelectable);
|
||||
expect(cloneTable.virtualFields?.get("nameLength")?.isQueryCriteria).not.toEqual(table.virtualFields?.get("nameLength")?.isQueryCriteria);
|
||||
|
||||
cloneTable.sections![0]!.name = "changed";
|
||||
cloneTable.sections![0]!.isHidden = true;
|
||||
|
||||
expect(cloneTable.sections?.[0].name).not.toEqual(table.sections?.[0].name);
|
||||
expect(cloneTable.sections?.[0].isHidden).not.toEqual(table.sections?.[0].isHidden);
|
||||
|
||||
cloneTable.capabilities.delete("TABLE_COUNT");
|
||||
expect(cloneTable.capabilities.size).not.toEqual(table.capabilities.size);
|
||||
|
||||
cloneTable.helpContent?.set("key2", []);
|
||||
expect(cloneTable.helpContent?.size).not.toEqual(table.helpContent?.size);
|
||||
|
||||
cloneTable.helpContent?.get("key")?.push(new QHelpContent({}));
|
||||
expect(cloneTable.helpContent?.get("key")?.length).not.toEqual(table.helpContent?.get("key")?.length);
|
||||
|
||||
cloneTable.helpContent?.get("key")?.[0].roles.add("READ_SCREENS");
|
||||
expect(cloneTable.helpContent?.get("key")?.[0].roles.size).not.toEqual(table.helpContent?.get("key")?.[0].roles.size);
|
||||
|
||||
cloneTable.sections?.[0]?.fieldNames?.push("foobar");
|
||||
expect(cloneTable.sections?.[0]?.fieldNames?.length).not.toEqual(table.sections?.[0]?.fieldNames?.length);
|
||||
|
||||
cloneTable.sections?.[0]?.alternatives?.get("RECORD_VIEW")?.fieldNames?.push("another");
|
||||
expect(table.sections?.[0]?.alternatives?.get("RECORD_VIEW")?.fieldNames?.length).toEqual(2);
|
||||
expect(cloneTable.sections?.[0]?.alternatives?.get("RECORD_VIEW")?.fieldNames?.length).toEqual(3);
|
||||
|
||||
cloneTable.menus?.[0]?.icon && (cloneTable.menus[0].icon.name = "hamburger");
|
||||
cloneTable.menus?.[0]?.items && (cloneTable.menus[0].items.push(new QMenuItem({itemType: "DIVIDER"})));
|
||||
cloneTable.menus && (cloneTable.menus.push(new QMenu({})));
|
||||
expect(cloneTable.menus?.[0]?.icon?.name).not.toEqual(table.menus?.[0]?.icon?.name);
|
||||
expect(cloneTable.menus?.[0]?.items?.length).not.toEqual(table.menus?.[0]?.items?.length);
|
||||
expect(cloneTable.menus?.length).not.toEqual(table.menus?.length);
|
||||
});
|
||||
|
||||
});
|
||||
@@ -0,0 +1,105 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2025. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import {QTableSection} from "../../../src/model/metaData/QTableSection";
|
||||
|
||||
describe("QTableSection", () =>
|
||||
{
|
||||
describe("constructor", () =>
|
||||
{
|
||||
it("should construct with collapsible object if set in source object", () =>
|
||||
{
|
||||
const section = new QTableSection({
|
||||
name: "section1",
|
||||
collapsible: {
|
||||
isCollapsible: true,
|
||||
initiallyOpen: false
|
||||
}
|
||||
});
|
||||
|
||||
expect(section.name).toBe("section1");
|
||||
expect(section.collapsible?.isCollapsible).toBe(true);
|
||||
expect(section.collapsible?.initiallyOpen).toBe(false);
|
||||
});
|
||||
|
||||
it("should construct with undefined collapsible object if not present in source object", () =>
|
||||
{
|
||||
const section = new QTableSection({
|
||||
name: "section2"
|
||||
});
|
||||
|
||||
expect(section.name).toBe("section2");
|
||||
expect(section.collapsible).toBeUndefined();
|
||||
});
|
||||
|
||||
it("should construct with collapsible object with null values if empty collapsible object is in source", () =>
|
||||
{
|
||||
const section = new QTableSection({
|
||||
name: "section3",
|
||||
collapsible: {}
|
||||
});
|
||||
|
||||
expect(section.name).toBe("section3");
|
||||
expect(section.collapsible?.isCollapsible).toBe(false);
|
||||
expect(section.collapsible?.initiallyOpen).toBe(false);
|
||||
});
|
||||
|
||||
it("should deeply clone a collapsible", () =>
|
||||
{
|
||||
const section = new QTableSection({
|
||||
name: "section4",
|
||||
collapsible: {
|
||||
isCollapsible: true,
|
||||
initiallyOpen: true
|
||||
}
|
||||
});
|
||||
|
||||
expect(section.name).toBe("section4");
|
||||
expect(section.collapsible?.isCollapsible).toBe(true);
|
||||
expect(section.collapsible?.initiallyOpen).toBe(true);
|
||||
|
||||
const clone = section.clone();
|
||||
expect(clone.collapsible?.isCollapsible).toBe(true);
|
||||
expect(clone.collapsible?.initiallyOpen).toBe(true);
|
||||
|
||||
if(clone.collapsible)
|
||||
{
|
||||
clone.collapsible.initiallyOpen = false;
|
||||
}
|
||||
expect(section.collapsible?.initiallyOpen).toBe(true);
|
||||
expect(clone.collapsible?.initiallyOpen).toBe(false);
|
||||
});
|
||||
|
||||
it("should handle an undefined collapsible during cloning", () =>
|
||||
{
|
||||
const section = new QTableSection({
|
||||
name: "section5"
|
||||
});
|
||||
|
||||
expect(section.name).toBe("section5");
|
||||
expect(section.collapsible).toBeUndefined();
|
||||
|
||||
const clone = section.clone();
|
||||
expect(clone.collapsible).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
});
|
||||
@@ -0,0 +1,67 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2025. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import {QWidgetMetaData} from "../../../src/model/metaData/QWidgetMetaData";
|
||||
|
||||
describe("QWidgetMetaData", () =>
|
||||
{
|
||||
describe("constructor", () =>
|
||||
{
|
||||
it("should construct with collapsible object if set in source object", () =>
|
||||
{
|
||||
const widget = new QWidgetMetaData({
|
||||
name: "widget1",
|
||||
collapsible: {
|
||||
isCollapsible: true,
|
||||
initiallyOpen: false
|
||||
}
|
||||
});
|
||||
|
||||
expect(widget.name).toBe("widget1");
|
||||
expect(widget.collapsible?.isCollapsible).toBe(true);
|
||||
expect(widget.collapsible?.initiallyOpen).toBe(false);
|
||||
});
|
||||
|
||||
it("should construct with undefined collapsible object if not present in source object", () =>
|
||||
{
|
||||
const widget = new QWidgetMetaData({
|
||||
name: "widget2"
|
||||
});
|
||||
|
||||
expect(widget.name).toBe("widget2");
|
||||
expect(widget.collapsible).toBeUndefined();
|
||||
});
|
||||
|
||||
it("should construct with collapsible object with null values if empty collapsible object is in source", () =>
|
||||
{
|
||||
const widget = new QWidgetMetaData({
|
||||
name: "widget3",
|
||||
collapsible: {}
|
||||
});
|
||||
|
||||
expect(widget.name).toBe("widget3");
|
||||
expect(widget.collapsible?.isCollapsible).toBe(false);
|
||||
expect(widget.collapsible?.initiallyOpen).toBe(false);
|
||||
});
|
||||
|
||||
});
|
||||
|
||||
});
|
||||
Reference in new issue
Block a user