@rayutek/abap-adt-api 6.2.1-pkg-1.0.0

package/build/api/objectcreator.js

@@ -0,0 +1,372 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parentTypeId = exports.isCreatableTypeId = exports.isNonGroupType = exports.CreatableTypes = exports.isPackageType = exports.isGroupType = exports.createTestInclude = exports.createObject = exports.validateNewObject = exports.objectPath = exports.loadTypes = exports.isBindingOptions = exports.isPackageOptions = exports.hasPackageOptions = exports.BindinTypes = void 0;
+const sprintf_js_1 = require("sprintf-js");
+const AdtException_1 = require("../AdtException");
+const utilities_1 = require("../utilities");
+exports.BindinTypes = [
+    { description: "Odata V2 - Web API", bindingtype: "ODATA", category: "0" },
+    { description: "Odata V2 - UI", bindingtype: "ODATA", category: "1" }
+];
+const hasPackageOptions = (o) => !!(o === null || o === void 0 ? void 0 : o.swcomp);
+exports.hasPackageOptions = hasPackageOptions;
+const isPackageOptions = (o) => (o === null || o === void 0 ? void 0 : o.objtype) === "DEVC/K" && (0, exports.hasPackageOptions)(o);
+exports.isPackageOptions = isPackageOptions;
+const isBindingOptions = (o) => (o === null || o === void 0 ? void 0 : o.objtype) === "SRVB/SVB" &&
+    !!(o === null || o === void 0 ? void 0 : o.service) &&
+    !!(o === null || o === void 0 ? void 0 : o.bindingtype);
+exports.isBindingOptions = isBindingOptions;
+const xmlEntry = (value, key) => value ? `<${key}>${(0, utilities_1.encodeEntity)(value)}</${key}>}` : `<${key}/>`;
+const xmlAttribute = (value, key) => value ? `${key}="${(0, utilities_1.encodeEntity)(value)}"` : ``;
+function createBodyPackage(options) {
+    const responsible = `adtcore:responsible="${options.responsible}"`;
+    const compname = xmlAttribute(options.swcomp, `pak:name`);
+    const description = xmlAttribute(options.description, "adtcore:description");
+    const superp = xmlAttribute(options.parentName, "adtcore:name");
+    const pkgname = xmlAttribute(options.name, "adtcore:name");
+    const pkgtype = xmlAttribute(options.packagetype, "pak:packageType");
+    return `<?xml version="1.0" encoding="UTF-8"?>
+<pak:package xmlns:pak="http://www.sap.com/adt/packages"
+xmlns:adtcore="http://www.sap.com/adt/core" ${description}
+${pkgname} adtcore:type="DEVC/K" adtcore:version="active" ${responsible}>
+<adtcore:packageRef  adtcore:name="YMU_RAP"/>
+<pak:attributes ${pkgtype}/>
+<pak:superPackage ${superp}/>
+<pak:applicationComponent/>
+<pak:transport>
+ <pak:softwareComponent ${compname}/>
+ <pak:transportLayer pak:name="${(0, utilities_1.encodeEntity)(options.transportLayer)}"/>
+</pak:transport>
+<pak:translation/>
+<pak:useAccesses/>
+<pak:packageInterfaces/>
+<pak:subPackages/>
+</pak:package>`;
+}
+function createBodyFunc(options, type) {
+    const responsible = `adtcore:responsible="${options.responsible}"`;
+    return `<?xml version="1.0" encoding="UTF-8"?>
+  <${type.rootName} ${type.nameSpace} 
+  xmlns:adtcore="http://www.sap.com/adt/core"
+  adtcore:description="${(0, utilities_1.encodeEntity)(options.description)}"
+  adtcore:name="${options.name}" adtcore:type="${options.objtype}">
+  <adtcore:containerRef adtcore:name="${options.parentName}" 
+    adtcore:type="FUGR/F"
+    adtcore:uri="${options.parentPath}" />
+</${type.rootName}>`;
+}
+function createBodySimple(options, type, body = "") {
+    const responsible = `adtcore:responsible="${options.responsible}"`;
+    body = body || `<adtcore:packageRef adtcore:name="${options.parentName}"/>`;
+    return `<?xml version="1.0" encoding="UTF-8"?>
+        <${type.rootName} ${type.nameSpace}
+          xmlns:adtcore="http://www.sap.com/adt/core"
+          adtcore:description="${(0, utilities_1.encodeEntity)(options.description)}"
+          adtcore:name="${options.name}" adtcore:type="${options.objtype}"
+          ${responsible} ${type.extra || ""}>
+          ${body}
+        </${type.rootName}>`;
+}
+function createBodyBinding(options, type) {
+    const body = `<adtcore:packageRef adtcore:name="${options.parentName}"/>
+      <srvb:services srvb:name="${options.name}">
+          <srvb:content srvb:version="0001">
+              <srvb:serviceDefinition adtcore:name="${options.service}"/>
+          </srvb:content>
+      </srvb:services>
+      <srvb:binding srvb:category="0" srvb:type="${options.bindingtype}" srvb:version="V2">
+          <srvb:implementation adtcore:name=""/>
+      </srvb:binding>`;
+    return createBodySimple(options, type, body);
+}
+function createBody(options, type) {
+    switch (type.typeId) {
+        case "DEVC/K":
+            if ((0, exports.isPackageOptions)(options))
+                return createBodyPackage(options);
+            throw (0, AdtException_1.adtException)("Can't create a Package with incomplete data");
+        case "FUGR/FF":
+        case "FUGR/I":
+            return createBodyFunc(options, type);
+        case "SRVB/SVB":
+            if ((0, exports.isBindingOptions)(options))
+                return createBodyBinding(options, type);
+            throw (0, AdtException_1.adtException)("Can't create service binding with incomplete data");
+        default:
+            return createBodySimple(options, type);
+    }
+}
+async function loadTypes(h) {
+    const response = await h.request("/sap/bc/adt/repository/typestructure", {
+        method: "POST"
+    });
+    const raw = (0, utilities_1.fullParse)(response.body);
+    return (0, utilities_1.xmlArray)(raw, "asx:abap", "asx:values", "DATA", "SEU_ADT_OBJECT_TYPE_DESCRIPTOR").map((x) => {
+        return { ...x, CAPABILITIES: (0, utilities_1.xmlArray)(x, "CAPABILITIES", "SEU_ACTION") };
+    });
+}
+exports.loadTypes = loadTypes;
+function objectPath(typeIdOrObjectOptions, name, parentName) {
+    if (!(0, utilities_1.isString)(typeIdOrObjectOptions))
+        return objectPath(typeIdOrObjectOptions.objtype, typeIdOrObjectOptions.name, typeIdOrObjectOptions.parentName);
+    const encodedname = encodeURIComponent(name || "");
+    const ot = exports.CreatableTypes.get(typeIdOrObjectOptions);
+    if (!ot)
+        return "";
+    return ("/sap/bc/adt/" +
+        (0, sprintf_js_1.sprintf)(ot.creationPath, encodeURIComponent(parentName || "")) +
+        "/" +
+        encodedname);
+}
+exports.objectPath = objectPath;
+async function validateNewObject(h, options) {
+    const ot = exports.CreatableTypes.get(options.objtype);
+    if (!ot)
+        throw (0, AdtException_1.adtException)("Unsupported object type");
+    if (!ot.validationPath)
+        throw (0, AdtException_1.adtException)(`Validation not supported for object ${ot} ${options.objname}`);
+    const response = await h.request("/sap/bc/adt/" + ot.validationPath, {
+        method: "POST",
+        qs: options
+    });
+    const raw = (0, utilities_1.fullParse)(response.body);
+    const results = (0, utilities_1.xmlArray)(raw, "asx:abap", "asx:values", "DATA");
+    const record = (results && results[0]) || {};
+    const { SEVERITY, SHORT_TEXT, CHECK_RESULT } = record;
+    if (SEVERITY === "ERROR")
+        throw (0, AdtException_1.adtException)(record.SHORT_TEXT);
+    return {
+        SEVERITY,
+        SHORT_TEXT,
+        success: !!CHECK_RESULT || !!SEVERITY
+    };
+}
+exports.validateNewObject = validateNewObject;
+async function createObject(h, options) {
+    const ot = exports.CreatableTypes.get(options.objtype);
+    if (!ot)
+        throw (0, AdtException_1.adtException)("Unsupported object type");
+    const url = "/sap/bc/adt/" +
+        (0, sprintf_js_1.sprintf)(ot.creationPath, encodeURIComponent(options.parentName.toLowerCase()));
+    options.responsible = (options.responsible || h.username).toUpperCase();
+    const body = createBody(options, ot);
+    const qs = {};
+    if (options.transport)
+        qs.corrNr = options.transport;
+    // will raise exceptions on failure
+    await h.request(url, {
+        body,
+        headers: { "Content-Type": "application/*" },
+        method: "POST",
+        qs
+    });
+}
+exports.createObject = createObject;
+async function createTestInclude(h, clas, lockHandle, corrNr) {
+    const body = `<?xml version="1.0" encoding="UTF-8"?><class:abapClassInclude
+  xmlns:class="http://www.sap.com/adt/oo/classes" xmlns:adtcore="http://www.sap.com/adt/core"
+  adtcore:name="dummy" class:includeType="testclasses"/>`;
+    await h.request(`/sap/bc/adt/oo/classes/${encodeURIComponent(clas)}/includes`, {
+        body,
+        headers: { "Content-Type": "application/*" },
+        method: "POST",
+        qs: { lockHandle, corrNr }
+    });
+}
+exports.createTestInclude = createTestInclude;
+function isGroupType(type) {
+    return type === "FUGR/FF" || type === "FUGR/I";
+}
+exports.isGroupType = isGroupType;
+function isPackageType(type) {
+    return type === "DEVC/K";
+}
+exports.isPackageType = isPackageType;
+exports.CreatableTypes = new Map();
+function isNonGroupType(type) {
+    return exports.CreatableTypes.has(type) && !isGroupType(type);
+}
+exports.isNonGroupType = isNonGroupType;
+function isCreatableTypeId(type) {
+    return isGroupType(type) || isNonGroupType(type);
+}
+exports.isCreatableTypeId = isCreatableTypeId;
+function parentTypeId(type) {
+    return isGroupType(type) ? "FUGR/F" : "DEVC/K";
+}
+exports.parentTypeId = parentTypeId;
+const ctypes = [
+    {
+        creationPath: "programs/programs",
+        label: "Program",
+        nameSpace: 'xmlns:program="http://www.sap.com/adt/programs/programs"',
+        rootName: "program:abapProgram",
+        typeId: "PROG/P",
+        validationPath: "programs/validation",
+        maxLen: 30
+    },
+    {
+        creationPath: "oo/classes",
+        label: "Class",
+        nameSpace: 'xmlns:class="http://www.sap.com/adt/oo/classes"',
+        rootName: "class:abapClass",
+        typeId: "CLAS/OC",
+        validationPath: "oo/validation/objectname",
+        maxLen: 30
+    },
+    {
+        creationPath: "oo/interfaces",
+        label: "Interface",
+        nameSpace: 'xmlns:intf="http://www.sap.com/adt/oo/interfaces"',
+        rootName: "intf:abapInterface",
+        typeId: "INTF/OI",
+        validationPath: "oo/validation/objectname",
+        maxLen: 30
+    },
+    {
+        creationPath: "programs/includes",
+        label: "Include",
+        nameSpace: 'xmlns:include="http://www.sap.com/adt/programs/includes"',
+        rootName: "include:abapInclude",
+        typeId: "PROG/I",
+        validationPath: "includes/validation",
+        maxLen: 30
+    },
+    {
+        creationPath: "functions/groups",
+        label: "Function Group",
+        nameSpace: 'xmlns:group="http://www.sap.com/adt/functions/groups"',
+        rootName: "group:abapFunctionGroup",
+        typeId: "FUGR/F",
+        validationPath: "functions/validation",
+        maxLen: 26
+    },
+    {
+        creationPath: "functions/groups/%s/fmodules",
+        label: "Function module",
+        nameSpace: 'xmlns:fmodule="http://www.sap.com/adt/functions/fmodules"',
+        rootName: "fmodule:abapFunctionModule",
+        typeId: "FUGR/FF",
+        validationPath: "functions/validation",
+        maxLen: 30
+    },
+    {
+        creationPath: "functions/groups/%s/includes",
+        label: "Function group include",
+        nameSpace: 'xmlns:finclude="http://www.sap.com/adt/functions/fincludes"',
+        rootName: "finclude:abapFunctionGroupInclude",
+        typeId: "FUGR/I",
+        validationPath: "functions/validation",
+        maxLen: 3
+    },
+    {
+        creationPath: "ddic/ddl/sources",
+        label: "CDS Data Definitions",
+        nameSpace: 'xmlns:ddl="http://www.sap.com/adt/ddic/ddlsources"',
+        rootName: "ddl:ddlSource",
+        typeId: "DDLS/DF",
+        validationPath: "ddic/ddl/validation",
+        maxLen: 30
+    },
+    {
+        creationPath: "acm/dcl/sources",
+        label: "CDS Access Control",
+        nameSpace: 'xmlns:dcl="http://www.sap.com/adt/acm/dclsources"',
+        rootName: "dcl:dclSource",
+        typeId: "DCLS/DL",
+        validationPath: "acm/dcl/validation",
+        maxLen: 30
+    },
+    {
+        creationPath: "ddic/ddlx/sources",
+        label: "CDS metadata extensions",
+        nameSpace: 'xmlns:ddlx="http://www.sap.com/adt/ddic/ddlxsources"',
+        rootName: "ddlx:ddlxSource",
+        typeId: "DDLX/EX",
+        validationPath: "ddic/ddlx/sources/validation",
+        maxLen: 30
+    },
+    {
+        creationPath: "ddic/ddla/sources",
+        label: "CDS Annotation definitions",
+        nameSpace: 'xmlns:ddla="http://www.sap.com/adt/ddic/ddlasources"',
+        rootName: "ddla:ddlaSource",
+        typeId: "DDLA/ADF",
+        validationPath: "ddic/ddla/sources/validation",
+        maxLen: 30
+    },
+    {
+        creationPath: "packages",
+        label: "Package",
+        nameSpace: 'xmlns:pak="http://www.sap.com/adt/packages"',
+        rootName: "pak:package",
+        typeId: "DEVC/K",
+        validationPath: "packages/validation",
+        maxLen: 30
+    },
+    {
+        creationPath: "ddic/tables",
+        label: "Table",
+        nameSpace: 'xmlns:blue="http://www.sap.com/wbobj/blue"',
+        rootName: "blue:blueSource",
+        typeId: "TABL/DT",
+        validationPath: "ddic/tables/validation",
+        maxLen: 16
+    },
+    {
+        creationPath: "ddic/srvd/sources",
+        label: "Service definition",
+        nameSpace: 'xmlns:srvd="http://www.sap.com/adt/ddic/srvdsources"',
+        rootName: "srvd:srvdSource",
+        typeId: "SRVD/SRV",
+        validationPath: "ddic/srvd/sources/validation",
+        extra: `srvd:srvdSourceType="S"`,
+        maxLen: 30
+    },
+    {
+        creationPath: "aps/iam/auth",
+        rootName: "auth:auth",
+        nameSpace: 'xmlns:auth="http://www.sap.com/iam/auth"',
+        label: "Authorization field",
+        typeId: "AUTH",
+        validationPath: "aps/iam/auth/validation",
+        maxLen: 10
+    },
+    {
+        creationPath: "aps/iam/suso",
+        validationPath: "aps/iam/suso/validation",
+        rootName: "susob:suso",
+        nameSpace: `xmlns:susob="http://www.sap.com/iam/suso"`,
+        label: "Authorization object",
+        typeId: "SUSO/B",
+        maxLen: 10
+    },
+    {
+        creationPath: "ddic/dataelements",
+        validationPath: "ddic/dataelements/validation",
+        rootName: "blue:wbobj",
+        nameSpace: 'xmlns:blue="http://www.sap.com/wbobj/dictionary/dtel"',
+        label: "Data Element",
+        typeId: "DTEL/DE",
+        maxLen: 30
+    },
+    {
+        creationPath: "businessservices/bindings",
+        validationPath: "businessservices/bindings/validation",
+        rootName: "srvb:serviceBinding",
+        nameSpace: 'xmlns:srvb="http://www.sap.com/adt/ddic/ServiceBindings"',
+        label: "Service binding",
+        typeId: "SRVB/SVB",
+        maxLen: 26
+    },
+    {
+        creationPath: "messageclass",
+        validationPath: "messageclass/validation",
+        rootName: "mc:messageClass",
+        nameSpace: `xmlns:mc="http://www.sap.com/adt/MessageClass"`,
+        label: "Message class",
+        typeId: "MSAG/N",
+        maxLen: 20
+    }
+];
+ctypes.forEach(v => exports.CreatableTypes.set(v.typeId, v));

