@elyx-code/project-logic-tree 0.0.6479 → 0.0.6481

package/dist/index.d.ts

@@ -4280,6 +4280,13 @@ export declare function flattenVariableWrites(variable: VariableState, seenVaria
 
 export declare function flattenWrites(entity: ValueWritingEntityState, seenEntities?: Set<string>): ValueReadingEntityState[];
 
+/**
+ * Holds keywords that are forbidden (so far in Javascript) to be used as names for entities.
+ * This is used to validate the names of entities, such as functions, variables, etc.
+ * For example, a property named "class", or "function" is forbidden, because those are reserved keywords in Javascript.
+ */
+export declare const FORBIDDEN_KEYWORDS: string[];
+
 declare const FORBIDDEN_SQL_KEYWORDS: string[];
 
 export declare function fromChangeSetToRecordChangeSet<TSelf extends {
@@ -14216,7 +14223,8 @@ export declare type PropertyTypesUnion = IProperty | IPropertyTransfer | IProper
 declare namespace propertyValidation {
     export {
         validate_4 as validate,
-        validateImplementation
+        validateImplementation,
+        validatePropertyEntityName
     }
 }
 export { propertyValidation }
@@ -15328,6 +15336,7 @@ export declare enum SharedEntityErrorCode {
     NameAsResolvedCodeNameNotUniqueInScope = "name-as-resolved-code-name-not-unique-in-scope",
     NameMustStartWithLetterOrUnderscore = "name-must-start-with-letter-or-underscore",
     NameCanOnlyContainLettersNumbersUnderscoreAndSpaces = "name-can-only-contain-letters-numbers-underscore-and-spaces",
+    NameIsForbiddenKeyword = "name-is-forbidden-keyword",
     EmptyName = "empty-name",
     MissingCaller = "missing-caller",
     PropertyOverwritesOtherSiblingWithSameName = "property-overwrites-other-sibling-with-same-name",
@@ -15585,20 +15594,54 @@ export declare type TerminationState = ReturnStatementState | BreakStatementStat
 
 export declare type TestableEntityState = ExecutableEntityState;
 
+/**
+ * First letter of each word is lowercase and the rest of the words, start in uppercase
+ * someName
+ *
+ * @param str - The string to convert to camelCase
+ * @returns The camelCase version of the string
+ */
 export declare function toCamelCase(str: string): string;
 
 export declare function toEditorContext(extensionsRegistry: ExtensionsRegistry, editor: IEditor): DefaultEditorContext;
 
 export declare function toEntityState(entity: string | EntityState | IGenericReference | Element_2 | ElementTransfer | ElementShallowTransfer | ElementGenerationTarget, project: ProjectState): EntityState | null;
 
+/**
+ * Words keep their original capitalization; we just insert dashes
+ * some-name or SOME-NAME or Some-Name or sOme-NaMe
+ *
+ * @param str - The string to convert to kebab-case
+ * @returns The kebab-case version of the string
+ */
 export declare function toKebabCase(str: string): string;
 
+/**
+ * Convert a string to kebab-case and then to lower case.
+ *
+ * @param str - The string to convert to lower case kebab-case
+ * @returns The lower case kebab-case version of the string
+ */
 export declare function toLowerCaseKebabCase(str: string): string;
 
+/**
+ * First letter is uppercase; the rest of each word is left intact
+ * SomeName or BlogContent or BlogCONTENT
+ *
+ * @param str - The string to convert to PascalCase
+ * @returns The PascalCase version of the string
+ */
 export declare function toPascalCase(str: string): string;
 
 export declare function toProjectLogicContext(extensionsRegistry: ExtensionsRegistry, project: ProjectState): DefaultProjectLogicContext;
 
+/**
+ * Words keep their original capitalization; we just insert underscores
+ * some_name or SOME_NAME or Some_Name or sOme_NaMe
+ *
+ * @param str - The string to convert to snake_case
+ * @returns The snake_case version of the string
+ */
 export declare function toSnakeCase(str: string): string;
 
 export declare function transitionProjectVersion(from: ChangeSet | 'initial', to: ChangeSet | 'initial', project: ProjectState): IProjectVersionTransitionConfig;
@@ -15849,7 +15892,9 @@ export declare const validateDataOperationOutputEntityDeclarationParentRef: IAct
 
 export declare function validateDefinitionEntityName(entity: DefinitionEntityState | IDefinitionEntityGenerationTarget | IDefinitionEntityShallowTransfer | IDefinitionEntityTransfer, project: ProjectState): EntityGenerationError[];
 
-declare function validateDefinitionEntityName_2(self: DefinitionEntityState): EntityError[];
+declare function validateDefinitionEntityName_2(self: DefinitionEntityState, newName?: string): EntityError[];
+
+export declare function validateEntityName(self: EntityWithNamesState, toCodeNameTransformers?: ((name: string) => string)[], otherRelevantEntitiesInNameSpace?: EntityWithNamesState[], newName?: string | null): EntityError[];
 
 export declare function validateEntryCaller(data: ElementGenerationTarget, callerEntity: CallerEntityState): EntityGenerationError[];
 
@@ -15861,7 +15906,7 @@ export declare function validateFunctionCallDeclaration(functionDeclarationId: E
 
 export declare function validateFunctionDeclarationName(entity: FunctionDeclarationState | IFunctionDeclarationGenerationTarget | IFunctionDeclarationShallowTransfer | IFunctionDeclarationTransfer, project: ProjectState): EntityGenerationError[];
 
-declare function validateFunctionDeclarationName_2(self: FunctionDeclarationState): EntityError[];
+declare function validateFunctionDeclarationName_2(self: FunctionDeclarationState, newName?: string): EntityError[];
 
 export declare function validateGeneratedEntityParentIsNotBuiltInEntity(data: ElementGenerationTarget, project: ProjectState): EntityGenerationError[];
 
@@ -15892,6 +15937,8 @@ export declare function validateOperationEntityDeclaration(operationDeclarationI
 
 declare function validateParentRelation(self: InternalCallState): EntityError[];
 
+declare function validatePropertyEntityName(self: PropertyState, newName?: string): EntityError[];
+
 export declare function validatePropertyName(entity: PropertyState | IPropertyGenerationTarget | IPropertyShallowTransfer | IPropertyTransfer, project: ProjectState): EntityGenerationError[];
 
 export declare function validateReachability(self: PassThroughCallableEntityState): EntityError[];
@@ -15933,7 +15980,7 @@ export declare function validateValueWritter(data: ElementGenerationTarget, valu
 
 export declare function validateVariableDeclarationName(entity: VariableDeclarationState | IVariableDeclarationGenerationTarget | IVariableDeclarationShallowTransfer | IVariableDeclarationTransfer, project: ProjectState): EntityGenerationError[];
 
-declare function validateVariableDeclarationName_2(self: VariableDeclarationState): EntityError[];
+declare function validateVariableDeclarationName_2(self: VariableDeclarationState, newName?: string): EntityError[];
 
 export declare function validateVariableInternalCallUse(self: VariableState): EntityError[];