Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@sap-ux/annotation-generator

Package Overview
Dependencies
Maintainers
0
Versions
50
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@sap-ux/annotation-generator

Library that provides API for generation of annotations by SAP Fiori App Generator

  • 0.1.4
  • npm
  • Socket score

Version published
Weekly downloads
246
increased by267.16%
Maintainers
0
Weekly downloads
 
Created
Source

Fiori Annotation Generator API

Reads annotations for a service in a SAP Fiori Elements project with local metadata. Allows generation of annotations for generation of new Fiori Elements apps.

Installation

Npm
npm install --save @sap-ux/annotation-generator

Yarn
yarn add @sap-ux/annotation-generator

Pnpm
pnpm add @sap-ux/annotation-generator

Usage

Annotation generation example with SAP CAP CDS project:

import { join } from 'path';
import { create as createStore } from 'mem-fs';
import { create as createEditor } from 'mem-fs-editor';
import type { Editor } from 'mem-fs-editor';

import { getProject } from '@sap-ux/project-access';

import type { AnnotationServiceParameters, GenerateAnnotationsOptions } from '@sap-ux/annotation-generator';
import { generateAnnotations} from '@sap-ux/annotation-generator';

const project = await getProject(projectRootFolder);
const fs = createEditor(createStore());

const appName = 'app/project1';
const serviceParameters: AnnotationServiceParameters = {
    project,
    serviceName: 'MainService',
    appName
};

const options: GenerateAnnotationsOptions = {
    entitySetName: 'Capex',
    annotationFilePath: join(appName, 'annotations.cds'),
    addValueHelps: true,
    addFacets: true,
    addLineItems: true
};
await generateAnnotations(fs, serviceParameters, options);

Annotation generation example with standalone UI project and OData backend:

import { join } from 'path';
import { create as createStore } from 'mem-fs';
import { create as createEditor } from 'mem-fs-editor';
import type { Editor } from 'mem-fs-editor';

import { getProject } from '@sap-ux/project-access';

import type { AnnotationServiceParameters, GenerateAnnotationsOptions } from '@sap-ux/annotation-generator';
import { generateAnnotations} from '@sap-ux/annotation-generator';

const project = await getProject(projectRootFolder);
const fs = createEditor(createStore());

const serviceParameters: AnnotationServiceParameters = {
    project,
    serviceName: 'mainService',
};

const options: GenerateAnnotationsOptions = {
    entitySetName: 'Individual',
    annotationFilePath: join('webapp', 'annotations', 'annotation.xml'),
    addValueHelps: true,
    addFacets: true,
    addLineItems: true
};
await generateAnnotations(fs, serviceParameters, options);

Keywords

OData annotations, app generation

FAQs

Package last updated on 09 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc