@sap-ux/fiori-annotation-api 0.1.0

package/dist/avt/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/avt/types.ts"],"names":[],"mappings":""}

package/dist/avt/utils.d.ts

@@ -0,0 +1,61 @@
+import type { AliasInformation } from '@sap-ux/odata-annotation-core';
+import type { AnnotationListWithOrigins, AnnotationWithOrigin, CollectionExpressionWithOrigins, RecordWithOrigins } from './annotations';
+import type { AVTNode } from './types';
+export interface NamespaceMap {
+    [aliasOrNamespace: string]: string;
+}
+/**
+ *  Converts path to fully qualified path.
+ *
+ * @param namespaceMap - Namespace or alias to namespace map.
+ * @param currentNamespace - Current files namespace.
+ * @param path - Path to be converted.
+ * @returns Fully qualified path.
+ */
+export declare function resolvePath(namespaceMap: NamespaceMap, currentNamespace: string, path: string): string;
+/**
+ * Converts enum member to fully qualified name.
+ *
+ * @param namespaceMap - Namespace or alias to namespace map.
+ * @param currentNamespace - Current files namespace.
+ * @param enumMemberString - Enum member name.
+ * @returns Fully qualified enum member name.
+ */
+export declare function resolveEnumMemberValue(namespaceMap: NamespaceMap, currentNamespace: string, enumMemberString: string): string;
+/**
+ * Converts enum member name to alias qualified name.
+ *
+ * @param aliasInfo - Alias information.
+ * @param enumMember - Enum member name
+ * @returns Alias qualified enum member name.
+ */
+export declare function getAliasedEnumMember(aliasInfo: AliasInformation, enumMember: string): string;
+/**
+ * Checks if AVT node is an annotation list.
+ *
+ * @param node - AVT node.
+ * @returns True if node is an annotation list.
+ */
+export declare function isAnnotationList(node: AVTNode): node is AnnotationListWithOrigins;
+/**
+ * Checks if AVT node is an annotation.
+ *
+ * @param node - AVT node.
+ * @returns True if node is an annotation.
+ */
+export declare function isAnnotation(node: AVTNode): node is AnnotationWithOrigin;
+/**
+ * Checks if AVT node is a record.
+ *
+ * @param node - AVT node.
+ * @returns True if node is a record.
+ */
+export declare function isRecord(node: AVTNode): node is RecordWithOrigins;
+/**
+ * Checks if AVT node is a collection.
+ *
+ * @param node - AVT node.
+ * @returns True if node is a collection.
+ */
+export declare function isCollection(node: AVTNode): node is CollectionExpressionWithOrigins;
+//# sourceMappingURL=utils.d.ts.map

package/dist/avt/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/avt/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEtE,OAAO,KAAK,EACR,yBAAyB,EACzB,oBAAoB,EACpB,+BAA+B,EAC/B,iBAAiB,EACpB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEvC,MAAM,WAAW,YAAY;IAEzB,CAAC,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAAC;CACtC;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAGtG;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAClC,YAAY,EAAE,YAAY,EAC1B,gBAAgB,EAAE,MAAM,EACxB,gBAAgB,EAAE,MAAM,GACzB,MAAM,CAKR;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAK5F;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,yBAAyB,CAEjF;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,oBAAoB,CAExE;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,iBAAiB,CAEjE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,+BAA+B,CAEnF"}

