@sap-ux/fiori-annotation-api 0.1.0

package/dist/cds/writer.d.ts

@@ -0,0 +1,104 @@
+import type { TextDocument } from 'vscode-languageserver-textdocument';
+import type { AnnotationFile } from '@sap-ux/odata-annotation-core';
+import { TextEdit } from '@sap-ux/odata-annotation-core';
+import type { VocabularyService } from '@sap-ux/odata-vocabularies';
+import { type CdsCompilerFacade } from '@sap/ux-cds-compiler-facade';
+import type { Comment } from './comments';
+import type { AstNode, CDSDocument } from './document';
+import type { CDSDocumentChange, DeleteAnnotation, InsertAnnotation, DeleteEmbeddedAnnotation, DeleteRecordProperty, DeletePrimitiveValue, InsertEmbeddedAnnotation, InsertCollection, InsertRecord, InsertRecordProperty, InsertPrimitiveValue, SetFlags, InsertQualifier, ReplaceTextValue, ReplaceRecordProperty, MoveCollectionValue, DeleteQualifier, InsertReference, InsertTarget, ReplaceNode, UpdatePrimitiveValue, DeleteRecord, DeleteTarget, ConvertToCompoundAnnotation, DeleteAnnotationGroup } from './change';
+import { INSERT_PRIMITIVE_VALUE_TYPE, MOVE_COLLECTION_VALUE_CHANGE_TYPE, DELETE_ANNOTATION_CHANGE_TYPE, INSERT_ANNOTATION_CHANGE_TYPE, INSERT_TARGET_CHANGE_TYPE, INSERT_RECORD_CHANGE_TYPE, INSERT_COLLECTION_CHANGE_TYPE, INSERT_EMBEDDED_ANNOTATION_CHANGE_TYPE, INSERT_RECORD_PROPERTY_CHANGE_TYPE, INSERT_QUALIFIER_CHANGE_TYPE, INSERT_REFERENCE_CHANGE_TYPE, DELETE_EMBEDDED_ANNOTATION_CHANGE_TYPE, DELETE_PRIMITIVE_VALUE_CHANGE_TYPE, DELETE_QUALIFIER_CHANGE_TYPE, DELETE_RECORD_CHANGE_TYPE, DELETE_RECORD_PROPERTY_CHANGE_TYPE, REPLACE_NODE_CHANGE_TYPE, REPLACE_RECORD_PROPERTY_CHANGE_TYPE, SET_FLAGS_CHANGE_TYPE, UPDATE_PRIMITIVE_VALUE_CHANGE_TYPE, REPLACE_TEXT_VALUE_CHANGE_TYPE, DELETE_TARGET_CHANGE_TYPE, CONVERT_TO_COMPOUND_ANNOTATION_CHANGE_TYPE, DELETE_ANNOTATION_GROUP_CHANGE_TYPE } from './change';
+import type { CompilerToken } from './cds-compiler-tokens';
+type ChangeHandlerFunction<T extends CDSDocumentChange> = (change: T, reversePath: AstNode[]) => void | Promise<void>;
+type ChangeHandler = {
+    [Change in CDSDocumentChange as Change['type']]: ChangeHandlerFunction<Change>;
+};
+/**
+ *
+ */
+export declare class CDSWriter implements ChangeHandler {
+    private facade;
+    private vocabularyService;
+    private document;
+    private comments;
+    private tokens;
+    private textDocument;
+    private projectRoot;
+    /**
+     * This should be removed once it is no longer needed by deletion logic
+     *
+     * @deprecated
+     */
+    private annotationFile;
+    private readonly changes;
+    private edits;
+    private indentLevelCache;
+    private vocabularyAliases;
+    private deletionRangesMapForTarget;
+    private uniqueInserts;
+    private processedChanges;
+    /**
+     *
+     * @param facade - CDS compiler facade instance.
+     * @param vocabularyService - Vocabulary API.
+     * @param document - CDS document AST root.
+     * @param comments - All comments of the document.
+     * @param tokens - All tokens in the document.
+     * @param textDocument - TextDocument instance.
+     * @param projectRoot - Absolute path to the project root.
+     * @param annotationFile - Internal representation of the annotation file.
+     */
+    constructor(facade: CdsCompilerFacade, vocabularyService: VocabularyService, document: CDSDocument, comments: Comment[], tokens: CompilerToken[], textDocument: TextDocument, projectRoot: string, 
+    /**
+     * This should be removed once it is no longer needed by deletion logic
+     *
+     * @deprecated
+     */
+    annotationFile: AnnotationFile);
+    /**
+     * Adds change to the stack.
+     *
+     * @param change - New change.
+     */
+    addChange(change: CDSDocumentChange): void;
+    /**
+     * Creates text edits for the changes in the stack.
+     *
+     * @returns - Text edits.
+     */
+    getTextEdits(): Promise<TextEdit[]>;
+    /**
+     * Building text edits is a stateful process and needs to be cleared after each {@link CDSWriter.getTextEdits} call.
+     *
+     */
+    private resetState;
+    private getIndentLevel;
+    private isFirstInsert;
+    [INSERT_TARGET_CHANGE_TYPE]: (change: InsertTarget) => void;
+    [INSERT_RECORD_CHANGE_TYPE]: (change: InsertRecord, reversePath: AstNode[]) => void;
+    [INSERT_COLLECTION_CHANGE_TYPE]: (change: InsertCollection, reversePath: AstNode[]) => void;
+    [INSERT_ANNOTATION_CHANGE_TYPE]: (change: InsertAnnotation, reversePath: AstNode[]) => void;
+    [INSERT_EMBEDDED_ANNOTATION_CHANGE_TYPE]: (change: InsertEmbeddedAnnotation, reversePath: AstNode[]) => void;
+    [INSERT_RECORD_PROPERTY_CHANGE_TYPE]: (change: InsertRecordProperty, reversePath: AstNode[]) => void;
+    [INSERT_PRIMITIVE_VALUE_TYPE]: (change: InsertPrimitiveValue, reversePath: AstNode[]) => void;
+    [INSERT_QUALIFIER_CHANGE_TYPE]: (change: InsertQualifier, reversePath: AstNode[]) => void;
+    [INSERT_REFERENCE_CHANGE_TYPE]: (change: InsertReference) => Promise<void>;
+    private deleteNode;
+    [DELETE_TARGET_CHANGE_TYPE]: (_change: DeleteTarget, reversePath: AstNode[]) => void;
+    [DELETE_RECORD_CHANGE_TYPE]: (change: DeleteRecord, reversePath: AstNode[]) => void;
+    [DELETE_RECORD_PROPERTY_CHANGE_TYPE]: (change: DeleteRecordProperty, reversePath: AstNode[]) => void;
+    [DELETE_ANNOTATION_GROUP_CHANGE_TYPE]: (change: DeleteAnnotationGroup, reversePath: AstNode[]) => void;
+    private getDeletionRange;
+    [DELETE_ANNOTATION_CHANGE_TYPE]: (change: DeleteAnnotation, reversePath: AstNode[]) => void;
+    [DELETE_EMBEDDED_ANNOTATION_CHANGE_TYPE]: (change: DeleteEmbeddedAnnotation, reversePath: AstNode[]) => void;
+    [DELETE_PRIMITIVE_VALUE_CHANGE_TYPE]: (change: DeletePrimitiveValue, reversePath: AstNode[]) => void;
+    [DELETE_QUALIFIER_CHANGE_TYPE]: (change: DeleteQualifier, reversePath: AstNode[]) => void;
+    [REPLACE_NODE_CHANGE_TYPE]: (change: ReplaceNode, reversePath: AstNode[]) => void;
+    [REPLACE_RECORD_PROPERTY_CHANGE_TYPE]: (change: ReplaceRecordProperty, reversePath: AstNode[]) => void;
+    [REPLACE_TEXT_VALUE_CHANGE_TYPE]: (change: ReplaceTextValue, reversePath: AstNode[]) => void;
+    [UPDATE_PRIMITIVE_VALUE_CHANGE_TYPE]: (change: UpdatePrimitiveValue, reversePath: AstNode[]) => void;
+    [SET_FLAGS_CHANGE_TYPE]: (change: SetFlags, reversePath: AstNode[]) => void;
+    [MOVE_COLLECTION_VALUE_CHANGE_TYPE]: (change: MoveCollectionValue, reversePath: AstNode[]) => void;
+    [CONVERT_TO_COMPOUND_ANNOTATION_CHANGE_TYPE]: (change: ConvertToCompoundAnnotation, reversePath: AstNode[]) => void;
+}
+export {};
+//# sourceMappingURL=writer.d.ts.map