package/build/api/objectstructure.d.ts

@@ -0,0 +1,71 @@
+import { AdtHTTP } from "../AdtHTTP";
+export type ObjectVersion = "active" | "inactive" | "workingArea";
+export interface GenericMetaData {
+    "abapsource:activeUnicodeCheck"?: boolean;
+    "abapsource:fixPointArithmetic"?: boolean;
+    "abapsource:sourceUri"?: string;
+    "adtcore:changedAt": number;
+    "adtcore:changedBy": string;
+    "adtcore:createdAt": number;
+    "adtcore:description"?: string;
+    "adtcore:descriptionTextLimit"?: number;
+    "adtcore:language": string;
+    "adtcore:masterLanguage"?: string;
+    "adtcore:masterSystem"?: string;
+    "adtcore:name": string;
+    "adtcore:responsible": string;
+    "adtcore:type": string;
+    "adtcore:version": string;
+}
+export interface ProgramMetaData extends GenericMetaData {
+    "program:lockedByEditor": boolean;
+    "program:programType": string;
+}
+export interface FunctionGroupMetaData extends GenericMetaData {
+    "group:lockedByEditor": boolean;
+}
+export interface ClassMetaData extends GenericMetaData {
+    "abapoo:modeled": boolean;
+    "class:abstract": boolean;
+    "class:category": string;
+    "class:final": boolean;
+    "class:sharedMemoryEnabled": boolean;
+    "class:visibility": string;
+}
+export interface Link {
+    etag?: number;
+    href: string;
+    rel: string;
+    type?: string;
+    title?: string;
+}
+export type classIncludes = "definitions" | "implementations" | "macros" | "testclasses" | "main";
+export interface ClassInclude {
+    "abapsource:sourceUri": string;
+    "adtcore:changedAt": number;
+    "adtcore:changedBy": string;
+    "adtcore:createdAt": number;
+    "adtcore:createdBy": string;
+    "adtcore:name": string;
+    "adtcore:type": string;
+    "adtcore:version": string;
+    "class:includeType": classIncludes;
+    links: Link[];
+}
+export type AbapMetaData = GenericMetaData | ProgramMetaData | FunctionGroupMetaData | ClassMetaData;
+export interface AbapSimpleStructure {
+    objectUrl: string;
+    metaData: AbapMetaData;
+    links: Link[];
+}
+export interface AbapClassStructure {
+    objectUrl: string;
+    metaData: ClassMetaData;
+    links?: Link[];
+    includes: ClassInclude[];
+}
+export type AbapObjectStructure = AbapSimpleStructure | AbapClassStructure;
+export declare function isClassMetaData(meta: AbapMetaData): meta is ClassMetaData;
+export declare function isClassStructure(struc: AbapObjectStructure): struc is AbapClassStructure;
+export declare function objectStructure(h: AdtHTTP, objectUrl: string, version?: ObjectVersion): Promise<AbapObjectStructure>;
+//# sourceMappingURL=objectstructure.d.ts.map