package/dist/avt/utils.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCollection = exports.isRecord = exports.isAnnotation = exports.isAnnotationList = exports.getAliasedEnumMember = exports.resolveEnumMemberValue = exports.resolvePath = void 0;
+const odata_annotation_core_1 = require("@sap-ux/odata-annotation-core");
+/**
+ *  Converts path to fully qualified path.
+ *
+ * @param namespaceMap - Namespace or alias to namespace map.
+ * @param currentNamespace - Current files namespace.
+ * @param path - Path to be converted.
+ * @returns Fully qualified path.
+ */
+function resolvePath(namespaceMap, currentNamespace, path) {
+    const parsedPath = (0, odata_annotation_core_1.parsePath)(path);
+    return (0, odata_annotation_core_1.toFullyQualifiedPath)(namespaceMap, currentNamespace, parsedPath);
+}
+exports.resolvePath = resolvePath;
+/**
+ * Converts enum member to fully qualified name.
+ *
+ * @param namespaceMap - Namespace or alias to namespace map.
+ * @param currentNamespace - Current files namespace.
+ * @param enumMemberString - Enum member name.
+ * @returns Fully qualified enum member name.
+ */
+function resolveEnumMemberValue(namespaceMap, currentNamespace, enumMemberString) {
+    return enumMemberString
+        .split(' ')
+        .map((enumMember) => resolvePath(namespaceMap, currentNamespace, enumMember))
+        .join(' ');
+}
+exports.resolveEnumMemberValue = resolveEnumMemberValue;
+/**
+ * Converts enum member name to alias qualified name.
+ *
+ * @param aliasInfo - Alias information.
+ * @param enumMember - Enum member name
+ * @returns Alias qualified enum member name.
+ */
+function getAliasedEnumMember(aliasInfo, enumMember) {
+    return enumMember
+        .split(' ')
+        .map((enumMember) => (0, odata_annotation_core_1.toAliasQualifiedName)(enumMember, aliasInfo))
+        .join(' ');
+}
+exports.getAliasedEnumMember = getAliasedEnumMember;
+/**
+ * Checks if AVT node is an annotation list.
+ *
+ * @param node - AVT node.
+ * @returns True if node is an annotation list.
+ */
+function isAnnotationList(node) {
+    return typeof node.target !== 'undefined';
+}
+exports.isAnnotationList = isAnnotationList;
+/**
+ * Checks if AVT node is an annotation.
+ *
+ * @param node - AVT node.
+ * @returns True if node is an annotation.
+ */
+function isAnnotation(node) {
+    return typeof node.term !== 'undefined';
+}
+exports.isAnnotation = isAnnotation;
+/**
+ * Checks if AVT node is a record.
+ *
+ * @param node - AVT node.
+ * @returns True if node is a record.
+ */
+function isRecord(node) {
+    return Array.isArray(node.propertyValues);
+}
+exports.isRecord = isRecord;
+/**
+ * Checks if AVT node is a collection.
+ *
+ * @param node - AVT node.
+ * @returns True if node is a collection.
+ */
+function isCollection(node) {
+    return node.type === 'Collection';
+}
+exports.isCollection = isCollection;
+//# sourceMappingURL=utils.js.map

package/dist/avt/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/avt/utils.ts"],"names":[],"mappings":";;;AACA,yEAAsG;AActG;;;;;;;GAOG;AACH,SAAgB,WAAW,CAAC,YAA0B,EAAE,gBAAwB,EAAE,IAAY;IAC1F,MAAM,UAAU,GAAG,IAAA,iCAAS,EAAC,IAAI,CAAC,CAAC;IACnC,OAAO,IAAA,4CAAoB,EAAC,YAAY,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC;AAC5E,CAAC;AAHD,kCAGC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAClC,YAA0B,EAC1B,gBAAwB,EACxB,gBAAwB;IAExB,OAAO,gBAAgB;SAClB,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,WAAW,CAAC,YAAY,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC;SAC5E,IAAI,CAAC,GAAG,CAAC,CAAC;AACnB,CAAC;AATD,wDASC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAC,SAA2B,EAAE,UAAkB;IAChF,OAAO,UAAU;SACZ,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAA,4CAAoB,EAAC,UAAU,EAAE,SAAS,CAAC,CAAC;SAChE,IAAI,CAAC,GAAG,CAAC,CAAC;AACnB,CAAC;AALD,oDAKC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,IAAa;IAC1C,OAAO,OAAQ,IAAY,CAAC,MAAM,KAAK,WAAW,CAAC;AACvD,CAAC;AAFD,4CAEC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,IAAa;IACtC,OAAO,OAAQ,IAAY,CAAC,IAAI,KAAK,WAAW,CAAC;AACrD,CAAC;AAFD,oCAEC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,IAAa;IAClC,OAAO,KAAK,CAAC,OAAO,CAAE,IAAY,CAAC,cAAc,CAAC,CAAC;AACvD,CAAC;AAFD,4BAEC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,IAAa;IACtC,OAAQ,IAAY,CAAC,IAAI,KAAK,YAAY,CAAC;AAC/C,CAAC;AAFD,oCAEC"}

package/dist/cds/adapter.d.ts

