@lwc-bolts/sf2ts 0.0.2 → 0.0.4

package/lib/converts/custom-label.mjs

@@ -0,0 +1,62 @@
+/** @import { Component, ConvertedComponent } from "../index.mjs" */
+import { parseString } from "xml2js";
+import { PositionAwareTextBuilder } from "../util.mjs";
+
+/**
+ *
+ * @param {Component} component
+ * @returns {ConvertedComponent}
+ */
+export function CustomLabel(component) {
+  // generate d.ts
+  /** @type {any} */
+  let labels;
+  parseString(component.content, (error, result) => {
+    if (error) {
+      throw error;
+    }
+    labels = result;
+  });
+  console.log(labels.CustomLabel);
+  const builder = new PositionAwareTextBuilder();
+  getDtsFromLabel(builder, component.content, labels.CustomLabel);
+  return {
+    declarationContent: builder.build(),
+    mapData: builder.getMappings(),
+    ...component,
+  };
+}
+
+/**
+ *
+ * @param {PositionAwareTextBuilder} builder
+ * @param {string} content
+ * @param {any} label
+ */
+export function getDtsFromLabel(builder, content, label) {
+  const labelName = label.fullName[0];
+  const namePosStart =
+    content.indexOf(`<fullName>${labelName}`) + `<fullName>`.length;
+  const namePosEnd = namePosStart + labelName.length;
+
+  builder.addText(`declare module `);
+  builder.addText(
+    `"@salesforce/label/c.${labelName}"`,
+    namePosStart,
+    namePosEnd
+  );
+  builder.addText(
+    ` {
+  /**
+   * @description ${label.shortDescription}
+   */
+  const `
+  );
+  builder.addText(`lbl${label.fullName}`, namePosStart, namePosEnd);
+  builder.addText(
+    ` = '${label.value}';
+  export default lbl${label.fullName};
+}
+`
+  );
+}

package/lib/converts/custom-labels.mjs

@@ -1,5 +1,7 @@
 /** @import { Component, ConvertedComponent } from "../index.mjs" */
 import { parseString } from "xml2js";