package/build/api/objectstructure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objectstructure.d.ts","sourceRoot":"","sources":["../../src/api/objectstructure.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAGpC,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAA;AAEjE,MAAM,WAAW,eAAe;IAC9B,+BAA+B,CAAC,EAAE,OAAO,CAAA;IACzC,+BAA+B,CAAC,EAAE,OAAO,CAAA;IACzC,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,8BAA8B,CAAC,EAAE,MAAM,CAAA;IACvC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,cAAc,EAAE,MAAM,CAAA;IACtB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,cAAc,EAAE,MAAM,CAAA;IACtB,iBAAiB,EAAE,MAAM,CAAA;CAC1B;AAED,MAAM,WAAW,eAAgB,SAAQ,eAAe;IACtD,wBAAwB,EAAE,OAAO,CAAA;IACjC,qBAAqB,EAAE,MAAM,CAAA;CAC9B;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,sBAAsB,EAAE,OAAO,CAAA;CAChC;AAED,MAAM,WAAW,aAAc,SAAQ,eAAe;IACpD,gBAAgB,EAAE,OAAO,CAAA;IACzB,gBAAgB,EAAE,OAAO,CAAA;IACzB,gBAAgB,EAAE,MAAM,CAAA;IACxB,aAAa,EAAE,OAAO,CAAA;IACtB,2BAA2B,EAAE,OAAO,CAAA;IACpC,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,IAAI;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AACD,MAAM,MAAM,aAAa,GACrB,aAAa,GACb,iBAAiB,GACjB,QAAQ,GACR,aAAa,GACb,MAAM,CAAA;AACV,MAAM,WAAW,YAAY;IAC3B,sBAAsB,EAAE,MAAM,CAAA;IAC9B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,cAAc,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,iBAAiB,EAAE,MAAM,CAAA;IACzB,mBAAmB,EAAE,aAAa,CAAA;IAClC,KAAK,EAAE,IAAI,EAAE,CAAA;CACd;AACD,MAAM,MAAM,YAAY,GACpB,eAAe,GACf,eAAe,GACf,qBAAqB,GACrB,aAAa,CAAA;AAEjB,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,YAAY,CAAA;IACtB,KAAK,EAAE,IAAI,EAAE,CAAA;CACd;AACD,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,aAAa,CAAA;IACvB,KAAK,CAAC,EAAE,IAAI,EAAE,CAAA;IACd,QAAQ,EAAE,YAAY,EAAE,CAAA;CACzB;AACD,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG,kBAAkB,CAAA;AAC1E,wBAAgB,eAAe,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI,IAAI,aAAa,CAEzE;AACD,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,mBAAmB,GACzB,KAAK,IAAI,kBAAkB,CAE7B;AAOD,wBAAsB,eAAe,CACnC,CAAC,EAAE,OAAO,EACV,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,mBAAmB,CAAC,CAmB9B"}