@@ -0,0 +1,112 @@
+import type { WorkspaceEdit, Target, CompilerMessage } from '@sap-ux/odata-annotation-core-types';
+import { MetadataService } from '@sap-ux/odata-entity-model';
+import type { Project } from '@sap-ux/project-access';
+import type { VocabularyService } from '@sap-ux/odata-vocabularies';
+import { type CompiledService, type TextFile, type AnnotationServiceAdapter, type AnnotationFileChange, type CDSService, type InsertTarget, type DeleteElement, type InsertElement, type DeleteAttribute, type UpdateAttributeValue, type ReplaceAttribute, type ReplaceElement, type ReplaceText, type ReplaceElementContent, type InsertAttribute, type MoveElements, INSERT_TARGET, DELETE_ELEMENT, INSERT_ELEMENT, INSERT_ATTRIBUTE, DELETE_ATTRIBUTE, UPDATE_ATTRIBUTE_VALUE } from '../types';
+import type { Document } from './document';
+import { CDSWriter } from './writer';
+import { DELETE_REFERENCE, MOVE_ELEMENT, REPLACE_ATTRIBUTE, REPLACE_ELEMENT, REPLACE_ELEMENT_CONTENT, REPLACE_TEXT, UPDATE_ELEMENT_NAME } from '../types/internal-change';
+type ChangeHandlerFunction<T extends AnnotationFileChange> = (writer: CDSWriter, document: Document, change: T) => void;
+type ChangeHandler = {
+    [Change in AnnotationFileChange as Change['type']]: ChangeHandlerFunction<Change>;
+};
+/**
+ *
+ */
+export declare class CDSAnnotationServiceAdapter implements AnnotationServiceAdapter, ChangeHandler {
+    private service;
+    private project;
+    private vocabularyService;
+    private appName;
+    metadataService: MetadataService;
+    splitAnnotationSupport: boolean;
+    private fileCache;
+    private documents;
+    private metadata;
+    private missingReferences;
+    /**
+     *
+     * @param service - CDS service structure.
+     * @param project - Project structure.
+     * @param vocabularyService - Vocabulary API.
+     * @param appName - Name of the application.
+     */
+    constructor(service: CDSService, project: Project, vocabularyService: VocabularyService, appName: string);
+    private facade;
+    private setFileCache;
+    private setFacade;
+    private _compiledService;
+    /**
+     * @returns Compiled CDS service.
+     */
+    get compiledService(): CompiledService;
+    private set compiledService(value);
+    private _fileSequence;
+    /**
+     * Refreshes internal data structures from the provided project files.
+     *
+     * @param fileCache - File uri mapped to file content.
+     * @returns Sync errors
+     */
+    sync(fileCache: Map<string, string>): Promise<Map<string, CompilerMessage>>;
+    /**
+     * Returns all relevant service files.
+     *
+     * @param includeGhostFiles - Flag indicating if ghost files should be included.
+     * @returns All relevant service files.
+     */
+    getAllFiles(includeGhostFiles: boolean): TextFile[];
+    /**
+     * Creates empty annotation file content for the given service.
+     *
+     * @param serviceName - Name of the service.
+     * @param uri - URI for the new annotation file.
+     * @returns New annotation file content.
+     */
+    getInitialFileContent(serviceName: string, uri: string): string;
+    /**
+     * Converts changes to workspace edits.
+     *
+     * @param changes - Internal changes.
+     * @returns Workspace edits.
+     */
+    getWorkspaceEdit(changes: AnnotationFileChange[]): Promise<WorkspaceEdit>;
+    /**
+     * Checks if there are no compile errors in the files after update.
+     *
+     * @param fileCache - Updated file content.
+     * @returns Errors.
+     */
+    validateChanges(fileCache: Map<string, string>): Promise<Map<string, CompilerMessage>>;
+    /**
+     * Converts annotation object to a string.
+     *
+     * @param target - Content of an 'Annotations' element.
+     * @returns CDS representation of the annotations.
+     */
+    serializeTarget(target: Target): string;
+    private _getCompiledService;
+    private clearState;
+    private invalidateCaches;
+    private updateFileSequence;
+    private processMissingReferences;
+    private addMissingReferences;
+    [INSERT_TARGET]: (writer: CDSWriter, document: Document, change: InsertTarget) => void;
+    [DELETE_ELEMENT]: (writer: CDSWriter, document: Document, change: DeleteElement) => void;
+    [INSERT_ELEMENT]: (writer: CDSWriter, document: Document, change: InsertElement) => void;
+    private insertInFlattenedStructure;
+    private insertAnnotation;
+    private insertRecord;
+    [INSERT_ATTRIBUTE]: (writer: CDSWriter, document: Document, change: InsertAttribute) => void;
+    [DELETE_ATTRIBUTE]: (writer: CDSWriter, document: Document, change: DeleteAttribute) => void;
+    [UPDATE_ATTRIBUTE_VALUE]: (writer: CDSWriter, document: Document, change: UpdateAttributeValue) => void;
+    [REPLACE_ATTRIBUTE]: (writer: CDSWriter, document: Document, change: ReplaceAttribute) => void;
+    [REPLACE_ELEMENT]: (writer: CDSWriter, document: Document, change: ReplaceElement) => void;
+    [REPLACE_TEXT]: (writer: CDSWriter, document: Document, change: ReplaceText) => void;
+    [REPLACE_ELEMENT_CONTENT]: (writer: CDSWriter, document: Document, change: ReplaceElementContent) => void;
+    [MOVE_ELEMENT]: (writer: CDSWriter, document: Document, change: MoveElements) => void;
+    [UPDATE_ELEMENT_NAME]: () => void;
+    [DELETE_REFERENCE]: () => void;
+}
+export {};
+//# sourceMappingURL=adapter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/cds/adapter.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAER,aAAa,EAGb,MAAM,EACN,eAAe,EAIlB,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAoBtD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAEpE,OAAO,EACH,KAAK,eAAe,EACpB,KAAK,QAAQ,EACb,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,aAAa,EACb,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,EACzB,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAkBrC,OAAO,EACH,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,eAAe,EACf,uBAAuB,EACvB,YAAY,EACZ,mBAAmB,EACtB,MAAM,0BAA0B,CAAC;AAElC,KAAK,qBAAqB,CAAC,CAAC,SAAS,oBAAoB,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,KAAK,IAAI,CAAC;AACxH,KAAK,aAAa,GAAG;KAChB,MAAM,IAAI,oBAAoB,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,qBAAqB,CAAC,MAAM,CAAC;CACpF,CAAC;AAEF;;GAEG;AACH,qBAAa,2BAA4B,YAAW,wBAAwB,EAAE,aAAa;IAenF,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,iBAAiB;IACzB,OAAO,CAAC,OAAO;IAjBZ,eAAe,kBAAyB;IACxC,sBAAsB,UAAQ;IACrC,OAAO,CAAC,SAAS,CAAsB;IACvC,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,CAAC,QAAQ,CAAyB;IACzC,OAAO,CAAC,iBAAiB,CAAsC;IAC/D;;;;;;OAMG;gBAES,OAAO,EAAE,UAAU,EACnB,OAAO,EAAE,OAAO,EAChB,iBAAiB,EAAE,iBAAiB,EACpC,OAAO,EAAE,MAAM;IAK3B,OAAO,CAAC,MAAM,CAAgC;IAC9C,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,gBAAgB,CAA8B;IACtD;;OAEG;IACH,IAAW,eAAe,IAAI,eAAe,CAK5C;IAED,OAAO,KAAK,eAAe,QAE1B;IAED,OAAO,CAAC,aAAa,CAAyB;IAE9C;;;;;OAKG;IACU,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IA8DxF;;;;;OAKG;IACI,WAAW,CAAC,iBAAiB,EAAE,OAAO,GAAG,QAAQ,EAAE;IAc1D;;;;;;OAMG;IACI,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM;IAWtE;;;;;OAKG;IACU,gBAAgB,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IA4CtF;;;;;OAKG;IACU,eAAe,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAInG;;;;;OAKG;IACI,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAI9C,OAAO,CAAC,mBAAmB;IAsB3B,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,wBAAwB;IAiBhC,OAAO,CAAC,oBAAoB;IAM5B,CAAC,aAAa,CAAC,WAAY,SAAS,YAAY,QAAQ,UAAU,YAAY,KAAG,IAAI,CA4BnF;IAEF,CAAC,cAAc,CAAC,WAAY,SAAS,YAAY,QAAQ,UAAU,aAAa,KAAG,IAAI,CAmDrF;IAEF,CAAC,cAAc,CAAC,WAAY,SAAS,YAAY,QAAQ,UAAU,aAAa,KAAG,IAAI,CA8DrF;IAEF,OAAO,CAAC,0BAA0B;IAsBlC,OAAO,CAAC,gBAAgB;IAaxB,OAAO,CAAC,YAAY;IAapB,CAAC,gBAAgB,CAAC,WAAY,SAAS,YAAY,QAAQ,UAAU,eAAe,KAAG,IAAI,CA4CzF;IACF,CAAC,gBAAgB,CAAC,WAAY,SAAS,YAAY,QAAQ,UAAU,eAAe,KAAG,IAAI,CAWzF;IACF,CAAC,sBAAsB,CAAC,WAAY,SAAS,YAAY,QAAQ,UAAU,oBAAoB,KAAG,IAAI,CAUpG;IACF,CAAC,iBAAiB,CAAC,WAAY,SAAS,YAAY,QAAQ,UAAU,gBAAgB,KAAG,IAAI,CAiB3F;IACF,CAAC,eAAe,CAAC,WAAY,SAAS,YAAY,QAAQ,UAAU,cAAc,KAAG,IAAI,CAuBvF;IACF,CAAC,YAAY,CAAC,WAAY,SAAS,YAAY,QAAQ,UAAU,WAAW,KAAG,IAAI,CA0BjF;IACF,CAAC,uBAAuB,CAAC,WAAY,SAAS,YAAY,QAAQ,UAAU,qBAAqB,KAAG,IAAI,CAiCtG;IACF,CAAC,YAAY,CAAC,WAAY,SAAS,YAAY,QAAQ,UAAU,YAAY,KAAG,IAAI,CAelF;IACF,CAAC,mBAAmB,CAAC,QAAO,IAAI,CAE9B;IACF,CAAC,gBAAgB,CAAC,QAAO,IAAI,CAE3B;CACL"}