package/dist/cds/writer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"writer.d.ts","sourceRoot":"","sources":["../../src/cds/writer.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAGvE,OAAO,KAAK,EAA4B,cAAc,EAAa,MAAM,+BAA+B,CAAC;AACzG,OAAO,EACH,QAAQ,EAQX,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAEpE,OAAO,EAA2B,KAAK,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AA4B9F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAMvD,OAAO,KAAK,EACR,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EAChB,wBAAwB,EACxB,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,EACpB,oBAAoB,EACpB,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,EACf,eAAe,EACf,YAAY,EACZ,WAAW,EACX,oBAAoB,EACpB,YAAY,EACZ,YAAY,EACZ,2BAA2B,EAE3B,qBAAqB,EACxB,MAAM,UAAU,CAAC;AAClB,OAAO,EACH,2BAA2B,EAC3B,iCAAiC,EACjC,6BAA6B,EAC7B,6BAA6B,EAC7B,yBAAyB,EACzB,yBAAyB,EACzB,6BAA6B,EAC7B,sCAAsC,EACtC,kCAAkC,EAClC,4BAA4B,EAC5B,4BAA4B,EAC5B,sCAAsC,EACtC,kCAAkC,EAClC,4BAA4B,EAC5B,yBAAyB,EACzB,kCAAkC,EAClC,wBAAwB,EACxB,mCAAmC,EACnC,qBAAqB,EACrB,kCAAkC,EAClC,8BAA8B,EAC9B,yBAAyB,EACzB,0CAA0C,EAC1C,mCAAmC,EACtC,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAQ3D,KAAK,qBAAqB,CAAC,CAAC,SAAS,iBAAiB,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AACtH,KAAK,aAAa,GAAG;KAChB,MAAM,IAAI,iBAAiB,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,qBAAqB,CAAC,MAAM,CAAC;CACjF,CAAC;AAEF;;GAEG;AACH,qBAAa,SAAU,YAAW,aAAa;IAqBvC,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,iBAAiB;IACzB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,WAAW;IACnB;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAhC1B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;IACnD,OAAO,CAAC,KAAK,CAAkB;IAC/B,OAAO,CAAC,gBAAgB,CAAqC;IAC7D,OAAO,CAAC,iBAAiB,CAAqB;IAC9C,OAAO,CAAC,0BAA0B,CAA2C;IAC7E,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,gBAAgB,CAA2B;IAEnD;;;;;;;;;;OAUG;gBAES,MAAM,EAAE,iBAAiB,EACzB,iBAAiB,EAAE,iBAAiB,EACpC,QAAQ,EAAE,WAAW,EACrB,QAAQ,EAAE,OAAO,EAAE,EACnB,MAAM,EAAE,aAAa,EAAE,EACvB,YAAY,EAAE,YAAY,EAC1B,WAAW,EAAE,MAAM;IAC3B;;;;OAIG;IACK,cAAc,EAAE,cAAc;IAO1C;;;;OAIG;IACI,SAAS,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAIjD;;;;OAIG;IACU,YAAY,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IA8BhD;;;OAGG;IACH,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,cAAc;IAYtB,OAAO,CAAC,aAAa;IAWrB,CAAC,yBAAyB,CAAC,WAAY,YAAY,KAAG,IAAI,CAexD;IAEF,CAAC,yBAAyB,CAAC,WAAY,YAAY,eAAe,OAAO,EAAE,KAAG,IAAI,CAyBhF;IAEF,CAAC,6BAA6B,CAAC,WAAY,gBAAgB,eAAe,OAAO,EAAE,KAAG,IAAI,CAUxF;IAEF,CAAC,6BAA6B,CAAC,WAAY,gBAAgB,eAAe,OAAO,EAAE,KAAG,IAAI,CAexF;IAEF,CAAC,sCAAsC,CAAC,WAAY,wBAAwB,eAAe,OAAO,EAAE,KAAG,IAAI,CAuDzG;IAEF,CAAC,kCAAkC,CAAC,WAAY,oBAAoB,eAAe,OAAO,EAAE,KAAG,IAAI,CAejG;IAEF,CAAC,2BAA2B,CAAC,WAAY,oBAAoB,eAAe,OAAO,EAAE,KAAG,IAAI,CAmB1F;IAEF,CAAC,4BAA4B,CAAC,WAAY,eAAe,eAAe,OAAO,EAAE,KAAG,IAAI,CAKtF;IAEF,CAAC,4BAA4B,CAAC,WAAkB,eAAe,KAAG,QAAQ,IAAI,CAAC,CAS7E;IAMF,OAAO,CAAC,UAAU;IAOlB,CAAC,yBAAyB,CAAC,YAAa,YAAY,eAAe,OAAO,EAAE,KAAG,IAAI,CAqCjF;IAEF,CAAC,yBAAyB,CAAC,WAAY,YAAY,eAAe,OAAO,EAAE,KAAG,IAAI,CAEhF;IAEF,CAAC,kCAAkC,CAAC,WAAY,oBAAoB,eAAe,OAAO,EAAE,KAAG,IAAI,CAEjG;IAEF,CAAC,mCAAmC,CAAC,WAAY,qBAAqB,eAAe,OAAO,EAAE,KAAG,IAAI,CAWnG;IAEF,OAAO,CAAC,gBAAgB;IAgBxB,CAAC,6BAA6B,CAAC,WAAY,gBAAgB,eAAe,OAAO,EAAE,KAAG,IAAI,CA4CxF;IAEF,CAAC,sCAAsC,CAAC,WAAY,wBAAwB,eAAe,OAAO,EAAE,KAAG,IAAI,CAmBzG;IACF,CAAC,kCAAkC,CAAC,WAAY,oBAAoB,eAAe,OAAO,EAAE,KAAG,IAAI,CAEjG;IAEF,CAAC,4BAA4B,CAAC,WAAY,eAAe,eAAe,OAAO,EAAE,KAAG,IAAI,CAQtF;IAMF,CAAC,wBAAwB,CAAC,WAAY,WAAW,eAAe,OAAO,EAAE,KAAG,IAAI,CAqB9E;IACF,CAAC,mCAAmC,CAAC,WAAY,qBAAqB,eAAe,OAAO,EAAE,KAAG,IAAI,CAcnG;IACF,CAAC,8BAA8B,CAAC,WAAY,gBAAgB,eAAe,OAAO,EAAE,KAAG,IAAI,CAqBzF;IACF,CAAC,kCAAkC,CAAC,WAAY,oBAAoB,eAAe,OAAO,EAAE,KAAG,IAAI,CAkBjG;IAEF,CAAC,qBAAqB,CAAC,WAAY,QAAQ,eAAe,OAAO,EAAE,KAAG,IAAI,CASxE;IACF,CAAC,iCAAiC,CAAC,WAAY,mBAAmB,eAAe,OAAO,EAAE,KAAG,IAAI,CA+B/F;IACF,CAAC,0CAA0C,CAAC,WAChC,2BAA2B,eACtB,OAAO,EAAE,KACvB,IAAI,CAeL;CACL"}