@elyx-code/project-logic-tree 0.0.6815 → 0.0.6817

package/dist/index.d.ts

@@ -339,7 +339,7 @@ declare enum AggregationStatementType {
     Natural = "natural"
 }
 
-export declare const AI_VALUE_CONNECTION_GENERATION_ACTION_EXPLANATION = "To establish a connection of a reader and writter value during the generation process you can use the 'connect_values' generation action, like so:\n```json\n{\n\t\"connect_values\": {\n\t\t\"writerEntityId\": \"writer-entity-id\"; // Id of the entity that will give the value\n    \"readerEntityId\": \"reader-entity-id\"; // Id of the entity that will receive the value\n\t}\n}\n```\nYou can use the 'disconnect_values' generation action to remove the connection between two value holding entities in the same way.";
+export declare const AI_VALUE_CONNECTION_GENERATION_ACTION_EXPLANATION = "To establish a connection of a reader and writer value during the generation process you can use the 'connect_values' generation action, like so:\n```json\n{\n\t\"connect_values\": {\n\t\t\"writerEntityId\": \"writer-entity-id\"; // Id of the entity that will give the value\n    \"readerEntityId\": \"reader-entity-id\"; // Id of the entity that will receive the value\n\t}\n}\n```\nYou can use the 'disconnect_values' generation action to remove the connection between two value holding entities in the same way.";
 
 export declare const airtableAuthExternalConnectionBuiltInBaseEntity: IBuiltInBaseEntityTransfer;
 
@@ -412,6 +412,21 @@ export declare type AnyEncoding = UtfEncoding | BinEncoding;
 
 export declare function appendToList(list: unknown, value: unknown, ...values: unknown[]): any[];
 
