Question Re: CAP typescript: how do I get draft data from draft en... in Technology Q&A

CAP typescript: how do I get draft data from draft enabled entity?

shf — Fri, 18 Oct 2024 19:47:26 GMT

Hello,

I'm using CAP with typescript and I have defined a draft-enabled entity SystemKinds. Cds-Typer is installed and Typescript types will be generated and updated each time I change my entity definition.

If I send a GET request with SystemKinds , I can see all properties of entity SystemKinds plus the draft properties IsActiveEntity, HasActiveEntity,HasDraftEntity. On sqlite database, I also see the auto-generated tables AdminConfigServices_SystemKinds_drafts and the DRAFT_DraftAdministrativeData with its properties e.g. InProcessByUser. Both tables are linked via DraftUUID.

Now, I like to display InProcessByUser in Fiori Elements list report and the date of last modification. Therefore, I try to extend my entity with these two properties. I don't know how to get access to these properties inside a READ handler. In other words, how do I get access to these auto-generated tables ? The approach with SystemKind.drafts does not work as documented in Fiori Support | capire (cloud.sap). Typescript does not know SystemKind.drafts or SystemKinds.drafts. It is not available in the type definition in folder @CDS-models.

Here is my AdminConfiguration.ts:

import cds from '@sap/cds'; import { SystemKind, SystemKinds } from '#cds-models/AdminConfigurationService'; class AdminConfigurationService extends cds.ApplicationService { /** Registering custom event handlers */ init() { // extract entities const { SystemKinds } = this.entities // Extend draft information this.after('READ', SystemKinds, async( response ) => { // here, i like to extend response with the properties LastChangedByUser from DRAFT_DraftAdministrativeData // and HasDraftEntity from AdminConfigurationService_SystemKinds_drafts } }

Does anyone know how I can read draft-related administrative data?

Yours

Stephan

Re: CAP typescript: how do I get draft data from draft enabled entity?

arunkrishnamoorthy1988 — Sat, 19 Oct 2024 11:28:14 GMT

Hi,

What do you get when reading the draft entities.

const draftData = await SELECT.from(SystemKinds.drafts).where({..where condition });
Does this select not give you the draft adminsitrative data?

Re: CAP typescript: how do I get draft data from draft en...

shf — Sat, 19 Oct 2024 16:18:46 GMT

Yes, you are right:

const draftData = await SELECT.from(SystemKinds.drafts);

is giving me all properties of my entity SystemKinds plus property "HasActiveEntity" and "DraftAdministrativeData_draftUUID" of table AdminConfigServices_SystemKinds_drafts but not the properties "HasDraftEntity" and "IsActiveEntity". But this is ok and sufficiently.

I was confused because of getting error messages in VSCODE around "SystemKinds.drafts" (red underlined) . If I hover over "SystemKinds.drafts", I will get typescript error, but I get no program dumps. Thus, I thought if typescript has an issue, the program will crash...

But I'm still missing typescript type definition for SystemKinds.drafts in one of the .ts files in the @CDS-models folder.

Yours,

Stephan

Re: CAP typescript: how do I get draft data from draft enabled entity?

daniel_ogrady65 — Tue, 22 Oct 2024 06:57:59 GMT

Hi,

does your project happen to be built with cds8? If so, did you install @cap-js/cds-types as devDependency?

Best,
Daniel

Re: CAP typescript: how do I get draft data from draft en...

shf — Fri, 25 Oct 2024 15:43:25 GMT

Hello,

my packag.json encounters the following:

"devDependencies": { "@cap-js/cds-typer": ">=0.1", "@cap-js/cds-types": "^0.6", "@cap-js/sqlite": "^1", "@sap/ux-specification": "UI5-1.129", "@types/node": "^20", "@sapui5/types": "^1.116", "@ui5/cli": "^4.0.8", "typescript": "^5" }

If I do the following, I will get the DraftAdministrativeData as follows:

let AvailEntities: cds.entity[] = [SystemKinds, SystemKinds.drafts];
srv.after('READ', AvailEntities, async (response) => {
if (!response) return;
....
const currentUser = cds.context?.user.id;
.....
response.forEach((singleEntity: any) => {
....
let IsCreatedByMe : Boolean = singleEntity.DraftAdministrativeData.DraftIsCreatedByMe;
let InProcessBy : String = singleEntity.DraftAdministrativeData.InProcessByUser;
});
});

For the SystemKinds.drafts , there is no TypeScript type auto-generated. The draft administrative data can be accessed by the entity's DraftAdministrativeData property.

Re: CAP typescript: how do I get draft data from draft en...

arunkrishnamoorthy1988 — Sun, 27 Oct 2024 12:02:35 GMT

Hi Stephen,

I saw this git commit today on the cds-type package and felt this would be the relevant update for you.

The draft properties are added to the type definition.

https://github.com/cap-js/cds-typer/pull/354

Regards,
Arun K

Re: CAP typescript: how do I get draft data from draft en...

shf — Sun, 27 Oct 2024 16:24:44 GMT

Hi Arun, I have updated NPM with the newest version of @CDS-typer . There are not all properties available: InProcessByUser is missing.