@elyx-code/project-logic-tree 0.0.6848 → 0.0.6851

package/dist/index.d.ts

@@ -705,6 +705,8 @@ export declare const atlassianAuthExternalConnectionBuiltInBaseEntityIntegration
 
 export declare const atlassianAuthExternalConnectionBuiltInBaseEntityIntegrationPropertyRef: IPropertyReference;
 
+export declare const ATTACHING_PERSISTED_ENTITIES_TO_DATABASES_EXPLANATION: string;
+
 export declare const audienceStringListDT: IDataTypeTransfer;
 
 export declare function average(...numsRaw: unknown[]): number;
@@ -12611,7 +12613,10 @@ export declare enum BaseValueDescriptorIds {
      NonInteractiveEntityReferenced = "non-interactive-entity-referenced",
      InvalidParentRelationType = "invalid-parent-relation-type",
      CannotImplementExternalIntegrationConnectionDirectly = "cannot-implement-external-integration-connection-directly",
-     IncompatibleReaderAndWriter = "incompatible-reader-and-writer"
+     IncompatibleReaderAndWriter = "incompatible-reader-and-writer",
+     PersistedEntityWithGivenNameNotFoundWhenEnrichingSQLQueryTableAgainstProjectState = "persisted-entity-with-given-name-not-found-when-enriching-sql-query-table-against-project-state",
+     PropertyWithGivenNameNotFoundWhenEnrichingSQLQueryColumnAgainstProjectState = "property-with-given-name-not-found-when-enriching-sql-query-column-against-project-state",
+     GenericSQLQueryEnrichmentError = "generic-sql-query-enrichment-error"
  }
 
  export declare type EntityId = string;