+/**
+ * Based what ultimately was connected ('sourceEntity', 'targetEntity' and 'connectionType'),
+ * and the initial compatibility result, we might need to apply some auto-fixes to make sure the connection is valid.
+ *
+ * @param {UserManagedEntityState} sourceEntity The entity from which the connection starts
+ * @param {UserManagedEntityState} targetEntity The entity to which the connection goes
+ * @param {ConnectionNodeType} connectionType The type of the connection that was made
+ * @param {ChangeSet} changeSet The changeset to which any potential change should be added
+ * @param {IConnectionCompatibilityResult} compatibilityResult The initial compatibility result before the connection was made, this will be used to determine if any auto-fix is needed, and which one
+ */
+export declare function applyConnectionCompatibilityAutoFixes(sourceEntity: UserManagedEntityState, targetEntity: UserManagedEntityState, connectionType: ConnectionNodeType, changeSet: ChangeSet, compatibilityResult: IConnectionCompatibilityResult, options?: {
+    onConnection?: (sourceEntity: UserManagedEntityState, targetEntity: UserManagedEntityState, connectionType: ConnectionNodeType) => Promise<void>;
+    onCallRemoved?: (caller: CallerEntityState, callee: CallableEntityState, callType: 'success' | 'error' | 'entry' | 'loop-body') => Promise<void>;
+}): Promise<void>;
+
 export declare function applyNewScope(self: CallableEntityState, changeSet: ChangeSet | null): void;
 
 export declare function applyQueuedToCached(opts: {
@@ -438,11 +453,11 @@ export declare class Area {
     calculationEntryPoint: Area;
     _onlyEntities: CanvasEntityState[] | null;
     private _changeSet;
-    constructor(entity: CanvasEntityState | ProjectState, index: number, calculationEntryPoint?: Area | null, changeSet?: ChangeSet);
+    constructor(entity: CanvasEntityState | ProjectState, index: number, calculationEntryPoint?: Area | null, changeSet?: ChangeSet | null);
     static autoGenerateLayout(entryPointEntity: CanvasEntityState | ProjectState, changeSet: ChangeSet | null, onlyEntities?: CanvasEntityState[]): CanvasEntityState[];
     static recursivelyAssembleChildrenAreas(renderedParents: Area[]): void;
-    get onlyEntities(): CanvasEntityState[] | null;
-    get changeSet(): ChangeSet | null;
+    get onlyEntities(): CanvasEntityState[];
+    get changeSet(): ChangeSet;
     set changeSet(changeSet: ChangeSet | null);
     findAreaInChildrenFromEntity(entity: CanvasEntityState): Area | null;
     findAreaFromEntity(entity: CanvasEntityState): Area | null;
@@ -939,7 +954,7 @@ export declare enum BaseValueDescriptorIds {
      getDefaultValue(): LiteralValueState | null;
      setDefaultValue(value: LiteralValueState | null, changeSet?: ChangeSet | null): BreakStatementState;
      clone(changeSet?: ChangeSet | null, parent?: LoopState | null, newId?: string | null, subscribe?: boolean): BreakStatementState;
-     getMasterInputWithValueWritterFromAllInstances(input: TerminationInputMapState): TerminationInputMapState;
+     getMasterInputWithValueWriterFromAllInstances(input: TerminationInputMapState): TerminationInputMapState;
      syncInputs(changeSet?: ChangeSet | null): IChangeSet<BreakStatementState>;
      setDataType(dataType: DataTypeState | null, changeSet?: ChangeSet | null): BreakStatementState;
      removeDataType(changeSet?: ChangeSet | null): BreakStatementState;
@@ -9439,6 +9454,15 @@ export declare enum BaseValueDescriptorIds {
 
  export declare function calculateNewParentBasedOnCallers(self: CallableEntityState): EntityWithLogicScopeState | ProjectState;
 
+ /**
+  * Calculates how far down the top of the parent definition entity a method starts
+  * Methods are function-declaration entities nested inside definition-entities
+  * But their distance to the top changes based on their index among all other rendered methods as well as all properties the parent has.
+  */
+ export declare function calculateVerticalOffsetForMethod(method: FunctionDeclarationState): {
+     offset: number;
+ };
+
  export declare const CALLABLE_ENTITIES_EXPLANATION: string;
 
  export declare const CALLABLE_TYPES: EntityType[];
@@ -9533,6 +9557,7 @@ export declare enum BaseValueDescriptorIds {
      CallerIsInLowerScope = "caller-is-in-lower-scope",
      CallIsInHigherScope = "call-is-in-higher-scope",
      CallIsInLowerScope = "call-is-in-lower-scope",
+     CalledBySourceMustBeCallerEntity = "called-by-source-must-be-caller-entity",
      OtherIncompatibleScopeReason = "other-incompatible-scope-reason",
      SiblingInternalCallAlreadyUsedInParentVariable = "sibling-internal-call-already-used-in-parent-variable",
      ErrorOututMapCannotBeConnectedToParentSuccessBranchCallees = "error-output-map-cannot-be-connected-to-parent-success-branch-callees",
@@ -9545,7 +9570,8 @@ export declare enum BaseValueDescriptorIds {
      CannotConnectToOwnNode = "cannot-connect-to-own-node",
      VariableDeclarationCannotBeMovedToLowerScopeBecauseInstancesUsage = "variable-declaration-cannot-be-moved-to-lower-scope-because-instances-usage",
      CannotChangeScopeBecauseItIsCalledByOtherEntities = "cannot-change-scope-because-it-is-called-by-other-entities",
-     CannotChangeScopeBecauseItCallsOtherEntities = "cannot-change-scope-because-it-calls-other-entities"
+     CannotChangeScopeBecauseItCallsOtherEntities = "cannot-change-scope-because-it-calls-other-entities",
+     CalledByErrorMustBePassThroughCallable = "called-by-error-must-be-pass-through-callable"
  }
 
  export declare type CanvasEntityDisabledReason = CanvasEntityConnectionDisabledReason | CanvasEntityTestingDisabledReason | CanvasEntityOtherDisabledReason | StateMutationErrorCode;
@@ -9677,7 +9703,7 @@ export declare enum BaseValueDescriptorIds {
  /**
   * Checks whether two data-type entities are compatible.
   * Order matters. In places where one data-type is constrained and the other is not,
-  * the first data-type (dataTypeA) is considered the value writter (source).
+  * the first data-type (dataTypeA) is considered the value writer (source).
   * while the second data-type (dataTypeB) is considered the value reader (target).
   *
   * @param dataTypeA
@@ -10235,7 +10261,8 @@ export declare enum BaseValueDescriptorIds {
      EntryPointCaller = "entry-point-caller",
      SuccessCaller = "success-caller",
      ErrorCaller = "error-caller",
-     CalledBy = "called-by"
+     CalledBy = "called-by",
+     CalledByError = "called-by-error"
  }
 
  /** Constant-time equality for two byte arrays (equal length required). */
@@ -10386,7 +10413,7 @@ export declare enum BaseValueDescriptorIds {
      getDefaultValue(): LiteralValueState | null;
      setDefaultValue(value: LiteralValueState | null, changeSet?: ChangeSet | null): ContinueStatementState;
      clone(changeSet?: ChangeSet | null, parent?: LoopState | null, newId?: string | null, subscribe?: boolean): ContinueStatementState;
-     getMasterInputWithValueWritterFromAllInstances(input: TerminationInputMapState): TerminationInputMapState;
+     getMasterInputWithValueWriterFromAllInstances(input: TerminationInputMapState): TerminationInputMapState;
      syncInputs(changeSet?: ChangeSet | null): IChangeSet<ContinueStatementState>;
      setDataType(dataType: DataTypeState | null, changeSet?: ChangeSet | null): ContinueStatementState;
      removeDataType(changeSet?: ChangeSet | null): ContinueStatementState;
@@ -12513,7 +12540,7 @@ export declare enum BaseValueDescriptorIds {
      InvalidUUIDStringFormat = "invalid-uuid-string-format",
      ReferencedEntityNotFound = "referenced-entity-not-found",
      ReferencedValueReaderEntityNotFound = "referenced--value-reader-entity-not-found",
-     InvalidValueWritterReference = "invalid-value-writter-reference",
+     InvalidValueWriterReference = "invalid-value-writer-reference",
      EntityIdNotUnique = "entity-id-not-unique",
      BuiltInEntityGenerated = "built-in-entity-generated",
      BuiltInEntityUpdated = "built-in-entity-updated",
@@ -15303,7 +15330,7 @@ export declare enum BaseValueDescriptorIds {
      NonInteractiveBaseEntities = "non-interactive-base-entities-explanation",
      ValueReadingEntities = "value-reading-entities-explanation",
      ValueWritingEntities = "value-writing-entities-explanation",
-     PropertyNotValueReaderWritter = "property-not-value-reader-writter-explanation",
+     PropertyNotValueReaderWriter = "property-not-value-reader-writer-explanation",
      EntitiesWithValues = "entities-with-values-explanation",
      AIValueConnectionGenerationAction = "ai-value-connection-generation-action-explanation",
      ParentAutoCalculationFromCaller = "parent-auto-calculation-from-caller-explanation",
@@ -15313,9 +15340,16 @@ export declare enum BaseValueDescriptorIds {
      PropertyParentFieldOptions = "property-parent-field-options-explanation",
      MethodParentFieldOptions = "method-parent-field-options-explanation",
      AllAvailableValueReaderEntities = "all-available-value-reader-entities-explanation",
-     AllAvailableValueWritterEntities = "all-available-value-writter-entities-explanation",
-     AvailableValueReadersForGivenWritter = "available-value-readers-for-given-writter-explanation",
-     AvailableValueWrittersForGivenReader = "available-value-writters-for-given-reader-explanation",
+     AllAvailableValueWriterEntities = "all-available-value-writer-entities-explanation",
+     AvailableValueReadersForGivenWriter = "available-value-readers-for-given-writer-explanation",
+     AvailableValueWritersForGivenReader = "available-value-writers-for-given-reader-explanation",
+     AllAvailableCallableEntities = "all-available-callable-entities-explanation",
+     AllAvailableEntryPointEntities = "all-available-entry-point-entities-explanation",
+     AllAvailablePassThroughCallableEntities = "all-available-pass-through-callable-entities-explanation",
+     AllAvailableCallerEntities = "all-available-caller-entities-explanation",
+     AllAvailableTerminationEntities = "all-available-termination-entities-explanation",
+     AllAvailableCallerEntitiesForGivenCallee = "all-available-caller-entities-for-given-callee-explanation",
+     AllAvailableCalleeEntitiesForGivenCaller = "all-available-callee-entities-for-given-caller-explanation",
      AllAvailableGlobalFunctionDeclarationsForFunctionCall = "all-available-global-function-declarations-for-function-call-explanation",
      AllNoneInteractiveBaseEntities = "all-non-interactive-base-entities-explanation",
      AllOperationActionDescriptors = "all-operation-action-descriptors-explanation",
@@ -15400,6 +15434,10 @@ export declare enum BaseValueDescriptorIds {
 
  export declare function getAllValueWritingChildren(entity: CanvasEntityState | InternalCallState): ValueWritingEntityState[];
 
+ export declare function getAllValueWritingEntities(project: ProjectState, options?: YieldOptions): Promise<ValueWritingEntityState[]>;
+
+ export declare function getAllValueWrittingChildren(entity: CanvasEntityState | InternalCallState): ValueWritingEntityState[];
+
  export declare function getAllVariablesInScope(project: ProjectState, variableDeclarations: VariableDeclarationState[], targetEntity?: UserManagedEntityState): VariableDeclarationState[];
 
  export declare function getBaseBuiltInEntities(entity: DefinitionEntityState | BuiltInBaseEntityState): BuiltInBaseEntityState[];
@@ -18590,26 +18628,18 @@ export declare enum BaseValueDescriptorIds {
 
  export declare function getImplementedBuiltInEntity(entity: DefinitionEntityState): BuiltInBaseEntityState | null;
 
+ /**
+  * Returns a list of all entities that the current entity can connect to and not connect to
+  *
+  * @param {ArgumentDeclarationState | InputMapState | OutputMapState | LoopState | CallerEntityState | VariableState | ValueDescriptorState | ExecutableEntityState} entity The entity for which we want to find compatible and incompatible connections
+  * @param {ConnectionNodeType} connectionType The type of connection we want to create
+  * @param {YieldOptions & { allowReadWriteToFixableScope?: boolean }} options Additional options for the function, including yield options and whether to allow connections to entities that could become compatible if the scope is changed
+  *
+  * @returns {Promise<IConnectionCompatibilityResult>} An object containing two lists: one for compatible entities and one for incompatible entities, each with the reasons for their compatibility or incompatibility
+  */
  export declare function getIncompatibleConnectionEntitiesAsync(entity: ArgumentDeclarationState | InputMapState | OutputMapState | LoopState | CallerEntityState | VariableState | ValueDescriptorState | ExecutableEntityState, connectionType: ConnectionNodeType, options?: YieldOptions & {
      allowReadWriteToFixableScope?: boolean;
- }): Promise<{
-     compatible: {
-         [id: string]: {
-             requiresCallConnectionTo: CallableEntityState | null;
-             requiresCallConnectionToFrom: CallerEntityState | null;
-             entity: EntityState;
-         };
-     };
-     incompatible: {
-         [id: string]: {
-             entity: EntityState;
-             reasons: CanvasEntityConnectionDisabledReason[];
-             fixable: boolean;
-             requiresCallConnectionTo: CallableEntityState | null;
-             requiresCallConnectionToFrom: CallerEntityState | null;
-         };
-     };
- }>;
+ }): Promise<IConnectionCompatibilityResult>;
 
  export declare function getIndexItem(list: unknown, index: unknown): any;
 
@@ -21258,6 +21288,12 @@ export declare enum BaseValueDescriptorIds {
       type: ScopeCompatibilityType.BInA;
   }
 
+  export declare interface ICompatibleConnectionOption {
+      requiresCallConnectionTo: CallableEntityState | null;
+      requiresCallConnectionToFrom: CallerEntityState | null;
+      entity: UserManagedEntityState;
+  }
+
   export declare interface ICompatibleSameBothGlobalScope extends IScopeCompatibility {
       compatible: true;
       type: ScopeCompatibilityType.SameBothGlobal;
@@ -21330,6 +21366,23 @@ export declare enum BaseValueDescriptorIds {
       parent: EntityWithLogicScope | EntityWithLogicScopeReference | IProject | IProjectReference | ICondition | IConditionReference;
   }
 
+  export declare interface IConnectionCompatibilityResult {
+      compatible: IConnectionCompatibleOptions;
+      incompatible: IConnectionIncompatibleOptions;
+  }
+
+  export declare interface IConnectionCompatibleOptions {
+      [id: EntityId]: {
+          requiresCallConnectionTo: CallableEntityState | null;
+          requiresCallConnectionToFrom: CallerEntityState | null;
+          entity: UserManagedEntityState;
+      };
+  }
+
+  export declare interface IConnectionIncompatibleOptions {
+      [id: EntityId]: IIncompatibleConnectionOption;
+  }
+
   export declare interface IContinueStatement extends ITerminationStatement, IContinueStatement_meta {
       type: EntityType.ContinueStatement;
       parent: ILoop;
@@ -21879,6 +21932,15 @@ export declare enum BaseValueDescriptorIds {
       type: ScopeCompatibilityType.BIsGlobalAIsNot;
   }
 
+  export declare interface IIncompatibleConnectionOption {
+      entity: UserManagedEntityState;
+      reasons: CanvasEntityConnectionDisabledReason[];
+      fixable: boolean;
+      requiresCallConnectionTo: CallableEntityState | null;
+      requiresCallConnectionToFrom: CallerEntityState | null;
+      nonAutofixableReasons: (CanvasEntityConnectionDisabledReason.VariableDeclarationCannotBeMovedToLowerScopeBecauseInstancesUsage | CanvasEntityConnectionDisabledReason.CannotChangeScopeBecauseItCallsOtherEntities | CanvasEntityConnectionDisabledReason.CannotChangeScopeBecauseItIsCalledByOtherEntities)[];
+  }
+
   export declare interface IIncompatibleParallelInCommonParentScope extends IScopeCompatibility {
       compatible: false;
       type: ScopeCompatibilityType.ParallelInCommonParent;
@@ -25479,6 +25541,18 @@ export declare enum BaseValueDescriptorIds {
 
   export declare function modifyEditableAndDeletableDownstreamEntitiesFromGiven(entity: UserManagedEntityState, changeSet: ChangeSet, newValue: boolean, seenEntities?: Set<string>): void;
 
+  export declare function moveParallelCalls(entity: PassThroughCallableEntityState, changeSet: ChangeSet, options?: {
+      onlyTypes?: EntityType[];
+      onConnection?: (sourceEntity: UserManagedEntityState, targetEntity: UserManagedEntityState, connectionType: ConnectionNodeType) => Promise<void>;
+      onCallRemoved?: (caller: CallerEntityState, callee: CallableEntityState, callType: 'success' | 'error' | 'entry' | 'loop-body') => Promise<void>;
+  }): {
+      errors: EntityError[];
+      explanations: {
+          id: GenerationExplanationIds;
+          message: string;
+      }[];
+  };
+
   export declare const MUTABLE_META_PROPERTIES_EXPLANATION = "Some meta-data properties of entities can be changed after the initial creation, like 'name', 'description', etc...\nThese are called mutable meta-properties.";
 
   export declare const NESTED_PROPERTY_HEIGHT = 26;
@@ -30392,7 +30466,7 @@ export declare enum BaseValueDescriptorIds {
 
   export declare const PROPERTY_IMPLEMENTATION_AND_EXTENSION_AUTO_ENRICHMENT_EXPLANATION = "When a 'property' entity is added to a 'definition-entity', the system will automatically enrich the property based on the parent definition-entity's implemented and extended entities.\nThis means that if a property is required, the parent 'definition-entity' will have auto-generated it. If a manually added property can fit into a parent, it will be auto-enriched with any required 'implementation' or 'extension' references, and the data-type will be recalculated or constrained based on said extensions and implementations.\nThis means that manually adding an 'extends' field to a new property is not necessary, and only specific, non-required 'implements' references need to be added manually if needed.";
 
-  export declare const PROPERTY_NOT_VALUE_READER_WRITTER_EXPLANATION = "A property entity, is neither a value reading, or a value writting entity, but they are often confused with one.\nA 'property' can have a default value through its nested 'data-type' entity.\nThe 'property' entity only represents the data field in the declaration, and it can't write or read values.\nWhen a 'definition-entity' is instantiated as a variable, any writes or reads to its properties are done through 'input-map's and 'output-map's.";
+  export declare const PROPERTY_NOT_VALUE_READER_WRITER_EXPLANATION = "A property entity, is neither a value reading, or a value writting entity, but they are often confused with one.\nA 'property' can have a default value through its nested 'data-type' entity.\nThe 'property' entity only represents the data field in the declaration, and it can't write or read values.\nWhen a 'definition-entity' is instantiated as a variable, any writes or reads to its properties are done through 'input-map's and 'output-map's.";
 
   export declare enum PropertyDependencyField {
       PropertyImplements = "property-implements-field",
@@ -30835,7 +30909,7 @@ export declare enum BaseValueDescriptorIds {
 
   export declare function readObjectNestedKey(obj: unknown, path: unknown, defaultValue?: unknown): unknown;
 
-  export declare function readValueFromWritter(entity: ValueReadingEntityState, context: IValueResolutionContext, onlyDefault?: boolean): IDynamicValue | null;
+  export declare function readValueFromWriter(entity: ValueReadingEntityState, context: IValueResolutionContext, onlyDefault?: boolean): IDynamicValue | null;
 
   export declare function rebaseStack<T = any>(undoableStackValueIndex: number, history: T[], newItem: T): number;
 
@@ -30924,7 +30998,9 @@ export declare enum BaseValueDescriptorIds {
       reasons: CanvasEntityDisabledReason[];
   };
 
-  export declare function removeRedundantCallers(entity: CallableEntityState, changeSet: ChangeSet | null): ChangeSet | null;
+  export declare function removeRedundantCallers(entity: CallableEntityState, changeSet: ChangeSet | null, options?: {
+      onCallRemoved?: (caller: CallerEntityState, callee: CallableEntityState, callType: 'success' | 'error' | 'entry' | 'loop-body') => Promise<void>;
+  }): Promise<ChangeSet | null>;
 
   export declare function repeatList(list: unknown, count: unknown): any[];
 
@@ -34199,7 +34275,7 @@ export declare enum BaseValueDescriptorIds {
       modifiedData: Partial<IValueReadingEntityGenerationTarget>;
   };
 
-  export declare function validateValueWritter(data: ElementGenerationTarget, valueWritterEntity: ValueWritingEntityState): EntityGenerationError[];
+  export declare function validateValueWriter(data: ElementGenerationTarget, valueWriterEntity: ValueWritingEntityState): EntityGenerationError[];
 
   export declare function validateVariableDeclarationName(entity: VariableDeclarationState | IVariableDeclarationGenerationTarget | IVariableDeclarationShallowTransfer | IVariableDeclarationTransfer, project: ProjectState): EntityGenerationError[];
 
@@ -34984,7 +35060,7 @@ export declare enum BaseValueDescriptorIds {
       removeValueWriter(changeSet?: ChangeSet | null): VariableDeclarationState;
       subscribe(): VariableDeclarationState;
       unsubscribe(): VariableDeclarationState;
-      getMasterInputWithValueWritterFromAllInstances(input: VariableInputMapState): VariableInputMapState;
+      getMasterInputWithValueWriterFromAllInstances(input: VariableInputMapState): VariableInputMapState;
       inferDataTypeAndSyncInstancesInputsAndOutputs(changeSet?: ChangeSet | null): IChangeSet<VariableDeclarationState>;
       metaSync(changedData: Partial<IVariableDeclaration_meta | IVariableDeclaration | IVariableDeclarationTransfer | IVariableDeclarationShallowTransfer>, changeSet?: ChangeSet | null): VariableDeclarationState;
       APILoad(_?: IEntityPersistanceOptions, ...otherArgs: any[]): Promise<VariableDeclarationState>;