@3e/sqa-common 6.15.0-3 → 6.16.0-2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +31 -0
  2. package/package.json +1 -1
  3. package/sqa_common.js +1040 -1035
package/index.d.ts CHANGED
@@ -1692,6 +1692,37 @@ declare module '@3e/sqa-common' {
1692
1692
  * @param view - The view to be computed
1693
1693
  */
1694
1694
  getNumberOfDataPoints(view: SQView): Promise<number>
1695
+
1696
+ /**
1697
+ * Convert a Ref Category to a Logical Device Type.
1698
+ *
1699
+ * Returns null if no such conversion is possible.
1700
+ *
1701
+ * @param refCategory - The Ref Category to convert (e.g. nacelles)
1702
+ */
1703
+ convertRefCategoryToLDType(refCategory: string): string | null
1704
+
1705
+ /**
1706
+ * Convert a Logical Device Type to a Ref Category.
1707
+ *
1708
+ * Returns null if no such conversion is possible.
1709
+ *
1710
+ * @param ldType - The Logical Device Type to convert. Accepts both short
1711
+ * form (e.g. 'inverter') or full SQID (e.g. '/sq/ld_type/inverter')
1712
+ */
1713
+ convertLDTypeToRefCategory(ldType: string): string | null
1714
+
1715
+ /**
1716
+ * Make a Ref from an LD Type and a SQID
1717
+ *
1718
+ * Returns null if it is not possible to create a Ref from the
1719
+ * provided data (e.g. when the ldType does not correspond to a Ref Category).
1720
+ *
1721
+ * @param ldType - The Logical Device Type of the object. Accepts both short
1722
+ * form (e.g. 'inverter') or full SQID (e.g. '/sq/ld_type/inverter')
1723
+ * @param sqid - The SQID of the object
1724
+ */
1725
+ refFromLDTypeAndSQID(ldType: string, sqid: string): string | null
1695
1726
  }
1696
1727
 
1697
1728
  export const sqa: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@3e/sqa-common",
3
- "version": "6.15.0-3",
3
+ "version": "6.16.0-2",
4
4
  "description": "SynaptiQ utilities package",
5
5
  "main": "sqa_common.js",
6
6
  "dependencies": {