package/build/api/objectstructure.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectStructure = exports.isClassStructure = exports.isClassMetaData = void 0;
+const AdtException_1 = require("../AdtException");
+const utilities_1 = require("../utilities");
+function isClassMetaData(meta) {
+    return meta["class:visibility"] !== undefined;
+}
+exports.isClassMetaData = isClassMetaData;
+function isClassStructure(struc) {
+    return isClassMetaData(struc.metaData);
+}
+exports.isClassStructure = isClassStructure;
+const convertIncludes = (i) => {
+    const imeta = (0, utilities_1.xmlNodeAttr)(i);
+    const links = i["atom:link"].map(utilities_1.xmlNodeAttr);
+    return { ...imeta, links };
+};
+async function objectStructure(h, objectUrl, version) {
+    (0, AdtException_1.ValidateObjectUrl)(objectUrl);
+    const qs = version ? { version } : {};
+    const response = await h.request(objectUrl, { qs });
+    const res = (0, utilities_1.fullParse)(response.body);
+    // return type depends on object type, but always have a single root
+    const root = (0, utilities_1.xmlRoot)(res);
+    const attr = (0, utilities_1.xmlNodeAttr)(root);
+    attr["adtcore:changedAt"] = Date.parse(attr["adtcore:changedAt"]) || 0;
+    attr["adtcore:createdAt"] = Date.parse(attr["adtcore:createdAt"]) || 0;
+    const links = (0, utilities_1.xmlArray)(root, "atom:link").map(utilities_1.xmlNodeAttr);
+    const metaData = attr;
+    if (isClassMetaData(metaData)) {
+        const includes = (0, utilities_1.xmlArray)(root, "class:include").map(convertIncludes);
+        return { objectUrl, metaData, includes, links };
+    }
+    return { objectUrl, metaData, links };
+}
+exports.objectStructure = objectStructure;