+import { PositionAwareTextBuilder } from "../util.mjs";
+import { getDtsFromLabel } from "./custom-label.mjs";
 
 /**
  *
@@ -19,16 +21,14 @@ export function CustomLabels(component) {
   if (!Array.isArray(labels.CustomLabels.labels)) {
     labels.CustomLabels.labels = [labels.CustomLabels.labels];
   }
-  let dec = "";
+
+  const builder = new PositionAwareTextBuilder();
   for (let label of labels.CustomLabels.labels) {
-    dec += `declare module "@salesforce/label/c.${label.fullName}" {
-  /**
-   * @description ${label.shortDescription}
-   */
-  const lbl${label.fullName} = '${label.value}';
-  export default lbl${label.fullName};
-}
-`;
+    getDtsFromLabel(builder, component.content, label);
   }
-  return { declarationContent: dec, mapData: [], ...component };
+  return {
+    declarationContent: builder.build(),
+    mapData: builder.getMappings(),
+    ...component,
+  };
 }

package/lib/converts/custom-object.mjs

@@ -1,5 +1,6 @@
 /** @import { Component, ConvertedComponent } from "../index.mjs" */
 import { parseString } from "xml2js";
+import { PositionAwareTextBuilder } from "../util.mjs";
 
 /**
  *
@@ -17,14 +18,34 @@ export function CustomObject(component) {
     obj = result;
   });
   const objectName = component.path.split("/").pop()?.split(".")[0];
-  const dec = `declare module '@salesforce/schema/${objectName}' {
+  if (!objectName) {
+    throw new Error("Unable to find Object Name");
+  }
+
+  const namePos = component.content.indexOf("<label>") + "<label>".length;
+  const namePosEnd = component.content.indexOf("</label>");
+
+  const builder = new PositionAwareTextBuilder();
+  builder.addText(`declare module `);
+  builder.addText(`"@salesforce/schema/${objectName}"`, namePos, namePosEnd);
+  builder.addText(
+    ` {
   /**
    * @description ${obj.CustomObject.description}
    */
-  const ${objectName}: {
+  const `
+  );
+  builder.addText(`${objectName}`, namePos, namePosEnd);
+  builder.addText(
+    `: {
       objectApiName: '${objectName}';
   }
   export default ${objectName};
-}`;
-  return { declarationContent: dec, mapData: [], ...component };
+}`
+  );
+  return {
+    declarationContent: builder.build(),
+    mapData: builder.getMappings(),
+    ...component,
+  };
 }

package/lib/converts/custom-permission.mjs

@@ -1,5 +1,6 @@
 /** @import { Component, ConvertedComponent } from "../index.mjs" */
 import { parseString } from "xml2js";
+import { PositionAwareTextBuilder } from "../util.mjs";
 
 /**
  *
@@ -7,7 +8,6 @@ import { parseString } from "xml2js";
  * @returns {ConvertedComponent}
  */
 export function CustomPermission(component) {
-  // generate d.ts
   /** @type {any} */
   let perm;
   parseString(component.content, (error, result) => {
@@ -17,14 +17,35 @@ export function CustomPermission(component) {
     perm = result;
   });
   const permName = component.path.split("/").pop()?.split(".")[0];
-  const dec = `declare module "@salesforce/customPermission/${permName}" {
+  const namePosStart = component.content.indexOf("<label>") + "<label>".length;
+  const namePosEnd = component.content.indexOf("</label>");
+
+  const builder = new PositionAwareTextBuilder();
+  builder.addText("declare module ");
+  builder.addText(
+    `"@salesforce/customPermission/${permName}"`,
+    namePosStart,
+    namePosEnd
+  );
+
+  builder.addText(
+    ` {
   /**
    * ${perm.CustomPermission.label}
    *
    * @description ${perm.CustomPermission.description}
    */
-  const has${permName}:boolean;
+  const `
+  );
+  builder.addText(`has${permName}`, namePosStart, namePosEnd);
+  builder.addText(
+    `:boolean;
   export default has${permName};
-}`;
-  return { declarationContent: dec, mapData: [], ...component };
+}`
+  );
+  return {
+    declarationContent: builder.build(),
+    mapData: builder.getMappings(),
+    ...component,
+  };
 }

package/lib/converts/static-resource.mjs

@@ -1,5 +1,6 @@
 /** @import { Component, ConvertedComponent } from "../index.mjs" */
 import { parseString } from "xml2js";
+import { PositionAwareTextBuilder } from "../util.mjs";
 
 /**
  *
@@ -17,13 +18,39 @@ export function StaticResource(component) {
     resource = result;
   });
   const resourceName = component.path.split("/").pop()?.split(".")[0];
-  const dec = `declare module "@salesforce/resourceUrl/${resourceName}" {
+  const namePosStart =
+    component.content.indexOf("<description>") + "<description>".length;
+  const namePosEnd = component.content.indexOf("</description>");
+
+  const builder = new PositionAwareTextBuilder();
+
+  builder.addText("declare module ");
+
+  builder.addText(
+    `"@salesforce/resourceUrl/${resourceName}"`,
+    namePosStart,
+    namePosEnd
+  );
+
+  builder.addText(
+    ` {
   /**
    * @description ${resource.StaticResource.description}
    * @access ${resource.StaticResource.cacheControl}
    */
-  const ${resourceName}:string;
+  const `
+  );
+
+  builder.addText(`${resourceName}`, namePosStart, namePosEnd);
+
+  builder.addText(
+    `:string;
   export default ${resourceName};
-}`;
-  return { declarationContent: dec, mapData: [], ...component };
+}`
+  );
+  return {
+    declarationContent: builder.build(),
+    mapData: builder.getMappings(),
+    ...component,
+  };
 }

package/lib/util.mjs

@@ -0,0 +1,68 @@
+/** @import { MapPair } from "./index.mjs" */
+
+/**
+ * @typedef MapDelta
+ * @property {number | null} sourcePos
+ * @property {number} destDeltaPos
+ */
+
+/**
+ *
+ * @param {MapDelta[]} mappings
+ */
+export function getMappings(mappings) {
+  // increase destination position as an aggregate
+  /** @type {MapPair[]} */
+  let filteredMappings = [];
+  let lastDestPos = 0;
+  mappings.forEach((m) => {
+    m.destDeltaPos += lastDestPos;
+    lastDestPos = m.destDeltaPos;
+    if (m.sourcePos !== null) {
+      filteredMappings.push({
+        sourcePos: m.sourcePos,
+        destPos: m.destDeltaPos,
+      });
+    }
+  });
+  return filteredMappings;
+}
+
+export class PositionAwareTextBuilder {
+  /** @type {MapDelta[]} */
+  mappings = [];
+  /** @type {string[]} */
+  textParts = [];
+
+  lastTextLen = 0;
+
+  /**
+   *
+   * @param {string} text
+   * @param {number?} sourceStartPos
+   * @param {number?} sourceEndPos
+   */
+  addText(text, sourceStartPos = null, sourceEndPos = null) {
+    this.mappings.push({
+      sourcePos: sourceStartPos,
+      destDeltaPos: this.lastTextLen,
+    });
+    this.lastTextLen = text.length;
+    if (sourceEndPos != null) {
+      this.mappings.push({
+        sourcePos: sourceEndPos,
+        destDeltaPos: this.lastTextLen,
+      });
+      this.lastTextLen = 0;
+    }
+    this.textParts.push(text);
+  }
+
+  build() {
+    return this.textParts.join("");
+  }
+
+  getMappings() {
+    return getMappings(this.mappings);
+  }
+}