@memberjunction/core 6.2.0-edge.4 → 6.2.0-edge.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generic/BaseEntitySaveQueue.d.ts +22 -0
- package/dist/generic/BaseEntitySaveQueue.d.ts.map +1 -1
- package/dist/generic/BaseEntitySaveQueue.js +43 -4
- package/dist/generic/BaseEntitySaveQueue.js.map +1 -1
- package/dist/generic/JSONType-interfaces/IEntityConfiguration.d.ts +18 -0
- package/dist/generic/JSONType-interfaces/IEntityConfiguration.d.ts.map +1 -1
- package/dist/generic/alternateBaseViews.d.ts +119 -0
- package/dist/generic/alternateBaseViews.d.ts.map +1 -0
- package/dist/generic/alternateBaseViews.js +223 -0
- package/dist/generic/alternateBaseViews.js.map +1 -0
- package/dist/generic/baseEngine.d.ts +82 -14
- package/dist/generic/baseEngine.d.ts.map +1 -1
- package/dist/generic/baseEngine.js +311 -46
- package/dist/generic/baseEngine.js.map +1 -1
- package/dist/generic/baseEngineRegistry.d.ts.map +1 -1
- package/dist/generic/baseEngineRegistry.js +2 -1
- package/dist/generic/baseEngineRegistry.js.map +1 -1
- package/dist/generic/baseEntity.d.ts +194 -14
- package/dist/generic/baseEntity.d.ts.map +1 -1
- package/dist/generic/baseEntity.js +638 -218
- package/dist/generic/baseEntity.js.map +1 -1
- package/dist/generic/baseInfo.d.ts +31 -3
- package/dist/generic/baseInfo.d.ts.map +1 -1
- package/dist/generic/baseInfo.js +138 -40
- package/dist/generic/baseInfo.js.map +1 -1
- package/dist/generic/contextTokens.d.ts +136 -0
- package/dist/generic/contextTokens.d.ts.map +1 -0
- package/dist/generic/contextTokens.js +319 -0
- package/dist/generic/contextTokens.js.map +1 -0
- package/dist/generic/databaseProviderBase.d.ts +103 -13
- package/dist/generic/databaseProviderBase.d.ts.map +1 -1
- package/dist/generic/databaseProviderBase.js +321 -77
- package/dist/generic/databaseProviderBase.js.map +1 -1
- package/dist/generic/embeddedRecord.d.ts +6 -0
- package/dist/generic/embeddedRecord.d.ts.map +1 -1
- package/dist/generic/embeddedRecord.js +15 -1
- package/dist/generic/embeddedRecord.js.map +1 -1
- package/dist/generic/entityCompanion.d.ts +7 -0
- package/dist/generic/entityCompanion.d.ts.map +1 -1
- package/dist/generic/entityCompanion.js +8 -0
- package/dist/generic/entityCompanion.js.map +1 -1
- package/dist/generic/entityConfiguration.d.ts +8 -2
- package/dist/generic/entityConfiguration.d.ts.map +1 -1
- package/dist/generic/entityConfiguration.js +9 -0
- package/dist/generic/entityConfiguration.js.map +1 -1
- package/dist/generic/entityInfo.d.ts +306 -12
- package/dist/generic/entityInfo.d.ts.map +1 -1
- package/dist/generic/entityInfo.js +894 -92
- package/dist/generic/entityInfo.js.map +1 -1
- package/dist/generic/entityValueFieldSecurity.d.ts +139 -0
- package/dist/generic/entityValueFieldSecurity.d.ts.map +1 -0
- package/dist/generic/entityValueFieldSecurity.js +250 -0
- package/dist/generic/entityValueFieldSecurity.js.map +1 -0
- package/dist/generic/fieldSecuritySQLGate.d.ts +350 -0
- package/dist/generic/fieldSecuritySQLGate.d.ts.map +1 -0
- package/dist/generic/fieldSecuritySQLGate.js +898 -0
- package/dist/generic/fieldSecuritySQLGate.js.map +1 -0
- package/dist/generic/indexRestrictedFields.d.ts +47 -0
- package/dist/generic/indexRestrictedFields.d.ts.map +1 -0
- package/dist/generic/indexRestrictedFields.js +129 -0
- package/dist/generic/indexRestrictedFields.js.map +1 -0
- package/dist/generic/infoProviderResolution.d.ts +16 -0
- package/dist/generic/infoProviderResolution.d.ts.map +1 -0
- package/dist/generic/infoProviderResolution.js +17 -0
- package/dist/generic/infoProviderResolution.js.map +1 -0
- package/dist/generic/interfaces.d.ts +39 -2
- package/dist/generic/interfaces.d.ts.map +1 -1
- package/dist/generic/interfaces.js.map +1 -1
- package/dist/generic/localCacheManager.d.ts +318 -51
- package/dist/generic/localCacheManager.d.ts.map +1 -1
- package/dist/generic/localCacheManager.js +675 -109
- package/dist/generic/localCacheManager.js.map +1 -1
- package/dist/generic/logging.d.ts.map +1 -1
- package/dist/generic/logging.js +7 -1
- package/dist/generic/logging.js.map +1 -1
- package/dist/generic/metadata.d.ts +3 -2
- package/dist/generic/metadata.d.ts.map +1 -1
- package/dist/generic/metadata.js +5 -2
- package/dist/generic/metadata.js.map +1 -1
- package/dist/generic/mjapiUrl.d.ts +21 -0
- package/dist/generic/mjapiUrl.d.ts.map +1 -0
- package/dist/generic/mjapiUrl.js +25 -0
- package/dist/generic/mjapiUrl.js.map +1 -0
- package/dist/generic/platformSQL.d.ts +54 -0
- package/dist/generic/platformSQL.d.ts.map +1 -1
- package/dist/generic/platformSQL.js +55 -0
- package/dist/generic/platformSQL.js.map +1 -1
- package/dist/generic/providerBase.d.ts +370 -57
- package/dist/generic/providerBase.d.ts.map +1 -1
- package/dist/generic/providerBase.js +1085 -284
- package/dist/generic/providerBase.js.map +1 -1
- package/dist/generic/queryInfo.d.ts +23 -9
- package/dist/generic/queryInfo.d.ts.map +1 -1
- package/dist/generic/queryInfo.js +73 -33
- package/dist/generic/queryInfo.js.map +1 -1
- package/dist/generic/queryInfoInterfaces.d.ts +8 -0
- package/dist/generic/queryInfoInterfaces.d.ts.map +1 -1
- package/dist/generic/queryTemplateContext.d.ts +49 -0
- package/dist/generic/queryTemplateContext.d.ts.map +1 -0
- package/dist/generic/queryTemplateContext.js +113 -0
- package/dist/generic/queryTemplateContext.js.map +1 -0
- package/dist/generic/recordChangeFieldSecurity.d.ts.map +1 -1
- package/dist/generic/recordChangeFieldSecurity.js +13 -2
- package/dist/generic/recordChangeFieldSecurity.js.map +1 -1
- package/dist/generic/relatedRecordCollection.d.ts +13 -0
- package/dist/generic/relatedRecordCollection.d.ts.map +1 -1
- package/dist/generic/relatedRecordCollection.js +44 -5
- package/dist/generic/relatedRecordCollection.js.map +1 -1
- package/dist/generic/runQuery.d.ts +42 -0
- package/dist/generic/runQuery.d.ts.map +1 -1
- package/dist/generic/runQuery.js +14 -0
- package/dist/generic/runQuery.js.map +1 -1
- package/dist/generic/runQuerySQLFilterImplementations.d.ts.map +1 -1
- package/dist/generic/runQuerySQLFilterImplementations.js +38 -2
- package/dist/generic/runQuerySQLFilterImplementations.js.map +1 -1
- package/dist/generic/saveEntityGraphOperation.d.ts.map +1 -1
- package/dist/generic/saveEntityGraphOperation.js +3 -0
- package/dist/generic/saveEntityGraphOperation.js.map +1 -1
- package/dist/generic/scoring/ReciprocalRankFusion.d.ts.map +1 -1
- package/dist/generic/scoring/ReciprocalRankFusion.js +10 -3
- package/dist/generic/scoring/ReciprocalRankFusion.js.map +1 -1
- package/dist/generic/securityInfo.d.ts +17 -6
- package/dist/generic/securityInfo.d.ts.map +1 -1
- package/dist/generic/securityInfo.js +25 -10
- package/dist/generic/securityInfo.js.map +1 -1
- package/dist/generic/telemetryManager.d.ts +9 -0
- package/dist/generic/telemetryManager.d.ts.map +1 -1
- package/dist/generic/telemetryManager.js +5 -1
- package/dist/generic/telemetryManager.js.map +1 -1
- package/dist/generic/util.d.ts.map +1 -1
- package/dist/generic/util.js +3 -0
- package/dist/generic/util.js.map +1 -1
- package/dist/generic/wellKnownUserSource.d.ts +3 -2
- package/dist/generic/wellKnownUserSource.d.ts.map +1 -1
- package/dist/generic/wellKnownUserSource.js +18 -9
- package/dist/generic/wellKnownUserSource.js.map +1 -1
- package/dist/index.d.ts +8 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +8 -0
- package/dist/index.js.map +1 -1
- package/dist/views/runView.d.ts +89 -0
- package/dist/views/runView.d.ts.map +1 -1
- package/dist/views/runView.js +36 -0
- package/dist/views/runView.js.map +1 -1
- package/dist/views/viewProperties.d.ts +55 -0
- package/dist/views/viewProperties.d.ts.map +1 -0
- package/dist/views/viewProperties.js +258 -0
- package/dist/views/viewProperties.js.map +1 -0
- package/package.json +3 -3
- package/readme.md +29 -4
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
*/
|
|
9
9
|
import { SerialTaskFlushResult } from '@memberjunction/global';
|
|
10
10
|
import { BaseEntity } from './baseEntity.js';
|
|
11
|
+
import type { EntitySaveReturnMode } from './entityConfiguration.js';
|
|
11
12
|
/**
|
|
12
13
|
* A per-entity-instance serial save queue. INSERT and UPDATE of the same `BaseEntity` instance are
|
|
13
14
|
* serialized (the UPDATE waits for the INSERT to land); different entities save concurrently. All
|
|
@@ -18,13 +19,18 @@ import { BaseEntity } from './baseEntity.js';
|
|
|
18
19
|
export declare class BaseEntitySaveQueue {
|
|
19
20
|
private readonly queue;
|
|
20
21
|
private readonly onError?;
|
|
22
|
+
private readonly saveReturnMode?;
|
|
21
23
|
/**
|
|
22
24
|
* @param opts.onError Optional handler for a failed save's diagnostic message. Defaults to the
|
|
23
25
|
* global `LogError`. Consumers with structured logging (e.g. a category/metadata logger) pass
|
|
24
26
|
* their own so failures stay in their log stream.
|
|
27
|
+
* @param opts.saveReturnMode Optional {@link EntitySaveReturnMode} forwarded to every queued
|
|
28
|
+
* `entity.Save(options)` call (e.g. `'datestamps_only'` for high-write execution log queues
|
|
29
|
+
* whose wide JSON/text payload columns are already in memory).
|
|
25
30
|
*/
|
|
26
31
|
constructor(opts?: {
|
|
27
32
|
onError?: (message: string) => void;
|
|
33
|
+
saveReturnMode?: EntitySaveReturnMode;
|
|
28
34
|
});
|
|
29
35
|
/**
|
|
30
36
|
* Fire-and-forget INSERT of a freshly `NewRecord()`'d entity. The entity instance is the
|
|
@@ -37,6 +43,14 @@ export declare class BaseEntitySaveQueue {
|
|
|
37
43
|
* until the dependency's own INSERT has landed in the database.
|
|
38
44
|
*/
|
|
39
45
|
InsertAfter(entity: BaseEntity, dependency: BaseEntity): void;
|
|
46
|
+
/**
|
|
47
|
+
* Fire-and-forget INSERT that runs only after `ready` resolves. Use this when the row has a foreign
|
|
48
|
+
* key to a row that **another** queue is still writing: pass that queue's {@link Settled} for the
|
|
49
|
+
* parent. The INSERT is queued at once (so {@link Flush} waits for it) and the caller never waits;
|
|
50
|
+
* only the save itself is held back. ({@link InsertAfter} is the same wait when both rows share this
|
|
51
|
+
* queue.)
|
|
52
|
+
*/
|
|
53
|
+
InsertWhen(entity: BaseEntity, ready: Promise<void>): void;
|
|
40
54
|
/**
|
|
41
55
|
* Fire-and-forget UPDATE chained after the entity's INSERT. `applyMutation` (if given) runs INSIDE
|
|
42
56
|
* the post-INSERT task — after `finalizeSave`'s reload — so its values always survive; the save is
|
|
@@ -44,6 +58,14 @@ export declare class BaseEntitySaveQueue {
|
|
|
44
58
|
* AND cannot race an in-flight INSERT.
|
|
45
59
|
*/
|
|
46
60
|
Update(entity: BaseEntity, applyMutation?: (entity: BaseEntity) => void): void;
|
|
61
|
+
private buildSaveOptions;
|
|
62
|
+
/**
|
|
63
|
+
* Resolves once every save queued so far for `entity` has settled (at once when none is pending);
|
|
64
|
+
* never rejects — a failed save is already logged here. For a caller that holds the entity's ID and
|
|
65
|
+
* must write a dependent row (a foreign key to it) from a *different* queue: `InsertAfter` only
|
|
66
|
+
* orders writes within this queue.
|
|
67
|
+
*/
|
|
68
|
+
Settled(entity: BaseEntity): Promise<void>;
|
|
47
69
|
/** Awaits all pending saves and returns failure diagnostics. Call at the run/goal finalize boundary. */
|
|
48
70
|
Flush(): Promise<SerialTaskFlushResult>;
|
|
49
71
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseEntitySaveQueue.d.ts","sourceRoot":"","sources":["../../src/generic/BaseEntitySaveQueue.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAwB,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AACrF,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"BaseEntitySaveQueue.d.ts","sourceRoot":"","sources":["../../src/generic/BaseEntitySaveQueue.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAwB,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AACrF,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAIlE;;;;;;GAMG;AACH,qBAAa,mBAAmB;IAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA8B;IACpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAA4B;IACrD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAuB;IAEvD;;;;;;;OAOG;gBACS,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;QAAC,cAAc,CAAC,EAAE,oBAAoB,CAAA;KAAE;IAKjG;;;OAGG;IACI,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAMvC;;;;OAIG;IACI,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI;IAMpE;;;;;;OAMG;IACI,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;IAMjE;;;;;OAKG;IACI,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,GAAG,IAAI;IAMrF,OAAO,CAAC,gBAAgB;IAcxB;;;;;OAKG;IACI,OAAO,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjD,wGAAwG;IACjG,KAAK,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAI9C;;;;OAIG;YACW,OAAO;IAgBrB,oGAAoG;IACpG,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,QAAQ;IAUhB,OAAO,CAAC,SAAS;CAGpB"}
|
|
@@ -21,10 +21,14 @@ export class BaseEntitySaveQueue {
|
|
|
21
21
|
* @param opts.onError Optional handler for a failed save's diagnostic message. Defaults to the
|
|
22
22
|
* global `LogError`. Consumers with structured logging (e.g. a category/metadata logger) pass
|
|
23
23
|
* their own so failures stay in their log stream.
|
|
24
|
+
* @param opts.saveReturnMode Optional {@link EntitySaveReturnMode} forwarded to every queued
|
|
25
|
+
* `entity.Save(options)` call (e.g. `'datestamps_only'` for high-write execution log queues
|
|
26
|
+
* whose wide JSON/text payload columns are already in memory).
|
|
24
27
|
*/
|
|
25
28
|
constructor(opts) {
|
|
26
29
|
this.queue = new KeyedSerialTaskQueue();
|
|
27
30
|
this.onError = opts?.onError;
|
|
31
|
+
this.saveReturnMode = opts?.saveReturnMode;
|
|
28
32
|
}
|
|
29
33
|
/**
|
|
30
34
|
* Fire-and-forget INSERT of a freshly `NewRecord()`'d entity. The entity instance is the
|
|
@@ -32,7 +36,8 @@ export class BaseEntitySaveQueue {
|
|
|
32
36
|
*/
|
|
33
37
|
Insert(entity) {
|
|
34
38
|
const label = this.labelFor('Insert', entity);
|
|
35
|
-
|
|
39
|
+
const options = this.buildSaveOptions(false);
|
|
40
|
+
void this.queue.enqueue(entity, () => this.runSave(entity, label, options), { isOk: (ok) => ok === true, label });
|
|
36
41
|
}
|
|
37
42
|
/**
|
|
38
43
|
* Fire-and-forget INSERT that waits for `dependency`'s pending tasks to settle first. Use this for
|
|
@@ -41,7 +46,20 @@ export class BaseEntitySaveQueue {
|
|
|
41
46
|
*/
|
|
42
47
|
InsertAfter(entity, dependency) {
|
|
43
48
|
const label = this.labelFor('Insert', entity);
|
|
44
|
-
|
|
49
|
+
const options = this.buildSaveOptions(false);
|
|
50
|
+
void this.queue.enqueue(entity, () => this.runSave(entity, label, options), { isOk: (ok) => ok === true, label, after: dependency });
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Fire-and-forget INSERT that runs only after `ready` resolves. Use this when the row has a foreign
|
|
54
|
+
* key to a row that **another** queue is still writing: pass that queue's {@link Settled} for the
|
|
55
|
+
* parent. The INSERT is queued at once (so {@link Flush} waits for it) and the caller never waits;
|
|
56
|
+
* only the save itself is held back. ({@link InsertAfter} is the same wait when both rows share this
|
|
57
|
+
* queue.)
|
|
58
|
+
*/
|
|
59
|
+
InsertWhen(entity, ready) {
|
|
60
|
+
const label = this.labelFor('Insert', entity);
|
|
61
|
+
const options = this.buildSaveOptions(false);
|
|
62
|
+
void this.queue.Enqueue(entity, () => this.runSave(entity, label, options), { isOk: (ok) => ok === true, label, ready });
|
|
45
63
|
}
|
|
46
64
|
/**
|
|
47
65
|
* Fire-and-forget UPDATE chained after the entity's INSERT. `applyMutation` (if given) runs INSIDE
|
|
@@ -51,10 +69,31 @@ export class BaseEntitySaveQueue {
|
|
|
51
69
|
*/
|
|
52
70
|
Update(entity, applyMutation) {
|
|
53
71
|
const label = this.labelFor('Update', entity);
|
|
54
|
-
const options =
|
|
55
|
-
options.IgnoreDirtyState = true;
|
|
72
|
+
const options = this.buildSaveOptions(true);
|
|
56
73
|
void this.queue.enqueue(entity, () => this.runSave(entity, label, options, applyMutation), { isOk: (ok) => ok === true, label });
|
|
57
74
|
}
|
|
75
|
+
buildSaveOptions(ignoreDirtyState) {
|
|
76
|
+
if (!ignoreDirtyState && !this.saveReturnMode) {
|
|
77
|
+
return undefined;
|
|
78
|
+
}
|
|
79
|
+
const options = new EntitySaveOptions();
|
|
80
|
+
if (ignoreDirtyState) {
|
|
81
|
+
options.IgnoreDirtyState = true;
|
|
82
|
+
}
|
|
83
|
+
if (this.saveReturnMode) {
|
|
84
|
+
options.SaveReturnMode = this.saveReturnMode;
|
|
85
|
+
}
|
|
86
|
+
return options;
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Resolves once every save queued so far for `entity` has settled (at once when none is pending);
|
|
90
|
+
* never rejects — a failed save is already logged here. For a caller that holds the entity's ID and
|
|
91
|
+
* must write a dependent row (a foreign key to it) from a *different* queue: `InsertAfter` only
|
|
92
|
+
* orders writes within this queue.
|
|
93
|
+
*/
|
|
94
|
+
Settled(entity) {
|
|
95
|
+
return this.queue.Settled(entity);
|
|
96
|
+
}
|
|
58
97
|
/** Awaits all pending saves and returns failure diagnostics. Call at the run/goal finalize boundary. */
|
|
59
98
|
Flush() {
|
|
60
99
|
return this.queue.flush();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseEntitySaveQueue.js","sourceRoot":"","sources":["../../src/generic/BaseEntitySaveQueue.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,oBAAoB,EAAyB,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"BaseEntitySaveQueue.js","sourceRoot":"","sources":["../../src/generic/BaseEntitySaveQueue.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,oBAAoB,EAAyB,MAAM,wBAAwB,CAAC;AAGrF,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC;;;;;;GAMG;AACH,MAAM,OAAO,mBAAmB;IAK5B;;;;;;;OAOG;IACH,YAAY,IAAqF;QAZhF,UAAK,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAahD,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,OAAO,CAAC;QAC7B,IAAI,CAAC,cAAc,GAAG,IAAI,EAAE,cAAc,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAkB;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC7C,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACtH,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,MAAkB,EAAE,UAAsB;QACzD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC7C,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;IACzI,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAAC,MAAkB,EAAE,KAAoB;QACtD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC7C,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7H,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAkB,EAAE,aAA4C;QAC1E,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC5C,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACrI,CAAC;IAEO,gBAAgB,CAAC,gBAAyB;QAC9C,IAAI,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC5C,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,iBAAiB,EAAE,CAAC;QACxC,IAAI,gBAAgB,EAAE,CAAC;YACnB,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;QACpC,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QACjD,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,MAAkB;QAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,wGAAwG;IACjG,KAAK;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,OAAO,CAAC,MAAkB,EAAE,KAAa,EAAE,OAA2B,EAAE,aAA4C;QAC9H,IAAI,CAAC;YACD,IAAI,aAAa,EAAE,CAAC;gBAChB,aAAa,CAAC,MAAM,CAAC,CAAC;YAC1B,CAAC;YACD,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,CAAC,EAAE,EAAE,CAAC;gBACN,IAAI,CAAC,UAAU,CAAC,GAAG,KAAK,YAAY,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAClE,CAAC;YACD,OAAO,EAAE,CAAC;QACd,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,IAAI,CAAC,UAAU,CAAC,GAAG,KAAK,WAAW,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACjF,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IAED,oGAAoG;IAC5F,UAAU,CAAC,OAAe;QAC9B,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;aAAM,CAAC;YACJ,QAAQ,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC;IACL,CAAC;IAEO,QAAQ,CAAC,EAAuB,EAAE,MAAkB;QACxD,IAAI,IAAI,GAAG,QAAQ,CAAC;QACpB,IAAI,CAAC;YACD,IAAI,GAAG,MAAM,CAAC,UAAU,EAAE,IAAI,IAAI,QAAQ,CAAC;QAC/C,CAAC;QAAC,MAAM,CAAC;YACL,gFAAgF;QACpF,CAAC;QACD,OAAO,uBAAuB,EAAE,IAAI,IAAI,GAAG,CAAC;IAChD,CAAC;IAEO,SAAS,CAAC,MAAkB;QAChC,OAAO,MAAM,CAAC,YAAY,EAAE,eAAe,IAAI,qBAAqB,CAAC;IACzE,CAAC;CACJ"}
|
|
@@ -20,6 +20,17 @@
|
|
|
20
20
|
*
|
|
21
21
|
* @see guides/FORMS_ARCHITECTURE_GUIDE.md §7d
|
|
22
22
|
*/
|
|
23
|
+
/**
|
|
24
|
+
* Controls which columns a save operation (`spCreate` / `spUpdate` and provider save wrappers)
|
|
25
|
+
* returns from the database:
|
|
26
|
+
* - `'full'` (default): Re-queries `SELECT * FROM <BaseView>` after `INSERT`/`UPDATE` so all
|
|
27
|
+
* columns (including virtual/joined columns) are returned from the database.
|
|
28
|
+
* - `'datestamps_only'`: Returns only the primary key column(s) plus `__mj_CreatedAt` and
|
|
29
|
+
* `__mj_UpdatedAt` (when present on the entity) directly from `<BaseTable>`, avoiding the
|
|
30
|
+
* expensive `BaseView` JOINs and large column reads while still returning exact DB-generated
|
|
31
|
+
* keys and timestamps for optimistic concurrency / inconsistency checks.
|
|
32
|
+
*/
|
|
33
|
+
export type EntitySaveReturnMode = 'full' | 'datestamps_only';
|
|
23
34
|
export interface IEntityConfiguration {
|
|
24
35
|
/**
|
|
25
36
|
* Presentation / chrome. Null = host defaults (`Layout: auto`,
|
|
@@ -38,6 +49,13 @@ export interface IEntityConfiguration {
|
|
|
38
49
|
* policy says Deep, unless NotCloneable is true.
|
|
39
50
|
*/
|
|
40
51
|
Clone?: IEntityCloneConfiguration;
|
|
52
|
+
/**
|
|
53
|
+
* Controls which columns a save operation (`spCreate` / `spUpdate`) returns from the database.
|
|
54
|
+
* - `'full'` (default when omitted): Re-queries `SELECT * FROM <BaseView>` after `INSERT`/`UPDATE`.
|
|
55
|
+
* - `'datestamps_only'`: Selects only the primary key(s) and `__mj_CreatedAt`/`__mj_UpdatedAt`
|
|
56
|
+
* directly from `<BaseTable>`, preserving in-memory field values on the saved entity.
|
|
57
|
+
*/
|
|
58
|
+
SaveReturnMode?: EntitySaveReturnMode;
|
|
41
59
|
}
|
|
42
60
|
/**
|
|
43
61
|
* Configuration for entity-level file attachments.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IEntityConfiguration.d.ts","sourceRoot":"","sources":["../../../src/generic/JSONType-interfaces/IEntityConfiguration.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;OAGG;IACH,EAAE,CAAC,EAAE,sBAAsB,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,+BAA+B,CAAC;IAE9C;;;;;OAKG;IACH,KAAK,CAAC,EAAE,yBAAyB,CAAC;
|
|
1
|
+
{"version":3,"file":"IEntityConfiguration.d.ts","sourceRoot":"","sources":["../../../src/generic/JSONType-interfaces/IEntityConfiguration.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH;;;;;;;;;GASG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,iBAAiB,CAAC;AAE9D,MAAM,WAAW,oBAAoB;IACjC;;;OAGG;IACH,EAAE,CAAC,EAAE,sBAAsB,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,+BAA+B,CAAC;IAE9C;;;;;OAKG;IACH,KAAK,CAAC,EAAE,yBAAyB,CAAC;IAElC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,oBAAoB,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC5C;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;OAGG;IACH,IAAI,CAAC,EAAE,wBAAwB,CAAC;CACnC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,UAAU,GAAG,MAAM,CAAC;IAE3C;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;;;;;OAUG;IACH,iBAAiB,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC;IAEjD;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAE5C;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACtC,iDAAiD;IACjD,OAAO,CAAC,EAAE,CAAC,CAAC;IACZ,sEAAsE;IACtE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8LAA8L;IAC9L,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,kFAAkF;IAClF,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,6FAA6F;IAC7F,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IACjC,8DAA8D;IAC9D,SAAS,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IAC/B,gGAAgG;IAChG,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,mNAAmN;IACnN,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IACzD,uKAAuK;IACvK,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IACrD,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,gJAAgJ;IAChJ,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,gGAAgG;IAChG,UAAU,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACrE,uHAAuH;IACvH,UAAU,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;IACnC,2IAA2I;IAC3I,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,wEAAwE;IACxE,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,KAAK,CAAC;IACnD,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,EAAE,CAAC,EAAE;QACD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,oFAAoF;QACpF,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;KAC7B,CAAC;CACL;AAED,MAAM,WAAW,kBAAkB;IAC/B,iLAAiL;IACjL,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8HAA8H;IAC9H,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,kLAAkL;IAClL,QAAQ,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,MAAM,CAAC;CACzD;AAED,MAAM,WAAW,gBAAgB;IAC7B,sIAAsI;IACtI,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,gGAAgG;IAChG,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,oCAAoC;IACpC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,iGAAiG;IACjG,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,0FAA0F;IAC1F,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,+HAA+H;IAC/H,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,gEAAgE;IAChE,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC/B,oIAAoI;IACpI,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAC3B,qFAAqF;IACrF,UAAU,CAAC,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,WAAW,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACxG,oKAAoK;IACpK,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,kDAAkD;IAClD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC3B,6GAA6G;IAC7G,IAAI,EAAE,MAAM,CAAC;IACb,6KAA6K;IAC7K,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC;IACzD,0CAA0C;IAC1C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,0HAA0H;IAC1H,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC7B,oEAAoE;IACpE,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED,8IAA8I;AAC9I,MAAM,WAAW,gBAAgB;IAC7B,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,oDAAoD;IACpD,MAAM,CAAC,EAAE,qBAAqB,GAAG,6BAA6B,CAAC;CAClE;AAED,MAAM,WAAW,wBAAwB;IACrC,MAAM,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,CAAC;IACvC,4BAA4B;IAC5B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yHAAyH;IACzH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,mFAAmF;IACnF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yJAAyJ;IACzJ,WAAW,CAAC,EAAE,kBAAkB,EAAE,CAAC;IACnC,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED,kIAAkI;AAClI,MAAM,WAAW,kBAAkB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IAC1C,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACnC,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,MAAM,CAAC,EAAE,kBAAkB,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAC7B,2GAA2G;IAC3G,aAAa,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;IACpC,2FAA2F;IAC3F,SAAS,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;IAChC,gIAAgI;IAChI,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IACnC,mIAAmI;IACnI,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3C,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,uEAAuE;IACvE,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,QAAQ,GAAG,iBAAiB,CAAC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,4CAA4C;IAC5C,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IACzB,6DAA6D;IAC7D,GAAG,EAAE,MAAM,CAAC;IACZ,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,2DAA2D;IAC3D,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,CAAA;KAAE,CAAC,CAAC;IAC1E;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC"}
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
import { BaseEntity } from './baseEntity.js';
|
|
2
|
+
import { EntityAlternateBaseViewInfo, EntityInfo } from './entityInfo.js';
|
|
3
|
+
import { UserInfo } from './securityInfo.js';
|
|
4
|
+
import { RunViewParams } from '../views/runView.js';
|
|
5
|
+
/**
|
|
6
|
+
* Validates that `name` is a safe, unquoted SQL identifier (`1..128` characters, starting
|
|
7
|
+
* with an ASCII letter or underscore and containing only ASCII letters, digits, or underscores).
|
|
8
|
+
*
|
|
9
|
+
* Lives in `@memberjunction/core` so both client/server metadata validation (`ProviderBase`,
|
|
10
|
+
* `MJEntityAlternateBaseViewEntityServer`) and SQL generators can validate `ViewName` and
|
|
11
|
+
* `SchemaName` without introducing a dependency on `@memberjunction/schema-engine`.
|
|
12
|
+
*/
|
|
13
|
+
export declare function IsValidSQLIdentifier(name: string | null | undefined): boolean;
|
|
14
|
+
/**
|
|
15
|
+
* Validates that `name` is a valid semantic `EntityAlternateBaseView.Name`:
|
|
16
|
+
* non-empty after trimming, at most 100 characters, not starting with `//` (so `abv:` + `Name`
|
|
17
|
+
* can never form `abv://...`), and containing neither `|` nor `:` (the cache-fingerprint segment
|
|
18
|
+
* and prefix delimiters used by `LocalCacheManager` and `GenericDatabaseProvider`). Mirrors
|
|
19
|
+
* `CK_EntityAlternateBaseView_Name` in SQL.
|
|
20
|
+
*/
|
|
21
|
+
export declare function IsValidAlternateBaseViewName(name: string | null | undefined): boolean;
|
|
22
|
+
/**
|
|
23
|
+
* Options for resolving and authorizing an alternate base view on an entity.
|
|
24
|
+
*/
|
|
25
|
+
export interface ResolveAlternateBaseViewOptions {
|
|
26
|
+
/** The parent entity on which the alternate base view is registered. */
|
|
27
|
+
entity: EntityInfo;
|
|
28
|
+
/** The semantic `Name` of the alternate base view (for example, `'Active'`). */
|
|
29
|
+
alternateBaseViewName: string;
|
|
30
|
+
/** Optional user context for entity `CanRead` permission checks. */
|
|
31
|
+
contextUser?: UserInfo;
|
|
32
|
+
/**
|
|
33
|
+
* When `true` (the default whenever `contextUser` is provided), enforces
|
|
34
|
+
* `entity.CanRead` for `contextUser` when `entity.Permissions` is populated.
|
|
35
|
+
*/
|
|
36
|
+
enforcePermissions?: boolean;
|
|
37
|
+
/**
|
|
38
|
+
* When `false`, throws if the alternate base view (or any ancestor in its `ParentID` chain)
|
|
39
|
+
* has `Status === 'Deprecated'`. Defaults to `true` (allows deprecated views with a log warning).
|
|
40
|
+
*/
|
|
41
|
+
allowDeprecated?: boolean;
|
|
42
|
+
/**
|
|
43
|
+
* When `true`, suppresses the `[Deprecated]` log warning while still honoring `allowDeprecated`.
|
|
44
|
+
* Used by internal call sites that delegate after a caller has already logged deprecation.
|
|
45
|
+
*/
|
|
46
|
+
suppressDeprecationWarning?: boolean;
|
|
47
|
+
/** Optional caller label included in deprecation warnings and error messages. */
|
|
48
|
+
callerName?: string;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Resolved alternate base view metadata ready for SQL generation or cache routing.
|
|
52
|
+
*/
|
|
53
|
+
export interface AlternateBaseViewResolution {
|
|
54
|
+
/** The resolved alternate base view metadata object. */
|
|
55
|
+
view: EntityAlternateBaseViewInfo;
|
|
56
|
+
/** The owning entity metadata object. */
|
|
57
|
+
entity: EntityInfo;
|
|
58
|
+
/** Physical SQL view name (`view.ViewName`). */
|
|
59
|
+
effectiveViewName: string;
|
|
60
|
+
/** Physical database schema name (`view.EffectiveSchemaName`). */
|
|
61
|
+
effectiveSchemaName: string;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Resolves a semantic `AlternateBaseView` name against `entity`, validates that it is
|
|
65
|
+
* registered and usable (`Status` is `'Active'` or `'Deprecated'`, including all ancestors
|
|
66
|
+
* in any `ParentID` chain), emits a warning when deprecated, and enforces entity `CanRead`
|
|
67
|
+
* when `contextUser` is provided.
|
|
68
|
+
*
|
|
69
|
+
* Throws a descriptive `Error` on unknown, disabled, or unauthorized alternate base views
|
|
70
|
+
* (never silently falls back to `entity.BaseView`, preventing filtered-row disclosure).
|
|
71
|
+
*/
|
|
72
|
+
export declare function ResolveAlternateBaseView(options: ResolveAlternateBaseViewOptions): AlternateBaseViewResolution;
|
|
73
|
+
/**
|
|
74
|
+
* Searches across `entities` for an entity that registers a physical SQL view matching
|
|
75
|
+
* `viewName` (and optional `schemaName`) as an `EntityAlternateBaseView`.
|
|
76
|
+
*
|
|
77
|
+
* Used by SQL AST extractors (Query entity extraction, `ClientClauseScreen`, and ad-hoc SQL
|
|
78
|
+
* read authorization) so queries referencing an alternate base view resolve to its parent
|
|
79
|
+
* entity alongside the matched `EntityAlternateBaseViewInfo`.
|
|
80
|
+
*/
|
|
81
|
+
export declare function FindAlternateBaseViewByPhysicalName(entities: readonly EntityInfo[], viewName: string | undefined | null, schemaName?: string | null): {
|
|
82
|
+
entity: EntityInfo;
|
|
83
|
+
alternateView: EntityAlternateBaseViewInfo;
|
|
84
|
+
} | undefined;
|
|
85
|
+
/**
|
|
86
|
+
* Extracts a pinned `alternateBaseView` semantic name from a loaded User View `BaseEntity`
|
|
87
|
+
* (`DisplayState` JSON column) without introducing a dependency from `@memberjunction/core`
|
|
88
|
+
* to `@memberjunction/core-entities`.
|
|
89
|
+
*
|
|
90
|
+
* Memoizes the parsed result per `(viewEntity, rawDisplayState)` in a `WeakMap` so hot paths
|
|
91
|
+
* (`GetEffectiveAlternateBaseViewName` across cache eligibility, fingerprinting, dedup, and
|
|
92
|
+
* telemetry) do not `JSON.parse(DisplayState)` on every call.
|
|
93
|
+
*
|
|
94
|
+
* Mirrors the `ViewEntity.Get('EntityID')` / `ViewEntity.Get('WhereClause')` access pattern
|
|
95
|
+
* in `RunView.GetEntityNameFromRunViewParams` and `ProviderBase.ResolveRunViewEntitySync`.
|
|
96
|
+
*/
|
|
97
|
+
export declare function GetPinnedAlternateBaseViewFromViewEntity(viewEntity: BaseEntity | undefined | null): string | undefined;
|
|
98
|
+
/**
|
|
99
|
+
* Extracts `alternateBaseView` (or `AlternateBaseView`) from a raw `DisplayState` JSON string
|
|
100
|
+
* or parsed object. Returns `undefined` when absent or blank.
|
|
101
|
+
*/
|
|
102
|
+
export declare function ExtractAlternateBaseViewFromDisplayState(rawDisplayState: unknown): string | undefined;
|
|
103
|
+
/**
|
|
104
|
+
* True when `params.AlternateBaseView` is explicitly set to `""` (or whitespace-only),
|
|
105
|
+
* meaning the caller is explicitly overriding any saved User View `DisplayState.alternateBaseView`
|
|
106
|
+
* pin back to the entity's canonical `BaseView`.
|
|
107
|
+
*/
|
|
108
|
+
export declare function IsExplicitBaseViewOverride(params: RunViewParams | undefined | null): boolean;
|
|
109
|
+
/**
|
|
110
|
+
* Returns the effective semantic `AlternateBaseView` name for a `RunViewParams` object:
|
|
111
|
+
* - An explicit non-empty `params.AlternateBaseView` takes precedence over a saved User View's
|
|
112
|
+
* pinned `DisplayState.alternateBaseView` on `params.ViewEntity`.
|
|
113
|
+
* - An explicit empty `params.AlternateBaseView: ""` overrides a saved User View's pin back to
|
|
114
|
+
* `BaseView` (returns `undefined` without falling back to `params.ViewEntity`).
|
|
115
|
+
* - When `params.AlternateBaseView` is `undefined`, falls back to `params.ViewEntity`'s pinned
|
|
116
|
+
* `DisplayState.alternateBaseView`.
|
|
117
|
+
*/
|
|
118
|
+
export declare function GetEffectiveAlternateBaseViewName(params: RunViewParams | undefined | null, viewEntity?: BaseEntity | undefined | null): string | undefined;
|
|
119
|
+
//# sourceMappingURL=alternateBaseViews.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"alternateBaseViews.d.ts","sourceRoot":"","sources":["../../src/generic/alternateBaseViews.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,2BAA2B,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAEvE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAK7E;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAYrF;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC5C,wEAAwE;IACxE,MAAM,EAAE,UAAU,CAAC;IACnB,gFAAgF;IAChF,qBAAqB,EAAE,MAAM,CAAC;IAC9B,oEAAoE;IACpE,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,iFAAiF;IACjF,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IACxC,wDAAwD;IACxD,IAAI,EAAE,2BAA2B,CAAC;IAClC,yCAAyC;IACzC,MAAM,EAAE,UAAU,CAAC;IACnB,gDAAgD;IAChD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kEAAkE;IAClE,mBAAmB,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,+BAA+B,GAAG,2BAA2B,CAyB9G;AAyED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CAC/C,QAAQ,EAAE,SAAS,UAAU,EAAE,EAC/B,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EACnC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAC3B;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,aAAa,EAAE,2BAA2B,CAAA;CAAE,GAAG,SAAS,CAYhF;AAID;;;;;;;;;;;GAWG;AACH,wBAAgB,wCAAwC,CACpD,UAAU,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI,GAC1C,MAAM,GAAG,SAAS,CAepB;AAED;;;GAGG;AACH,wBAAgB,wCAAwC,CAAC,eAAe,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAoBrG;AAkBD;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,aAAa,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,CAE5F;AAED;;;;;;;;GAQG;AACH,wBAAgB,iCAAiC,CAC7C,MAAM,EAAE,aAAa,GAAG,SAAS,GAAG,IAAI,EACxC,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI,GAC3C,MAAM,GAAG,SAAS,CASpB"}
|
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
import { LogStatusEx } from './logging.js';
|
|
2
|
+
/**
|
|
3
|
+
* Validates that `name` is a safe, unquoted SQL identifier (`1..128` characters, starting
|
|
4
|
+
* with an ASCII letter or underscore and containing only ASCII letters, digits, or underscores).
|
|
5
|
+
*
|
|
6
|
+
* Lives in `@memberjunction/core` so both client/server metadata validation (`ProviderBase`,
|
|
7
|
+
* `MJEntityAlternateBaseViewEntityServer`) and SQL generators can validate `ViewName` and
|
|
8
|
+
* `SchemaName` without introducing a dependency on `@memberjunction/schema-engine`.
|
|
9
|
+
*/
|
|
10
|
+
export function IsValidSQLIdentifier(name) {
|
|
11
|
+
if (typeof name !== 'string') {
|
|
12
|
+
return false;
|
|
13
|
+
}
|
|
14
|
+
return name.length > 0 && name.length <= 128 && /^[A-Za-z_][A-Za-z0-9_]*$/.test(name);
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Validates that `name` is a valid semantic `EntityAlternateBaseView.Name`:
|
|
18
|
+
* non-empty after trimming, at most 100 characters, not starting with `//` (so `abv:` + `Name`
|
|
19
|
+
* can never form `abv://...`), and containing neither `|` nor `:` (the cache-fingerprint segment
|
|
20
|
+
* and prefix delimiters used by `LocalCacheManager` and `GenericDatabaseProvider`). Mirrors
|
|
21
|
+
* `CK_EntityAlternateBaseView_Name` in SQL.
|
|
22
|
+
*/
|
|
23
|
+
export function IsValidAlternateBaseViewName(name) {
|
|
24
|
+
if (typeof name !== 'string') {
|
|
25
|
+
return false;
|
|
26
|
+
}
|
|
27
|
+
const trimmed = name.trim();
|
|
28
|
+
return (trimmed.length > 0 &&
|
|
29
|
+
trimmed.length <= 100 &&
|
|
30
|
+
!trimmed.startsWith('//') &&
|
|
31
|
+
!name.includes('|') &&
|
|
32
|
+
!name.includes(':'));
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Resolves a semantic `AlternateBaseView` name against `entity`, validates that it is
|
|
36
|
+
* registered and usable (`Status` is `'Active'` or `'Deprecated'`, including all ancestors
|
|
37
|
+
* in any `ParentID` chain), emits a warning when deprecated, and enforces entity `CanRead`
|
|
38
|
+
* when `contextUser` is provided.
|
|
39
|
+
*
|
|
40
|
+
* Throws a descriptive `Error` on unknown, disabled, or unauthorized alternate base views
|
|
41
|
+
* (never silently falls back to `entity.BaseView`, preventing filtered-row disclosure).
|
|
42
|
+
*/
|
|
43
|
+
export function ResolveAlternateBaseView(options) {
|
|
44
|
+
const { entity, contextUser, enforcePermissions = true, allowDeprecated = true, suppressDeprecationWarning = false, callerName, } = options;
|
|
45
|
+
const rawName = typeof options.alternateBaseViewName === 'string' ? options.alternateBaseViewName.trim() : '';
|
|
46
|
+
if (!rawName) {
|
|
47
|
+
throw new Error(`AlternateBaseView name cannot be empty on entity '${entity.Name}'.`);
|
|
48
|
+
}
|
|
49
|
+
const view = findRegisteredAlternateBaseViewOrThrow(entity, rawName);
|
|
50
|
+
assertAlternateBaseViewUsableAndIdentifiersValid(entity, view);
|
|
51
|
+
checkAlternateBaseViewDeprecation(entity, view, allowDeprecated, suppressDeprecationWarning, callerName);
|
|
52
|
+
assertAlternateBaseViewReadPermission(entity, contextUser, enforcePermissions);
|
|
53
|
+
return {
|
|
54
|
+
view,
|
|
55
|
+
entity,
|
|
56
|
+
effectiveViewName: view.ViewName,
|
|
57
|
+
effectiveSchemaName: view.EffectiveSchemaName,
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
function findRegisteredAlternateBaseViewOrThrow(entity, rawName) {
|
|
61
|
+
const view = entity.GetAlternateBaseView(rawName);
|
|
62
|
+
if (!view) {
|
|
63
|
+
const available = entity.AlternateBaseViews
|
|
64
|
+
.filter(v => v.IsUsable)
|
|
65
|
+
.map(v => v.Name)
|
|
66
|
+
.join(', ');
|
|
67
|
+
throw new Error(`AlternateBaseView '${rawName}' is not registered on entity '${entity.Name}'. ` +
|
|
68
|
+
`Available alternate base views: ${available || '(none)'}`);
|
|
69
|
+
}
|
|
70
|
+
return view;
|
|
71
|
+
}
|
|
72
|
+
function assertAlternateBaseViewUsableAndIdentifiersValid(entity, view) {
|
|
73
|
+
if (!view.IsUsable) {
|
|
74
|
+
throw new Error(`AlternateBaseView '${view.Name}' on entity '${entity.Name}' is disabled and cannot be used.`);
|
|
75
|
+
}
|
|
76
|
+
if (!IsValidSQLIdentifier(view.ViewName)) {
|
|
77
|
+
throw new Error(`AlternateBaseView '${view.Name}' on entity '${entity.Name}' has an invalid SQL ViewName '${view.ViewName}'.`);
|
|
78
|
+
}
|
|
79
|
+
if (view.EffectiveSchemaName && !IsValidSQLIdentifier(view.EffectiveSchemaName)) {
|
|
80
|
+
throw new Error(`AlternateBaseView '${view.Name}' on entity '${entity.Name}' has an invalid SQL SchemaName '${view.EffectiveSchemaName}'.`);
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
function checkAlternateBaseViewDeprecation(entity, view, allowDeprecated, suppressDeprecationWarning, callerName) {
|
|
84
|
+
if (!view.IsDeprecated) {
|
|
85
|
+
return;
|
|
86
|
+
}
|
|
87
|
+
if (!allowDeprecated) {
|
|
88
|
+
throw new Error(`AlternateBaseView '${view.Name}' on entity '${entity.Name}' is deprecated and cannot be used.`);
|
|
89
|
+
}
|
|
90
|
+
if (!suppressDeprecationWarning) {
|
|
91
|
+
LogStatusEx({
|
|
92
|
+
message: `[Deprecated] AlternateBaseView '${view.Name}' on entity '${entity.Name}' is deprecated${callerName ? ` (called from ${callerName})` : ''}.`,
|
|
93
|
+
verboseOnly: false,
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
function assertAlternateBaseViewReadPermission(entity, contextUser, enforcePermissions) {
|
|
98
|
+
if (enforcePermissions && contextUser && entity.Permissions && entity.Permissions.length > 0) {
|
|
99
|
+
const entityPerms = entity.GetUserPermisions(contextUser);
|
|
100
|
+
if (!entityPerms?.CanRead) {
|
|
101
|
+
throw new Error(`User '${contextUser.Email}' does not have permission to read entity '${entity.Name}'.`);
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Searches across `entities` for an entity that registers a physical SQL view matching
|
|
107
|
+
* `viewName` (and optional `schemaName`) as an `EntityAlternateBaseView`.
|
|
108
|
+
*
|
|
109
|
+
* Used by SQL AST extractors (Query entity extraction, `ClientClauseScreen`, and ad-hoc SQL
|
|
110
|
+
* read authorization) so queries referencing an alternate base view resolve to its parent
|
|
111
|
+
* entity alongside the matched `EntityAlternateBaseViewInfo`.
|
|
112
|
+
*/
|
|
113
|
+
export function FindAlternateBaseViewByPhysicalName(entities, viewName, schemaName) {
|
|
114
|
+
const normalizedView = viewName?.trim();
|
|
115
|
+
if (!normalizedView) {
|
|
116
|
+
return undefined;
|
|
117
|
+
}
|
|
118
|
+
for (const entity of entities) {
|
|
119
|
+
const match = entity.GetAlternateBaseViewByViewName(normalizedView, schemaName);
|
|
120
|
+
if (match) {
|
|
121
|
+
return { entity, alternateView: match };
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
return undefined;
|
|
125
|
+
}
|
|
126
|
+
const _viewEntityPinnedAbvCache = new WeakMap();
|
|
127
|
+
/**
|
|
128
|
+
* Extracts a pinned `alternateBaseView` semantic name from a loaded User View `BaseEntity`
|
|
129
|
+
* (`DisplayState` JSON column) without introducing a dependency from `@memberjunction/core`
|
|
130
|
+
* to `@memberjunction/core-entities`.
|
|
131
|
+
*
|
|
132
|
+
* Memoizes the parsed result per `(viewEntity, rawDisplayState)` in a `WeakMap` so hot paths
|
|
133
|
+
* (`GetEffectiveAlternateBaseViewName` across cache eligibility, fingerprinting, dedup, and
|
|
134
|
+
* telemetry) do not `JSON.parse(DisplayState)` on every call.
|
|
135
|
+
*
|
|
136
|
+
* Mirrors the `ViewEntity.Get('EntityID')` / `ViewEntity.Get('WhereClause')` access pattern
|
|
137
|
+
* in `RunView.GetEntityNameFromRunViewParams` and `ProviderBase.ResolveRunViewEntitySync`.
|
|
138
|
+
*/
|
|
139
|
+
export function GetPinnedAlternateBaseViewFromViewEntity(viewEntity) {
|
|
140
|
+
if (!viewEntity || typeof viewEntity.Get !== 'function') {
|
|
141
|
+
return undefined;
|
|
142
|
+
}
|
|
143
|
+
// Weak-typing accessor on ViewEntity is deliberate in MJCore to avoid circular dependency on core-entities
|
|
144
|
+
const rawDisplayState = viewEntity.Get('DisplayState');
|
|
145
|
+
const cached = _viewEntityPinnedAbvCache.get(viewEntity);
|
|
146
|
+
if (cached && cached.raw === rawDisplayState) {
|
|
147
|
+
return cached.value;
|
|
148
|
+
}
|
|
149
|
+
const value = ExtractAlternateBaseViewFromDisplayState(rawDisplayState);
|
|
150
|
+
if (typeof viewEntity === 'object') {
|
|
151
|
+
_viewEntityPinnedAbvCache.set(viewEntity, { raw: rawDisplayState, value });
|
|
152
|
+
}
|
|
153
|
+
return value;
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* Extracts `alternateBaseView` (or `AlternateBaseView`) from a raw `DisplayState` JSON string
|
|
157
|
+
* or parsed object. Returns `undefined` when absent or blank.
|
|
158
|
+
*/
|
|
159
|
+
export function ExtractAlternateBaseViewFromDisplayState(rawDisplayState) {
|
|
160
|
+
if (!rawDisplayState) {
|
|
161
|
+
return undefined;
|
|
162
|
+
}
|
|
163
|
+
if (typeof rawDisplayState === 'string') {
|
|
164
|
+
const trimmed = rawDisplayState.trim();
|
|
165
|
+
if (!trimmed.startsWith('{')) {
|
|
166
|
+
return undefined;
|
|
167
|
+
}
|
|
168
|
+
try {
|
|
169
|
+
const parsed = JSON.parse(trimmed);
|
|
170
|
+
return extractFromDisplayStateObject(parsed);
|
|
171
|
+
}
|
|
172
|
+
catch {
|
|
173
|
+
return undefined;
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
if (typeof rawDisplayState === 'object') {
|
|
177
|
+
return extractFromDisplayStateObject(rawDisplayState);
|
|
178
|
+
}
|
|
179
|
+
return undefined;
|
|
180
|
+
}
|
|
181
|
+
function extractFromDisplayStateObject(record) {
|
|
182
|
+
if (!record || typeof record !== 'object') {
|
|
183
|
+
return undefined;
|
|
184
|
+
}
|
|
185
|
+
const candidate = typeof record.alternateBaseView === 'string'
|
|
186
|
+
? record.alternateBaseView
|
|
187
|
+
: typeof record.AlternateBaseView === 'string'
|
|
188
|
+
? record.AlternateBaseView
|
|
189
|
+
: undefined;
|
|
190
|
+
if (!candidate) {
|
|
191
|
+
return undefined;
|
|
192
|
+
}
|
|
193
|
+
const trimmed = candidate.trim();
|
|
194
|
+
return trimmed.length > 0 ? trimmed : undefined;
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* True when `params.AlternateBaseView` is explicitly set to `""` (or whitespace-only),
|
|
198
|
+
* meaning the caller is explicitly overriding any saved User View `DisplayState.alternateBaseView`
|
|
199
|
+
* pin back to the entity's canonical `BaseView`.
|
|
200
|
+
*/
|
|
201
|
+
export function IsExplicitBaseViewOverride(params) {
|
|
202
|
+
return typeof params?.AlternateBaseView === 'string' && params.AlternateBaseView.trim().length === 0;
|
|
203
|
+
}
|
|
204
|
+
/**
|
|
205
|
+
* Returns the effective semantic `AlternateBaseView` name for a `RunViewParams` object:
|
|
206
|
+
* - An explicit non-empty `params.AlternateBaseView` takes precedence over a saved User View's
|
|
207
|
+
* pinned `DisplayState.alternateBaseView` on `params.ViewEntity`.
|
|
208
|
+
* - An explicit empty `params.AlternateBaseView: ""` overrides a saved User View's pin back to
|
|
209
|
+
* `BaseView` (returns `undefined` without falling back to `params.ViewEntity`).
|
|
210
|
+
* - When `params.AlternateBaseView` is `undefined`, falls back to `params.ViewEntity`'s pinned
|
|
211
|
+
* `DisplayState.alternateBaseView`.
|
|
212
|
+
*/
|
|
213
|
+
export function GetEffectiveAlternateBaseViewName(params, viewEntity) {
|
|
214
|
+
if (!params && !viewEntity) {
|
|
215
|
+
return undefined;
|
|
216
|
+
}
|
|
217
|
+
if (typeof params?.AlternateBaseView === 'string') {
|
|
218
|
+
const trimmed = params.AlternateBaseView.trim();
|
|
219
|
+
return trimmed.length > 0 ? trimmed : undefined;
|
|
220
|
+
}
|
|
221
|
+
return GetPinnedAlternateBaseViewFromViewEntity(viewEntity ?? params?.ViewEntity);
|
|
222
|
+
}
|
|
223
|
+
//# sourceMappingURL=alternateBaseViews.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"alternateBaseViews.js","sourceRoot":"","sources":["../../src/generic/alternateBaseViews.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAIxC;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAA+B;IAChE,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,IAAI,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1F,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,4BAA4B,CAAC,IAA+B;IACxE,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,OAAO,CACH,OAAO,CAAC,MAAM,GAAG,CAAC;QAClB,OAAO,CAAC,MAAM,IAAI,GAAG;QACrB,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;QACzB,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QACnB,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CACtB,CAAC;AACN,CAAC;AA6CD;;;;;;;;GAQG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAAwC;IAC7E,MAAM,EACF,MAAM,EACN,WAAW,EACX,kBAAkB,GAAG,IAAI,EACzB,eAAe,GAAG,IAAI,EACtB,0BAA0B,GAAG,KAAK,EAClC,UAAU,GACb,GAAG,OAAO,CAAC;IACZ,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC,qBAAqB,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9G,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,qDAAqD,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC;IAC1F,CAAC;IAED,MAAM,IAAI,GAAG,sCAAsC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrE,gDAAgD,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC/D,iCAAiC,CAAC,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,0BAA0B,EAAE,UAAU,CAAC,CAAC;IACzG,qCAAqC,CAAC,MAAM,EAAE,WAAW,EAAE,kBAAkB,CAAC,CAAC;IAE/E,OAAO;QACH,IAAI;QACJ,MAAM;QACN,iBAAiB,EAAE,IAAI,CAAC,QAAQ;QAChC,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;KAChD,CAAC;AACN,CAAC;AAED,SAAS,sCAAsC,CAAC,MAAkB,EAAE,OAAe;IAC/E,MAAM,IAAI,GAAG,MAAM,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAClD,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,MAAM,SAAS,GAAG,MAAM,CAAC,kBAAkB;aACtC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;aACvB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;aAChB,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,MAAM,IAAI,KAAK,CACX,sBAAsB,OAAO,kCAAkC,MAAM,CAAC,IAAI,KAAK;YAC/E,mCAAmC,SAAS,IAAI,QAAQ,EAAE,CAC7D,CAAC;IACN,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,gDAAgD,CAAC,MAAkB,EAAE,IAAiC;IAC3G,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CACX,sBAAsB,IAAI,CAAC,IAAI,gBAAgB,MAAM,CAAC,IAAI,mCAAmC,CAChG,CAAC;IACN,CAAC;IACD,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CACX,sBAAsB,IAAI,CAAC,IAAI,gBAAgB,MAAM,CAAC,IAAI,kCAAkC,IAAI,CAAC,QAAQ,IAAI,CAChH,CAAC;IACN,CAAC;IACD,IAAI,IAAI,CAAC,mBAAmB,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC9E,MAAM,IAAI,KAAK,CACX,sBAAsB,IAAI,CAAC,IAAI,gBAAgB,MAAM,CAAC,IAAI,oCAAoC,IAAI,CAAC,mBAAmB,IAAI,CAC7H,CAAC;IACN,CAAC;AACL,CAAC;AAED,SAAS,iCAAiC,CACtC,MAAkB,EAClB,IAAiC,EACjC,eAAwB,EACxB,0BAAmC,EACnC,UAAmB;IAEnB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;QACrB,OAAO;IACX,CAAC;IACD,IAAI,CAAC,eAAe,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CACX,sBAAsB,IAAI,CAAC,IAAI,gBAAgB,MAAM,CAAC,IAAI,qCAAqC,CAClG,CAAC;IACN,CAAC;IACD,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAC9B,WAAW,CAAC;YACR,OAAO,EAAE,mCAAmC,IAAI,CAAC,IAAI,gBAAgB,MAAM,CAAC,IAAI,kBAAkB,UAAU,CAAC,CAAC,CAAC,iBAAiB,UAAU,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG;YACrJ,WAAW,EAAE,KAAK;SACrB,CAAC,CAAC;IACP,CAAC;AACL,CAAC;AAED,SAAS,qCAAqC,CAC1C,MAAkB,EAClB,WAAiC,EACjC,kBAA2B;IAE3B,IAAI,kBAAkB,IAAI,WAAW,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3F,MAAM,WAAW,GAAG,MAAM,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAC1D,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACX,SAAS,WAAW,CAAC,KAAK,8CAA8C,MAAM,CAAC,IAAI,IAAI,CAC1F,CAAC;QACN,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mCAAmC,CAC/C,QAA+B,EAC/B,QAAmC,EACnC,UAA0B;IAE1B,MAAM,cAAc,GAAG,QAAQ,EAAE,IAAI,EAAE,CAAC;IACxC,IAAI,CAAC,cAAc,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,8BAA8B,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAChF,IAAI,KAAK,EAAE,CAAC;YACR,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;QAC5C,CAAC;IACL,CAAC;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,MAAM,yBAAyB,GAAG,IAAI,OAAO,EAA2D,CAAC;AAEzG;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,wCAAwC,CACpD,UAAyC;IAEzC,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;QACtD,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,2GAA2G;IAC3G,MAAM,eAAe,GAAY,UAAU,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAChE,MAAM,MAAM,GAAG,yBAAyB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzD,IAAI,MAAM,IAAI,MAAM,CAAC,GAAG,KAAK,eAAe,EAAE,CAAC;QAC3C,OAAO,MAAM,CAAC,KAAK,CAAC;IACxB,CAAC;IACD,MAAM,KAAK,GAAG,wCAAwC,CAAC,eAAe,CAAC,CAAC;IACxE,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACjC,yBAAyB,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/E,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wCAAwC,CAAC,eAAwB;IAC7E,IAAI,CAAC,eAAe,EAAE,CAAC;QACnB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;QACtC,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,EAAE,CAAC;QACvC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3B,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAA4B,CAAC;YAC9D,OAAO,6BAA6B,CAAC,MAAM,CAAC,CAAC;QACjD,CAAC;QAAC,MAAM,CAAC;YACL,OAAO,SAAS,CAAC;QACrB,CAAC;IACL,CAAC;IACD,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;QACtC,OAAO,6BAA6B,CAAC,eAA0C,CAAC,CAAC;IACrF,CAAC;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,SAAS,6BAA6B,CAAC,MAAkD;IACrF,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,SAAS,GAAG,OAAO,MAAM,CAAC,iBAAiB,KAAK,QAAQ;QAC1D,CAAC,CAAC,MAAM,CAAC,iBAAiB;QAC1B,CAAC,CAAC,OAAO,MAAM,CAAC,iBAAiB,KAAK,QAAQ;YAC1C,CAAC,CAAC,MAAM,CAAC,iBAAiB;YAC1B,CAAC,CAAC,SAAS,CAAC;IACpB,IAAI,CAAC,SAAS,EAAE,CAAC;QACb,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;IACjC,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AACpD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,MAAwC;IAC/E,OAAO,OAAO,MAAM,EAAE,iBAAiB,KAAK,QAAQ,IAAI,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC;AACzG,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,iCAAiC,CAC7C,MAAwC,EACxC,UAA0C;IAE1C,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,IAAI,OAAO,MAAM,EAAE,iBAAiB,KAAK,QAAQ,EAAE,CAAC;QAChD,MAAM,OAAO,GAAG,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;QAChD,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IACpD,CAAC;IACD,OAAO,wCAAwC,CAAC,UAAU,IAAI,MAAM,EAAE,UAAU,CAAC,CAAC;AACtF,CAAC"}
|