@@ -15128,6 +15133,20 @@ export declare enum BaseValueDescriptorIds {
 
  export declare function generateActionExample(actionName: string, properties: Record<string, string>): string;
 
+ export declare function generateAllAvailableCalleesExplanation(project: ProjectState, caller: CallerEntityState | null, fromError?: boolean): Promise<{
+     explanations: {
+         id: GenerationExplanationIds.AllAvailableCalleeEntitiesForGivenCaller | GenerationExplanationIds.AllAvailableCallableEntities;
+         message: string;
+     }[];
+ }>;
+
+ export declare function generateAllAvailableCallersExplanation(project: ProjectState, callee: CallableEntityState | null, fromError?: boolean): Promise<{
+     explanations: {
+         id: GenerationExplanationIds.AllAvailableCallerEntitiesForGivenCallee | GenerationExplanationIds.AllAvailableCallerEntities;
+         message: string;
+     }[];
+ }>;
+
  export declare function generateAllAvailableMethodsThatCanBeCalledAsInternalCallsExplanation(project: ProjectState): {
      explanations: {
          id: GenerationExplanationIds.AllAvailableMethodsThatCanBeCalledAsInternalCalls | GenerationExplanationIds.ReasonsForMethodsNotAvailableAsInternalCalls;
@@ -15462,7 +15481,16 @@ export declare enum BaseValueDescriptorIds {
      AllAbstractNonStaticDefinitionEntities = "all-abstract-non-static-definition-entities-explanation",
      AllInstanciatableDefinitionEntities = "all-instantiatable-definition-entities-explanation",
      AutoReplacedExistingValueWriterForNewGiven = "auto-replaced-existing-value-writer-for-new-given-explanation",
-     AutoResolvedCalledByBasedOnValueWriter = "auto-resolved-calledBy-based-on-value-writer-explanation"
+     AutoResolvedCalledByBasedOnValueWriter = "auto-resolved-calledBy-based-on-value-writer-explanation",
+     AllAvailableColumnNamesForSQLEnrichmentInCurrentQuery = "all-available-column-names-for-sql-enrichment-in-current-query-explanation",
+     AllPropertiesThatCouldBeSelectedAsColumnsInSQLQuery = "all-properties-that-could-be-selected-as-columns-in-sql-query-explanation",
+     AllTableNamesForSQLEnrichmentForGivenDatabase = "all-table-names-for-sql-enrichment-for-given-database-explanation",
+     AllTableNamesForSQLEnrichment = "all-table-names-for-sql-enrichment-explanation",
+     SearchStatementHydration = "search-statement-hydration-explanation",
+     PersistedEntities = "persisted-entities-explanation",
+     AttachingPersistedEntitiesToDatabases = "attaching-persisted-entities-to-databases-explanation",
+     FullSQLSelectableBreakdown = "full-sql-selectable-breakdown-explanation",
+     CurrentlyUnattachedPersistedEntities = "currently-unattached-persisted-entities-explanation"
  }
 
  /** lodash-like get(obj, path, defaultValue) with precise "missing" detection */
@@ -15524,12 +15552,26 @@ export declare enum BaseValueDescriptorIds {
 
  export declare function getAllBuiltInEntityIdsAsync(options?: YieldOptions): Promise<Set<EntityId>>;
 
+ export declare function getAllColumnNamesSelectableInQueryExplanation(state: SearchStatementState, project: ProjectState): {
+     explanations: {
+         id: GenerationExplanationIds.AllAvailableColumnNamesForSQLEnrichmentInCurrentQuery;
+         message: string;
+     }[];
+ };
+
  export declare function getAllGloballyDeclaredFunctionDeclarationsExplanation(project: ProjectState): string;
 
  export declare function getAllGlobalValueReadingEntities(project: ProjectState, options?: YieldOptions): Promise<ValueReadingEntityState[]>;
 
  export declare function getAllGlobalValueWritingEntities(project: ProjectState, options?: YieldOptions): Promise<ValueWritingEntityState[]>;
 
+ export declare function getAllTableNamesForGivenDatabaseExplanation(database: DefinitionEntityState): {
+     explanations: {
+         id: GenerationExplanationIds.AllTableNamesForSQLEnrichmentForGivenDatabase | GenerationExplanationIds.PersistedEntities | GenerationExplanationIds.AttachingPersistedEntitiesToDatabases;
+         message: string;
+     }[];
+ };
+
  export declare function getAllValueReadingChildren(entity: CanvasEntityState | InternalCallState): ValueReadingEntityState[];
 
  export declare function getAllValueWriterEntities(project: ProjectState): {
@@ -16387,6 +16429,12 @@ export declare enum BaseValueDescriptorIds {
 
  export declare function getDatabaseEntities(project: ProjectState): DefinitionEntityState[];
 
+ /**
+  * Returns the database entity assigned to the given definition entity
+  *
+  * @param {DefinitionEntityState} entity - The definition entity (assumed to be persisted) for which to retrieve the assigned database entity.
+  * @returns {DefinitionEntityState | null} The database entity assigned to the given definition entity, or null if not found or if the input entity is invalid.
+  */
  export declare function getDatabaseEntity(entity: DefinitionEntityState): DefinitionEntityState | null;
 
  export declare function getDate(input: ISODateString): number;
@@ -18724,6 +18772,13 @@ export declare enum BaseValueDescriptorIds {
 
  declare function getFromClauseFromSelectStatement(selectStatement: SelectStmt): FromClause | null;
 
+ export declare function getFullSQLSelectableBreakdown(project: ProjectState): {
+     explanations: {
+         id: GenerationExplanationIds.FullSQLSelectableBreakdown | GenerationExplanationIds.PersistedEntities | GenerationExplanationIds.AttachingPersistedEntitiesToDatabases;
+         message: string;
+     }[];
+ };
+
  export declare function getGenerationTargetSchemaBasedOnType(entity: {
      type: EntityType;
      [key: string]: any;
@@ -19576,6 +19631,9 @@ export declare enum BaseValueDescriptorIds {
    */
   export declare function getTouchedCanvasEntitiesFromChangeSet(changeSet: ChangeSet, options?: {
       shallowMissingActivesError?: boolean;
+      excludeAffected?: boolean;
+      excludeAdded?: boolean;
+      excludeUpdated?: boolean;
   }): CanvasEntityState[];
 
   export declare const getTzOffsetAtArg: IValueDescriptorTransfer;
@@ -30036,6 +30094,8 @@ export declare enum BaseValueDescriptorIds {
 
   export declare type PersistChangeSetEntityActionRequestPayload = IEntityActionRequestPayload<PersistChangeSetEntityActionPayload>;
 
+  export declare const PERSISTED_ENTITIES_EXPLANATION: string;
+
   export declare const persistedBuiltInBaseEntity: IBuiltInBaseEntityTransfer;
 
   export declare const persistedBuiltInBaseEntityBaseColumnProperty: IPropertyTransfer;
@@ -31589,6 +31649,8 @@ export declare enum BaseValueDescriptorIds {
       SameBothGlobal = "same-both-global"
   }
 
+  export declare const SEARCH_STATEMENT_HYDRATION_EXPLANATION = "The 'query' field of 'search' entities gets stored naivly as pure text, but when we interact with it, it gets just-in-time hydration against the existing project state to become a fully typed SQL AST.\nThis means that you can write any raw SQL query in the 'query' field, and the project checks that any column and table references are actually found in the project.\nSpecifically the names of the 'properties' of any 'definition-entity' that implements the \"persisted\" 'built-in-base-entity' are matched against any columns and tables, respectively, found in the query.\nDefinition entity names are turned into table names by converting them to pascal case. For example \"My new Entity\" turns into \"MyNewEntity\".\nProperty names are turned into column names by converting them to camel case. For example \"My new property\" turns into \"myNewProperty\".\nIf any of the referenced tables or columns aren't found in the project, an error is shown and the referenced is SAFELY removed from the query.\nSame occurs with interpolated values.\nOnly 'input-map' values belonging to the same parent 'search' entity can be used inside the query. Like so: {{::inputMapId}}.\nIf any of the referenced input-maps aren't found in the parent 'search' entity, they will be ignored and SAFELY removed from the query, no errors are shown.\nA query (and therefore a 'search' entity) can only reference tables in a single database, if two 'definition-entities' that implement the \"persisted\" 'built-in-base-entity' belong to two different parent databases, the table selected first will determine what database is being queried, and the other table won't be available for this query.\nIf any of the referenced entities changes, the project will auto-update the query to reflect the changes.";
+
   export declare enum SearchDependencyField {
       Parent = "search-parent-field",
       DataTypeEntity = "search-data-type-entity-field",