Forker/OpenNoodl
1
0
Fork 0
mirror of https://github.com/The-Low-Code-Foundation/OpenNoodl.git synced 2026-01-10 14:22:53 +01:00
Code Issues Actions Packages Projects Releases 1 Wiki Activity

feat: Improve the Noodl.Records.query typings API (#25)

Browse Source
This commit is contained in:
Eric Tuvesson
2024-05-24 15:49:05 +02:00
committed by Richard Osborne
parent c514c760e4
commit 509e967028
3 changed files with 127 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
packages/noodl-runtime/src/nodes/std-library/data/setdbmodelpropertiesnode.js
View File

@@ -75,12 +75,12 @@ var SetDbModelPropertiedNodeDefinition = {
_this.setError('Missing Record Id');
return;
}
var model = internal.model;
for (var i in internal.inputValues) {
model.set(i, internal.inputValues[i], { resolve: true });
const model = internal.model;
for (const key in internal.inputValues) {
model.set(key, internal.inputValues[key], { resolve: true });
}
CloudStore.forScope(_this.nodeScope.modelScope).save({
collection: internal.collectionId,
objectId: model.getId(), // Get the objectId part of the model id

67
packages/noodl-viewer-cloud/static/viewer/global.d.ts.keep
View File

@@ -74,6 +74,59 @@ declare namespace Noodl {
*/
const Object: any;
type RecordQuery<T> =
{
lessThan: T
} |
{
lessThanOrEqualTo: T
} |
{
greaterThan: T
} |
{
greaterThanOrEqualTo: T
} |
{
equalTo: T
} |
{
notEqualTo: T
} |
{
containedIn: T
} |
{
notContainedIn : T
} |
{
exists: T
} |
{
matchesRegex: T
} |
{
text: T
} |
{
idEqualTo: T
} |
{
idContainedIn: T
} |
{
pointsTo: T
} |
{
relatedTo: T
};
type RecordQueryField<T> = T extends RecordQuery<any> ?
{ [K in keyof T]: { [P in K]: T[P] } & Partial<Record<Exclude<keyof T, K>, never>> }[keyof T]
: never;
type RecordSortKey<T extends string> = (`${T}` | `-${T}`)[];
interface RecordsApi {
/**
* This is an async function that will query the database using the query
@@ -115,15 +168,17 @@ declare namespace Noodl {
* })
* ```
*/
query(
className: RecordClassName,
query?: any,
query<TClassName extends RecordClassName>(
className: TClassName,
query?:
RecordQueryField<{ [K in keyof DatabaseSchema[TClassName]]: RecordQuery<any> }> |
{ and: RecordQueryField<{ [K in keyof DatabaseSchema[TClassName]]: RecordQuery<any> }>[] },
options?: {
limit?: number;
skip?: number;
sort?: string[];
include?: any;
select?: any;
sort?: string | RecordSortKey<keyof DatabaseSchema[TClassName]>;
include?: string | (keyof DatabaseSchema[TClassName])[];
select?: string | (keyof DatabaseSchema[TClassName])[];
}
): Promise<any>;

67
packages/noodl-viewer-react/static/viewer/global.d.ts.keep
View File

@@ -131,6 +131,59 @@ declare namespace Noodl {
*/
const Events: EventsApi;
type RecordQuery<T> =
{
lessThan: T
} |
{
lessThanOrEqualTo: T
} |
{
greaterThan: T
} |
{
greaterThanOrEqualTo: T
} |
{
equalTo: T
} |
{
notEqualTo: T
} |
{
containedIn: T
} |
{
notContainedIn : T
} |
{
exists: T
} |
{
matchesRegex: T
} |
{
text: T
} |
{
idEqualTo: T
} |
{
idContainedIn: T
} |
{
pointsTo: T
} |
{
relatedTo: T
};
type RecordQueryField<T> = T extends RecordQuery<any> ?
{ [K in keyof T]: { [P in K]: T[P] } & Partial<Record<Exclude<keyof T, K>, never>> }[keyof T]
: never;
type RecordSortKey<T extends string> = (`${T}` | `-${T}`)[];
interface RecordsApi {
/**
* This is an async function that will query the database using the query
@@ -172,15 +225,17 @@ declare namespace Noodl {
* })
* ```
*/
query(
className: RecordClassName,
query?: any,
query<TClassName extends RecordClassName>(
className: TClassName,
query?:
RecordQueryField<{ [K in keyof DatabaseSchema[TClassName]]: RecordQuery<any> }> |
{ and: RecordQueryField<{ [K in keyof DatabaseSchema[TClassName]]: RecordQuery<any> }>[] },
options?: {
limit?: number;
skip?: number;
sort?: string[];
include?: any;
select?: any;
sort?: string | RecordSortKey<keyof DatabaseSchema[TClassName]>;
include?: string | (keyof DatabaseSchema[TClassName])[];
select?: string | (keyof DatabaseSchema[TClassName])[];
}
): Promise<any>;