package/build/api/refactor.d.ts

@@ -0,0 +1,122 @@
+import { UriParts } from ".";
+import { AdtHTTP } from "../AdtHTTP";
+import { Range } from "./urlparser";
+export interface FixProposal {
+    "adtcore:uri": string;
+    "adtcore:type": string;
+    "adtcore:name": string;
+    "adtcore:description": string;
+    uri: string;
+    line: string;
+    column: string;
+    userContent: string;
+}
+interface TextReplaceDelta {
+    rangeFragment: Range;
+    contentOld: string;
+    contentNew: string;
+}
+interface AffectedObjects {
+    uri: string;
+    type: string;
+    name: string;
+    parentUri: string;
+    userContent: string;
+    textReplaceDeltas: TextReplaceDelta[];
+}
+interface ChangePackageAffectedObject {
+    uri: string;
+    type: string;
+    name: string;
+    oldPackage: string;
+    newPackage: string;
+    parentUri: string;
+    userContent: string;
+}
+export interface ChangePackageRefactoringProposal {
+    oldPackage: string;
+    newPackage: string;
+    transport?: string;
+    title?: string;
+    rootUserContent?: string;
+    ignoreSyntaxErrorsAllowed: boolean;
+    ignoreSyntaxErrors: boolean;
+    adtObjectUri: string;
+    affectedObjects: ChangePackageAffectedObject;
+    userContent: string;
+}
+export interface ChangePackageRefactoring extends ChangePackageRefactoringProposal {
+    transport: string;
+}
+export interface RenameRefactoringProposal {
+    oldName: string;
+    newName: string;
+    transport?: string;
+    title?: string;
+    rootUserContent?: string;
+    ignoreSyntaxErrorsAllowed: boolean;
+    ignoreSyntaxErrors: boolean;
+    adtObjectUri: UriParts;
+    affectedObjects: AffectedObjects[];
+    userContent: string;
+}
+export interface RenameRefactoring extends RenameRefactoringProposal {
+    transport: string;
+}
+interface Exception {
+    name: string;
+    resumable: boolean;
+    userContent: string;
+}
+interface Parameter {
+    id: string;
+    name: string;
+    direction: string;
+    byValue: boolean;
+    typeType: string;
+    type: string;
+    userContent: string;
+}
+export interface GenericRefactoring {
+    title: string;
+    adtObjectUri: UriParts;
+    transport: string;
+    ignoreSyntaxErrorsAllowed: boolean;
+    ignoreSyntaxErrors: boolean;
+    userContent: string;
+    affectedObjects: AffectedObjects[];
+}
+export interface ExtractMethodProposal {
+    name: string;
+    isStatic: boolean;
+    isForTesting: boolean;
+    visibility: string;
+    classBasedExceptions: boolean;
+    genericRefactoring: GenericRefactoring;
+    content: string;
+    className: string;
+    isEventAllowed: boolean;
+    isEvent: boolean;
+    userContent: string;
+    parameters: Parameter[];
+    exceptions: Exception[];
+}
+export declare function fixProposals(h: AdtHTTP, uri: string, body: string, line: number, column: number): Promise<FixProposal[]>;
+export interface Delta {
+    uri: string;
+    range: Range;
+    name: string;
+    type: string;
+    content: string;
+}
+export declare function fixEdits(h: AdtHTTP, proposal: FixProposal, source: string): Promise<Delta[]>;
+export declare function renameEvaluate(h: AdtHTTP, uri: string, line: number, startColumn: number, endColumn: number): Promise<RenameRefactoringProposal>;
+export declare function changePackagePreview(h: AdtHTTP, changePackageRefactoring: ChangePackageRefactoring, transport: string): Promise<ChangePackageRefactoring>;
+export declare function changePackageExecute(h: AdtHTTP, packagename: ChangePackageRefactoring): Promise<ChangePackageRefactoring>;
+export declare function renamePreview(h: AdtHTTP, renameRefactoring: RenameRefactoringProposal, transport: string): Promise<RenameRefactoring>;
+export declare function renameExecute(h: AdtHTTP, rename: RenameRefactoring): Promise<RenameRefactoring>;
+export declare function extractMethodEvaluate(h: AdtHTTP, uri: string, range: Range): Promise<ExtractMethodProposal>;
+export declare function extractMethodPreview(h: AdtHTTP, proposal: ExtractMethodProposal): Promise<GenericRefactoring>;
+export declare function extractMethodExecute(h: AdtHTTP, refactoring: GenericRefactoring): Promise<GenericRefactoring>;
+export {};
+//# sourceMappingURL=refactor.d.ts.map

package/build/api/refactor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"refactor.d.ts","sourceRoot":"","sources":["../../src/api/refactor.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,QAAQ,EAAE,MAAM,GAAG,CAAA;AAE3C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAQpC,OAAO,EAAY,KAAK,EAAoB,MAAM,aAAa,CAAA;AAE/D,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;CACpB;AACD,UAAU,gBAAgB;IACxB,aAAa,EAAE,KAAK,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB;AACD,UAAU,eAAe;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,iBAAiB,EAAE,gBAAgB,EAAE,CAAA;CACtC;AACD,UAAU,2BAA2B;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,gCAAgC;IAC7C,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yBAAyB,EAAE,OAAO,CAAC;IACnC,kBAAkB,EAAE,OAAO,CAAC;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,2BAA2B,CAAC;IAC7C,WAAW,EAAE,MAAM,CAAC;CACvB;AACD,MAAM,WAAW,wBAAyB,SAAQ,gCAAgC;IAC9E,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,yBAAyB,EAAE,OAAO,CAAA;IAClC,kBAAkB,EAAE,OAAO,CAAA;IAC3B,YAAY,EAAE,QAAQ,CAAA;IACtB,eAAe,EAAE,eAAe,EAAE,CAAA;IAClC,WAAW,EAAE,MAAM,CAAA;CACpB;AACD,MAAM,WAAW,iBAAkB,SAAQ,yBAAyB;IAClE,SAAS,EAAE,MAAM,CAAA;CAClB;AACD,UAAU,SAAS;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,OAAO,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,UAAU,SAAS;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,QAAQ,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,yBAAyB,EAAE,OAAO,CAAA;IAClC,kBAAkB,EAAE,OAAO,CAAA;IAC3B,WAAW,EAAE,MAAM,CAAA;IACnB,eAAe,EAAE,eAAe,EAAE,CAAA;CACnC;AACD,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,YAAY,EAAE,OAAO,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,kBAAkB,EAAE,kBAAkB,CAAA;IACtC,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,OAAO,CAAA;IACvB,OAAO,EAAE,OAAO,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,UAAU,EAAE,SAAS,EAAE,CAAA;CACxB;AAED,wBAAsB,YAAY,CAChC,CAAC,EAAE,OAAO,EACV,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,EAAE,CAAC,CA0BxB;AACD,MAAM,WAAW,KAAK;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,KAAK,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;CAChB;AACD,wBAAsB,QAAQ,CAC5B,CAAC,EAAE,OAAO,EACV,QAAQ,EAAE,WAAW,EACrB,MAAM,EAAE,MAAM,oBAuCf;AA8HD,wBAAsB,cAAc,CAClC,CAAC,EAAE,OAAO,EACV,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,yBAAyB,CAAC,CAepC;AAyQD,wBAAsB,oBAAoB,CAAC,CAAC,EAAE,OAAO,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAkB/J;AAED,wBAAsB,oBAAoB,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAiB/H;AAED,wBAAsB,aAAa,CACjC,CAAC,EAAE,OAAO,EACV,iBAAiB,EAAE,yBAAyB,EAC5C,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,iBAAiB,CAAC,CAgB5B;AAED,wBAAsB,aAAa,CACjC,CAAC,EAAE,OAAO,EACV,MAAM,EAAE,iBAAiB,GACxB,OAAO,CAAC,iBAAiB,CAAC,CAiB5B;AAED,wBAAsB,qBAAqB,CACzC,CAAC,EAAE,OAAO,EACV,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,qBAAqB,CAAC,CAYhC;AAED,wBAAsB,oBAAoB,CACxC,CAAC,EAAE,OAAO,EACV,QAAQ,EAAE,qBAAqB,GAC9B,OAAO,CAAC,kBAAkB,CAAC,CAa7B;AAED,wBAAsB,oBAAoB,CACxC,CAAC,EAAE,OAAO,EACV,WAAW,EAAE,kBAAkB,+BAWhC"}