@j-schreiber/sf-cli-security-audit 0.4.0 → 0.5.0

package/lib/libs/core/classification-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"classification-types.js","sourceRoot":"","sources":["../../../src/libs/core/classification-types.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,mBAaX;AAbD,WAAY,mBAAmB;IAC7B,+EAA+E;IAC/E,0CAAmB,CAAA;IACnB,6DAA6D;IAC7D,4CAAqB,CAAA;IACrB,sEAAsE;IACtE,oCAAa,CAAA;IACb,yDAAyD;IACzD,wCAAiB,CAAA;IACjB,qEAAqE;IACrE,kCAAW,CAAA;IACX,kFAAkF;IAClF,0CAAmB,CAAA;AACrB,CAAC,EAbW,mBAAmB,KAAnB,mBAAmB,QAa9B;AAED,MAAM,UAAU,4BAA4B,CAAC,KAAa;IACxD,OAAO,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AACvE,CAAC;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAiC,EAAE,CAAiC,EAAU,EAAE,CACnH,4BAA4B,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,4BAA4B,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC"}

package/lib/libs/{config/queries.js → core/constants.js}

@@ -3,4 +3,4 @@ export const PROFILES_QUERY = 'SELECT Profile.Name,Profile.UserType,IsCustom FRO
 export const PERMISSION_SETS_QUERY = 'SELECT Name,Label,IsCustom,NamespacePrefix FROM PermissionSet WHERE IsOwnedByProfile = FALSE AND NamespacePrefix = NULL';
 export const CONNECTED_APPS_QUERY = 'SELECT Name,OptionsAllowAdminApprovedUsersOnly FROM ConnectedApplication';
 export const OAUTH_TOKEN_QUERY = 'SELECT User.Username,UseCount,AppName FROM OauthToken';
-//# sourceMappingURL=queries.js.map
+//# sourceMappingURL=constants.js.map

package/lib/libs/core/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/libs/core/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,kBAAkB,GAAG,2DAA2D,CAAC;AAC9F,MAAM,CAAC,MAAM,cAAc,GACzB,gGAAgG,CAAC;AACnG,MAAM,CAAC,MAAM,qBAAqB,GAChC,yHAAyH,CAAC;AAC5H,MAAM,CAAC,MAAM,oBAAoB,GAAG,0EAA0E,CAAC;AAC/G,MAAM,CAAC,MAAM,iBAAiB,GAAG,uDAAuD,CAAC"}

package/lib/libs/{config/audit-run → core/file-mgmt}/auditConfigFileManager.d.ts

@@ -1,6 +1,24 @@
 import { AuditRunConfig } from './schema.js';
+/**
+ * Loads an audit run config with the default file manager
+ *
+ * @param dirPath
+ * @returns
+ */
 export declare const loadAuditConfig: (dirPath: string) => AuditRunConfig;
+/**
+ * Saves a new or modified audit run config with the default file manager
+ *
+ * @param dirPath
+ * @param conf
+ */
 export declare const saveAuditConfig: (dirPath: string, conf: AuditRunConfig) => void;
+/**
+ * The file manager streamlines initialisation of an audit config from
+ * a source directory and writing updated content back to disk. The directory
+ * structure is configurable, but most of the time using the default file manager
+ * will be enough.
+ */
 export default class AuditConfigFileManager {
     private directoryStructure;
     constructor();
@@ -24,3 +42,4 @@ export default class AuditConfigFileManager {
     private parseSubdir;
     private writeSubdir;
 }
+export declare const DefaultFileManager: AuditConfigFileManager;

package/lib/libs/{config/audit-run → core/file-mgmt}/auditConfigFileManager.js

@@ -1,16 +1,30 @@
 import path from 'node:path';
 import fs from 'node:fs';
 import yaml from 'js-yaml';
-import { isEmpty } from '../../utils.js';
+import { isEmpty } from '../utils.js';
 import { PermissionsConfigFileSchema, PermSetsPolicyFileSchema, PolicyFileSchema, ProfilesPolicyFileSchema, } from './schema.js';
-export const loadAuditConfig = (dirPath) => {
-    const fileManager = new AuditConfigFileManager();
-    return fileManager.parse(dirPath);
-};
+/**
+ * Loads an audit run config with the default file manager
+ *
+ * @param dirPath
+ * @returns
+ */
+export const loadAuditConfig = (dirPath) => DefaultFileManager.parse(dirPath);
+/**
+ * Saves a new or modified audit run config with the default file manager
+ *
+ * @param dirPath
+ * @param conf
+ */
 export const saveAuditConfig = (dirPath, conf) => {
-    const fileManager = new AuditConfigFileManager();
-    fileManager.save(dirPath, conf);
+    DefaultFileManager.save(dirPath, conf);
 };
+/**
+ * The file manager streamlines initialisation of an audit config from
+ * a source directory and writing updated content back to disk. The directory
+ * structure is configurable, but most of the time using the default file manager
+ * will be enough.
+ */
 export default class AuditConfigFileManager {
     directoryStructure;
     constructor() {
@@ -95,4 +109,5 @@ function capitalizeKeys(object) {
     Object.keys(object).forEach((key) => (newObj[`${key[0].toUpperCase()}${key.slice(1)}`] = object[key]));
     return newObj;
 }
+export const DefaultFileManager = new AuditConfigFileManager();
 //# sourceMappingURL=auditConfigFileManager.js.map

package/lib/libs/core/file-mgmt/auditConfigFileManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auditConfigFileManager.js","sourceRoot":"","sources":["../../../../src/libs/core/file-mgmt/auditConfigFileManager.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,SAAS,CAAC;AAE3B,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAGL,2BAA2B,EAC3B,wBAAwB,EACxB,gBAAgB,EAChB,wBAAwB,GACzB,MAAM,aAAa,CAAC;AAUrB;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAe,EAAkB,EAAE,CAAC,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAEtG;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAe,EAAE,IAAoB,EAAQ,EAAE;IAC7E,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AACzC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAsB;IACjC,kBAAkB,CAA4B;IAEtD;QACE,IAAI,CAAC,kBAAkB,GAAG;YACxB,QAAQ,EAAE;gBACR,QAAQ,EAAE;oBACR,MAAM,EAAE,wBAAwB;iBACjC;gBACD,cAAc,EAAE;oBACd,MAAM,EAAE,wBAAwB;iBACjC;gBACD,aAAa,EAAE;oBACb,MAAM,EAAE,gBAAgB;iBACzB;aACF;YACD,eAAe,EAAE;gBACf,eAAe,EAAE;oBACf,MAAM,EAAE,2BAA2B;iBACpC;gBACD,iBAAiB,EAAE;oBACjB,MAAM,EAAE,2BAA2B;iBACpC;aACF;SACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAe;QAC1B,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;QACrE,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;QACvE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACI,IAAI,CAAC,aAAqB,EAAE,IAAoB;QACrD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,EAAE;YACtD,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACrE,IAAI,CAAC,WAAW,CAAC,WAAkD,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;QAC/F,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,WAAW,CAAC,OAAe,EAAE,UAAkB;QACrD,MAAM,YAAY,GAAwC,EAAE,CAAC;QAC7D,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE;YACrF,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,QAAQ,MAAM,CAAC,CAAC;YACnE,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC5B,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;gBAClE,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;gBACrD,YAAY,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;YACjD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,YAAY,CAAC;IACtB,CAAC;IAEO,WAAW,CAAC,WAAgD,EAAE,OAAe,EAAE,aAAqB;QAC1G,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO;QACT,CAAC;QACD,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,EAAE;YAC1D,MAAM,gBAAgB,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1E,MAAM,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;YAC1C,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC1C,6CAA6C;gBAC7C,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,GAAG,gBAAgB,MAAM,CAAC,CAAC;gBACjF,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YACnE,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,SAAS,cAAc,CAAC,MAA+B;IACrD,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACvG,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,sBAAsB,EAAE,CAAC"}

package/lib/libs/{config/audit-run → core/file-mgmt}/schema.d.ts

@@ -1,19 +1,20 @@
 import z from 'zod';
-import { PermissionRiskLevelPresets, PolicyRiskLevel } from '../../policies/types.js';
+import { PermissionRiskLevel } from '../classification-types.js';
+import { ProfilesRiskPreset } from '../policy-types.js';
 declare const PermissionsClassificationSchema: z.ZodObject<{
     label: z.ZodOptional<z.ZodString>;
     reason: z.ZodOptional<z.ZodString>;
-    classification: z.ZodEnum<typeof PolicyRiskLevel>;
+    classification: z.ZodEnum<typeof PermissionRiskLevel>;
 }, z.z.core.$strip>;
 declare const PermsClassificationsMapSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
     label: z.ZodOptional<z.ZodString>;
     reason: z.ZodOptional<z.ZodString>;
-    classification: z.ZodEnum<typeof PolicyRiskLevel>;
+    classification: z.ZodEnum<typeof PermissionRiskLevel>;
 }, z.z.core.$strip>>;
 declare const NamedPermissionsClassificationSchema: z.ZodObject<{
     label: z.ZodOptional<z.ZodString>;
     reason: z.ZodOptional<z.ZodString>;
-    classification: z.ZodEnum<typeof PolicyRiskLevel>;
+    classification: z.ZodEnum<typeof PermissionRiskLevel>;
     name: z.ZodString;
 }, z.z.core.$strip>;
 declare const PolicyRuleConfigSchema: z.ZodObject<{
@@ -25,10 +26,10 @@ declare const RuleMapSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
     config: z.ZodOptional<z.ZodUnknown>;
 }, z.z.core.$strip>>;
 declare const PermSetConfig: z.ZodObject<{
-    preset: z.ZodEnum<typeof PermissionRiskLevelPresets>;
+    preset: z.ZodEnum<typeof ProfilesRiskPreset>;
 }, z.z.core.$strip>;
 declare const PermSetMap: z.ZodRecord<z.ZodString, z.ZodObject<{
-    preset: z.ZodEnum<typeof PermissionRiskLevelPresets>;
+    preset: z.ZodEnum<typeof ProfilesRiskPreset>;
 }, z.z.core.$strip>>;
 export declare const PolicyFileSchema: z.ZodObject<{
     enabled: z.ZodDefault<z.ZodBoolean>;
@@ -44,7 +45,7 @@ export declare const ProfilesPolicyFileSchema: z.ZodObject<{
         config: z.ZodOptional<z.ZodUnknown>;
     }, z.z.core.$strip>>>;
     profiles: z.ZodRecord<z.ZodString, z.ZodObject<{
-        preset: z.ZodEnum<typeof PermissionRiskLevelPresets>;
+        preset: z.ZodEnum<typeof ProfilesRiskPreset>;
     }, z.z.core.$strip>>;
 }, z.z.core.$strip>;
 export declare const PermSetsPolicyFileSchema: z.ZodObject<{
@@ -54,14 +55,14 @@ export declare const PermSetsPolicyFileSchema: z.ZodObject<{
         config: z.ZodOptional<z.ZodUnknown>;
     }, z.z.core.$strip>>>;
     permissionSets: z.ZodRecord<z.ZodString, z.ZodObject<{
-        preset: z.ZodEnum<typeof PermissionRiskLevelPresets>;
+        preset: z.ZodEnum<typeof ProfilesRiskPreset>;
     }, z.z.core.$strip>>;
 }, z.z.core.$strip>;
 export declare const PermissionsConfigFileSchema: z.ZodObject<{
     permissions: z.ZodRecord<z.ZodString, z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         reason: z.ZodOptional<z.ZodString>;
-        classification: z.ZodEnum<typeof PolicyRiskLevel>;
+        classification: z.ZodEnum<typeof PermissionRiskLevel>;
     }, z.z.core.$strip>>;
 }, z.z.core.$strip>;
 export type PermissionsClassification = z.infer<typeof PermissionsClassificationSchema>;

package/lib/libs/{config/audit-run → core/file-mgmt}/schema.js

@@ -1,12 +1,13 @@
 import z from 'zod';
-import { PermissionRiskLevelPresets, PolicyRiskLevel } from '../../policies/types.js';
+import { PermissionRiskLevel } from '../classification-types.js';
+import { ProfilesRiskPreset } from '../policy-types.js';
 const PermissionsClassificationSchema = z.object({
     /** UI Label */
     label: z.string().optional(),
     /** An optional description to explain the classification */
     reason: z.string().optional(),
     /** Risk assessment of the permissions */
-    classification: z.enum(PolicyRiskLevel),
+    classification: z.enum(PermissionRiskLevel),
 });
 const PermsClassificationsMapSchema = z.record(z.string(), PermissionsClassificationSchema);
 const NamedPermissionsClassificationSchema = PermissionsClassificationSchema.extend({
@@ -19,7 +20,7 @@ const PolicyRuleConfigSchema = z.object({
 });
 const RuleMapSchema = z.record(z.string(), PolicyRuleConfigSchema);
 const PermSetConfig = z.object({
-    preset: z.enum(PermissionRiskLevelPresets),
+    preset: z.enum(ProfilesRiskPreset),
 });
 const PermSetMap = z.record(z.string(), PermSetConfig);
 // FILE CONTENT SCHEMATA

package/lib/libs/core/file-mgmt/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../../src/libs/core/file-mgmt/schema.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AACpB,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,eAAe;IACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,4DAA4D;IAC5D,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,yCAAyC;IACzC,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC;CAC5C,CAAC,CAAC;AAEH,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,+BAA+B,CAAC,CAAC;AAE5F,MAAM,oCAAoC,GAAG,+BAA+B,CAAC,MAAM,CAAC;IAClF,yDAAyD;IACzD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IAClC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC,CAAC;AAEnE,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7B,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;CACnC,CAAC,CAAC;AAEH,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,aAAa,CAAC,CAAC;AAEvD,wBAAwB;AAExB,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IAClC,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;CACjC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,wBAAwB,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC9D,QAAQ,EAAE,UAAU;CACrB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,wBAAwB,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC9D,cAAc,EAAE,UAAU;CAC3B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,+BAA+B,CAAC;CACnE,CAAC,CAAC;AA0CH,MAAM,UAAU,mBAAmB,CAAC,GAAY;IAC9C,OAAQ,GAAqC,CAAC,OAAO,EAAE,WAAW,KAAK,SAAS,CAAC;AACnF,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,GAAY;IACzC,OAAQ,GAAyC,CAAC,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC;AACjF,CAAC"}

package/lib/libs/core/mdapi/mdapiRetriever.d.ts

@@ -0,0 +1,52 @@
+import { Connection } from '@salesforce/core';
+import { ConnectedAppSettings, PermissionSet, Profile as ProfileMetadata } from '@jsforce/jsforce-node/lib/api/metadata.js';
+import NamedMetadata from './namedMetadataType.js';
+import SingletonMetadata from './singletonMetadataType.js';
+import NamedMetadataQueryable from './namedMetadataToolingQueryable.js';
+export default class MDAPI {
+    private connection;
+    private cache;
+    constructor(connection: Connection);
+    /**
+     * Resolves one of the pre-configured metadata types and returns
+     * a map of resolved names and entire XML content of source file body.
+     *
+     * @param typeName
+     * @param componentNames
+     * @returns
+     */
+    resolve<K extends keyof typeof NamedTypesRegistry>(typeName: K, componentNames: string[]): Promise<NamedReturnTypes[K]>;
+    /**
+     * Resolves one of the pre-configured metadata types and returns
+     * the entire XML content of source file body.
+     *
+     * @param typeName
+     * @returns
+     */
+    resolveSingleton<K extends keyof typeof SingletonRegistry>(typeName: K): Promise<SingletonReturnTypes[K]>;
+    private cacheResults;
+    private fetchCached;
+}
+export declare const NamedTypesRegistry: {
+    PermissionSet: NamedMetadata<PermissionSetXml, "PermissionSet">;
+    Profile: NamedMetadataQueryable<ProfileXml, "Profile">;
+};
+export declare const SingletonRegistry: {
+    ConnectedAppSettings: SingletonMetadata<ConnectedAppSettingsXml, "ConnectedAppSettings">;
+};
+type NamedReturnTypes = {
+    [K in keyof typeof NamedTypesRegistry]: Awaited<ReturnType<(typeof NamedTypesRegistry)[K]['resolve']>>;
+};
+type SingletonReturnTypes = {
+    [K in keyof typeof SingletonRegistry]: Awaited<ReturnType<(typeof SingletonRegistry)[K]['resolve']>>;
+};
+type ProfileXml = {
+    Profile: ProfileMetadata;
+};
+type PermissionSetXml = {
+    PermissionSet: PermissionSet;
+};
+type ConnectedAppSettingsXml = {
+    ConnectedAppSettings: ConnectedAppSettings;
+};
+export {};

package/lib/libs/core/mdapi/mdapiRetriever.js

@@ -0,0 +1,116 @@
+import { XMLParser } from 'fast-xml-parser';
+import NamedMetadata from './namedMetadataType.js';
+import SingletonMetadata from './singletonMetadataType.js';
+import NamedMetadataQueryable from './namedMetadataToolingQueryable.js';
+export default class MDAPI {
+    connection;
+    cache;
+    constructor(connection) {
+        this.connection = connection;
+        this.cache = new MetadataCache();
+    }
+    /**
+     * Resolves one of the pre-configured metadata types and returns
+     * a map of resolved names and entire XML content of source file body.
+     *
+     * @param typeName
+     * @param componentNames
+     * @returns
+     */
+    async resolve(typeName, componentNames) {
+        const retriever = NamedTypesRegistry[typeName];
+        const { toRetrieve, cached } = this.fetchCached(componentNames);
+        if (toRetrieve.length > 0) {
+            const retrieveResults = await retriever.resolve(this.connection, toRetrieve);
+            this.cacheResults(retrieveResults);
+            return {
+                ...cached,
+                ...retrieveResults,
+            };
+        }
+        return cached;
+    }
+    /**
+     * Resolves one of the pre-configured metadata types and returns
+     * the entire XML content of source file body.
+     *
+     * @param typeName
+     * @returns
+     */
+    async resolveSingleton(typeName) {
+        const retriever = SingletonRegistry[typeName];
+        const { toRetrieve, cached } = this.fetchCached([typeName]);
+        if (toRetrieve.length > 0) {
+            const retrieveResults = await retriever.resolve(this.connection);
+            this.cache.set(typeName, retrieveResults);
+            return retrieveResults;
+        }
+        return cached[typeName];
+    }
+    cacheResults(results) {
+        Object.entries(results).forEach(([cname, mdata]) => {
+            this.cache.set(cname, mdata);
+        });
+    }
+    fetchCached(componentNames) {
+        const toRetrieve = [];
+        const cached = {};
+        for (const cname of componentNames) {
+            if (this.cache.isCached(cname)) {
+                cached[cname] = this.cache.fetch(cname);
+            }
+            else {
+                toRetrieve.push(cname);
+            }
+        }
+        return { toRetrieve, cached };
+    }
+}
+class MetadataCache {
+    components = {};
+    isCached(cmpName) {
+        return this.components[cmpName] !== undefined && this.components[cmpName] !== null;
+    }
+    fetch(cmpName) {
+        if (!this.isCached(cmpName)) {
+            throw new Error('Component not cached. Check first before fetching: ' + cmpName);
+        }
+        return this.components[cmpName];
+    }
+    set(cmpName, content) {
+        this.components[cmpName] = content;
+    }
+}
+export const NamedTypesRegistry = {
+    PermissionSet: new NamedMetadata({
+        retrieveType: 'PermissionSet',
+        rootNodeName: 'PermissionSet',
+        parser: new XMLParser({
+            isArray: (jpath) => ['userPermissions', 'fieldPermissions', 'customPermissions', 'classAccesses'].includes(jpath),
+        }),
+        parsePostProcessor: (parseResult) => ({
+            ...parseResult,
+            userPermissions: parseResult.userPermissions ?? [],
+            customPermissions: parseResult.customPermissions ?? [],
+            classAccesses: parseResult.classAccesses ?? [],
+        }),
+    }),
+    Profile: new NamedMetadataQueryable({
+        objectName: 'Profile',
+        nameField: 'Name',
+        parsePostProcessor: (parseResult) => ({
+            ...parseResult,
+            userPermissions: parseResult.userPermissions ?? [],
+            customPermissions: parseResult.customPermissions ?? [],
+            classAccesses: parseResult.classAccesses ?? [],
+        }),
+    }),
+};
+export const SingletonRegistry = {
+    ConnectedAppSettings: new SingletonMetadata({
+        rootNodeName: 'ConnectedAppSettings',
+        retrieveName: 'ConnectedApp',
+        retrieveType: 'Settings',
+    }),
+};
+//# sourceMappingURL=mdapiRetriever.js.map

package/lib/libs/core/mdapi/mdapiRetriever.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mdapiRetriever.js","sourceRoot":"","sources":["../../../../src/libs/core/mdapi/mdapiRetriever.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAO5C,OAAO,aAAa,MAAM,wBAAwB,CAAC;AACnD,OAAO,iBAAiB,MAAM,4BAA4B,CAAC;AAC3D,OAAO,sBAAsB,MAAM,oCAAoC,CAAC;AAExE,MAAM,CAAC,OAAO,OAAO,KAAK;IAGG;IAFnB,KAAK,CAAgB;IAE7B,YAA2B,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;QAC/C,IAAI,CAAC,KAAK,GAAG,IAAI,aAAa,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO,CAClB,QAAW,EACX,cAAwB;QAExB,MAAM,SAAS,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAC/C,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QAChE,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,eAAe,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAC7E,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;YACnC,OAAO;gBACL,GAAG,MAAM;gBACT,GAAG,eAAe;aACI,CAAC;QAC3B,CAAC;QACD,OAAO,MAA6B,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,gBAAgB,CAC3B,QAAW;QAEX,MAAM,SAAS,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAC9C,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC5D,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,eAAe,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACjE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;YAC1C,OAAO,eAA0C,CAAC;QACpD,CAAC;QACD,OAAO,MAAM,CAAC,QAAQ,CAA4B,CAAC;IACrD,CAAC;IAEO,YAAY,CAAC,OAAiC;QACpD,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE;YACjD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,WAAW,CAAC,cAAwB;QAC1C,MAAM,UAAU,GAAG,EAAE,CAAC;QACtB,MAAM,MAAM,GAA6B,EAAE,CAAC;QAC5C,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE,CAAC;YACnC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACzB,CAAC;QACH,CAAC;QACD,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;IAChC,CAAC;CACF;AAED,MAAM,aAAa;IACT,UAAU,GAA6B,EAAE,CAAC;IAE3C,QAAQ,CAAC,OAAe;QAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IACrF,CAAC;IAEM,KAAK,CAAC,OAAe;QAC1B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,qDAAqD,GAAG,OAAO,CAAC,CAAC;QACnF,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAEM,GAAG,CAAC,OAAe,EAAE,OAAiB;QAC3C,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;IACrC,CAAC;CACF;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,aAAa,EAAE,IAAI,aAAa,CAAoC;QAClE,YAAY,EAAE,eAAe;QAC7B,YAAY,EAAE,eAAe;QAC7B,MAAM,EAAE,IAAI,SAAS,CAAC;YACpB,OAAO,EAAE,CAAC,KAAK,EAAW,EAAE,CAC1B,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,eAAe,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;SAChG,CAAC;QACF,kBAAkB,EAAE,CAAC,WAAW,EAAiB,EAAE,CAAC,CAAC;YACnD,GAAG,WAAW;YACd,eAAe,EAAE,WAAW,CAAC,eAAe,IAAI,EAAE;YAClD,iBAAiB,EAAE,WAAW,CAAC,iBAAiB,IAAI,EAAE;YACtD,aAAa,EAAE,WAAW,CAAC,aAAa,IAAI,EAAE;SAC/C,CAAC;KACH,CAAC;IACF,OAAO,EAAE,IAAI,sBAAsB,CAAwB;QACzD,UAAU,EAAE,SAAS;QACrB,SAAS,EAAE,MAAM;QACjB,kBAAkB,EAAE,CAAC,WAAW,EAAmB,EAAE,CAAC,CAAC;YACrD,GAAG,WAAW;YACd,eAAe,EAAE,WAAW,CAAC,eAAe,IAAI,EAAE;YAClD,iBAAiB,EAAE,WAAW,CAAC,iBAAiB,IAAI,EAAE;YACtD,aAAa,EAAE,WAAW,CAAC,aAAa,IAAI,EAAE;SAC/C,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,oBAAoB,EAAE,IAAI,iBAAiB,CAAkD;QAC3F,YAAY,EAAE,sBAAsB;QACpC,YAAY,EAAE,cAAc;QAC5B,YAAY,EAAE,UAAU;KACzB,CAAC;CACH,CAAC"}

package/lib/libs/core/mdapi/metadataRegistryEntry.d.ts

@@ -0,0 +1,39 @@
+import { PathLike } from 'node:fs';
+import { XMLParser } from 'fast-xml-parser';
+import { ComponentSet, RetrieveResult } from '@salesforce/source-deploy-retrieve';
+import { Connection } from '@salesforce/core';
+export type MetadataRegistryEntryOpts<Type, Key extends keyof Type> = {
+    /**
+     * Metadata API name of the type.
+     */
+    retrieveType: string;
+    /**
+     * Metadata API name entity.
+     */
+    retrieveName?: string;
+    /**
+     * Optional XML parser instance. Typically used to fix errors for
+     * properties that must be parsed as list.
+     */
+    parser?: XMLParser;
+    /**
+     * Name of the root node in XML file content
+     */
+    rootNodeName: Key;
+    /**
+     * Post processor function that sanitises the XML parse result
+     */
+    parsePostProcessor?: (parseResult: Type[Key]) => Type[Key];
+};
+export type NamedMetadataResolver<Type> = {
+    resolve(con: Connection, componentNames: string[]): Promise<Record<string, Type>>;
+};
+export default abstract class MetadataRegistryEntry<Type, Key extends keyof Type> {
+    private opts;
+    parser: XMLParser;
+    retrieveType: string;
+    rootNodeName: Key;
+    constructor(opts: MetadataRegistryEntryOpts<Type, Key>);
+    parse(fullFilePath: PathLike): Type[Key];
+}
+export declare function retrieve(compSet: ComponentSet, con: Connection): Promise<RetrieveResult>;

package/lib/libs/core/mdapi/metadataRegistryEntry.js

@@ -0,0 +1,31 @@
+import { readFileSync } from 'node:fs';
+import { XMLParser } from 'fast-xml-parser';
+export default class MetadataRegistryEntry {
+    opts;
+    parser;
+    retrieveType;
+    rootNodeName;
+    constructor(opts) {
+        this.opts = opts;
+        this.retrieveType = this.opts.retrieveType;
+        this.parser = this.opts.parser ?? new XMLParser();
+        this.rootNodeName = this.opts.rootNodeName;
+    }
+    parse(fullFilePath) {
+        const fileContent = readFileSync(fullFilePath, 'utf-8');
+        const parsedContent = this.parser.parse(fileContent);
+        if (this.opts.parsePostProcessor) {
+            return this.opts.parsePostProcessor(parsedContent[this.rootNodeName]);
+        }
+        return parsedContent[this.rootNodeName];
+    }
+}
+export async function retrieve(compSet, con) {
+    const retrieveRequest = await compSet.retrieve({
+        usernameOrConnection: con,
+        output: '.jsc/retrieves',
+    });
+    const retrieveResult = await retrieveRequest.pollStatus();
+    return retrieveResult;
+}
+//# sourceMappingURL=metadataRegistryEntry.js.map

package/lib/libs/core/mdapi/metadataRegistryEntry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadataRegistryEntry.js","sourceRoot":"","sources":["../../../../src/libs/core/mdapi/metadataRegistryEntry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,YAAY,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAgC5C,MAAM,CAAC,OAAO,OAAgB,qBAAqB;IAKtB;IAJpB,MAAM,CAAY;IAClB,YAAY,CAAS;IACrB,YAAY,CAAM;IAEzB,YAA2B,IAA0C;QAA1C,SAAI,GAAJ,IAAI,CAAsC;QACnE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,YAAsB;QACjC,MAAM,WAAW,GAAG,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACxD,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAS,CAAC;QAC7D,IAAI,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QACxE,CAAC;QACD,OAAO,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC1C,CAAC;CACF;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,OAAqB,EAAE,GAAe;IACnE,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC;QAC7C,oBAAoB,EAAE,GAAG;QACzB,MAAM,EAAE,gBAAgB;KACzB,CAAC,CAAC;IACH,MAAM,cAAc,GAAG,MAAM,eAAe,CAAC,UAAU,EAAE,CAAC;IAC1D,OAAO,cAAc,CAAC;AACxB,CAAC"}

package/lib/libs/core/mdapi/namedMetadataToolingQueryable.d.ts

@@ -0,0 +1,33 @@
+import { Connection } from '@salesforce/core';
+import { NamedMetadataResolver } from './metadataRegistryEntry.js';
+export type NamedMetadataQueryableOpts<Type> = {
+    /**
+     * Object API name to retrieve. Must be available in tooling API
+     */
+    objectName: string;
+    /**
+     * Unique name field that is used to retrieve the object
+     */
+    nameField: string;
+    /**
+     * Post processor function that sanitises the XML parse result
+     */
+    parsePostProcessor?: (parseResult: Type) => Type;
+};
+/**
+ * The entry is a typical named metadata that is organized in a dedicated source folder
+ * where all entities have the same format. The components are queries from tooling API
+ * and organized by their developer name.
+ */
+export default class NamedMetadataQueryable<Type, Key extends keyof Type> implements NamedMetadataResolver<Type[Key]> {
+    private opts;
+    constructor(opts: NamedMetadataQueryableOpts<Type[Key]>);
+    /**
+     * Resolves a set of component names by querying "Metadata" property from tooling API
+     *
+     * @param con
+     * @param componentNames
+     * @returns
+     */
+    resolve(con: Connection, componentNames: string[]): Promise<Record<string, Type[Key]>>;
+}

package/lib/libs/core/mdapi/namedMetadataToolingQueryable.js

@@ -0,0 +1,41 @@
+import { isNullish } from '../utils.js';
+/**
+ * The entry is a typical named metadata that is organized in a dedicated source folder
+ * where all entities have the same format. The components are queries from tooling API
+ * and organized by their developer name.
+ */
+export default class NamedMetadataQueryable {
+    opts;
+    constructor(opts) {
+        this.opts = opts;
+    }
+    /**
+     * Resolves a set of component names by querying "Metadata" property from tooling API
+     *
+     * @param con
+     * @param componentNames
+     * @returns
+     */
+    async resolve(con, componentNames) {
+        const pendingQueries = new Array();
+        componentNames.forEach((cname) => {
+            const qr = Promise.resolve(con.tooling.query(`SELECT ${this.opts.nameField},Metadata FROM ${this.opts.objectName} WHERE ${this.opts.nameField} = '${cname}'`));
+            pendingQueries.push(qr);
+        });
+        const queryResults = await Promise.all(pendingQueries);
+        const resultMap = {};
+        queryResults.forEach((qr) => {
+            if (qr.totalSize > 0) {
+                const record = qr.records[0];
+                const identifier = record[this.opts.nameField];
+                if (identifier && !isNullish(record.Metadata)) {
+                    resultMap[identifier] = this.opts.parsePostProcessor
+                        ? this.opts.parsePostProcessor(record.Metadata)
+                        : record.Metadata;
+                }
+            }
+        });
+        return resultMap;
+    }
+}
+//# sourceMappingURL=namedMetadataToolingQueryable.js.map

package/lib/libs/core/mdapi/namedMetadataToolingQueryable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"namedMetadataToolingQueryable.js","sourceRoot":"","sources":["../../../../src/libs/core/mdapi/namedMetadataToolingQueryable.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAoBxC;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAsB;IACd;IAA3B,YAA2B,IAA2C;QAA3C,SAAI,GAAJ,IAAI,CAAuC;IAAG,CAAC;IAC1E;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,CAAC,GAAe,EAAE,cAAwB;QAC5D,MAAM,cAAc,GAAG,IAAI,KAAK,EAAmD,CAAC;QACpF,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC/B,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CACxB,GAAG,CAAC,OAAO,CAAC,KAAK,CACf,UAAU,IAAI,CAAC,IAAI,CAAC,SAAS,kBAAkB,IAAI,CAAC,IAAI,CAAC,UAAU,UAAU,IAAI,CAAC,IAAI,CAAC,SAAS,OAAO,KAAK,GAAG,CAChH,CACF,CAAC;YACF,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACvD,MAAM,SAAS,GAA8B,EAAE,CAAC;QAChD,YAAY,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;YAC1B,IAAI,EAAE,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC;gBACrB,MAAM,MAAM,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBAC7B,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAW,CAAC;gBACzD,IAAI,UAAU,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC9C,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB;wBAClD,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC;wBAC/C,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;gBACtB,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}

package/lib/libs/core/mdapi/namedMetadataType.d.ts

@@ -0,0 +1,20 @@
+import { Connection } from '@salesforce/core';
+import MetadataRegistryEntry, { MetadataRegistryEntryOpts } from './metadataRegistryEntry.js';
+/**
+ * The entry is a typical named metadata that is organized in a dedicated source folder
+ * where all entities have the same format. The components are retrieved and organized
+ * by their developer name.
+ */
+export default class NamedMetadata<Type, Key extends keyof Type> extends MetadataRegistryEntry<Type, Key> {
+    constructor(opts: MetadataRegistryEntryOpts<Type, Key>);
+    /**
+     * Resolves component names, retrieves the metadata and returns
+     * as a strongly typed result.
+     *
+     * @param con
+     * @param componentNames
+     * @returns
+     */
+    resolve(con: Connection, componentNames: string[]): Promise<Record<string, Type[Key]>>;
+    private parseSourceFiles;
+}

package/lib/libs/core/mdapi/namedMetadataType.js

@@ -0,0 +1,36 @@
+import { ComponentSet } from '@salesforce/source-deploy-retrieve';
+import MetadataRegistryEntry, { retrieve } from './metadataRegistryEntry.js';
+/**
+ * The entry is a typical named metadata that is organized in a dedicated source folder
+ * where all entities have the same format. The components are retrieved and organized
+ * by their developer name.
+ */
+export default class NamedMetadata extends MetadataRegistryEntry {
+    constructor(opts) {
+        super(opts);
+    }
+    /**
+     * Resolves component names, retrieves the metadata and returns
+     * as a strongly typed result.
+     *
+     * @param con
+     * @param componentNames
+     * @returns
+     */
+    async resolve(con, componentNames) {
+        const cmpSet = new ComponentSet(componentNames.map((cname) => ({ type: this.retrieveType, fullName: cname })));
+        const retrieveResult = await retrieve(cmpSet, con);
+        return this.parseSourceFiles(retrieveResult.components, componentNames);
+    }
+    parseSourceFiles(componentSet, retrievedNames) {
+        const cmps = componentSet.getSourceComponents().toArray();
+        const result = {};
+        cmps.forEach((sourceComponent) => {
+            if (sourceComponent.xml && retrievedNames.includes(sourceComponent.name)) {
+                result[sourceComponent.name] = this.parse(sourceComponent.xml);
+            }
+        });
+        return result;
+    }
+}
+//# sourceMappingURL=namedMetadataType.js.map

package/lib/libs/core/mdapi/namedMetadataType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"namedMetadataType.js","sourceRoot":"","sources":["../../../../src/libs/core/mdapi/namedMetadataType.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,qBAAqB,EAAE,EAA6B,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAExG;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,aAA4C,SAAQ,qBAAgC;IACvG,YAAmB,IAA0C;QAC3D,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IACD;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO,CAAC,GAAe,EAAE,cAAwB;QAC5D,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QAC/G,MAAM,cAAc,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,gBAAgB,CAAC,cAAc,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IAC1E,CAAC;IAEO,gBAAgB,CAAC,YAA0B,EAAE,cAAwB;QAC3E,MAAM,IAAI,GAAG,YAAY,CAAC,mBAAmB,EAAE,CAAC,OAAO,EAAE,CAAC;QAC1D,MAAM,MAAM,GAA8B,EAAE,CAAC;QAC7C,IAAI,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;YAC/B,IAAI,eAAe,CAAC,GAAG,IAAI,cAAc,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzE,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;YACjE,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/lib/libs/core/mdapi/singletonMetadataType.d.ts

@@ -0,0 +1,21 @@
+import { Connection } from '@salesforce/core';
+import MetadataRegistryEntry, { MetadataRegistryEntryOpts } from './metadataRegistryEntry.js';
+/**
+ * The entry is a type that only has one single instance on the org, such as
+ * a Setting. The component is typically retrieved by a more generic name and
+ * organized & cached by the explicit name.
+ */
+export default class SingletonMetadata<Type, Key extends keyof Type> extends MetadataRegistryEntry<Type, Key> {
+    retrieveName: string;
+    constructor(opts: MetadataRegistryEntryOpts<Type, Key>);
+    /**
+     * Resolves component names, retrieves the metadata and returns
+     * as a strongly typed result.
+     *
+     * @param con
+     * @param componentNames
+     * @returns
+     */
+    resolve(con: Connection): Promise<Type[Key]>;
+    private parseSourceFile;
+}

package/lib/libs/core/mdapi/singletonMetadataType.js

@@ -0,0 +1,35 @@
+import { ComponentSet } from '@salesforce/source-deploy-retrieve';
+import MetadataRegistryEntry, { retrieve } from './metadataRegistryEntry.js';
+/**
+ * The entry is a type that only has one single instance on the org, such as
+ * a Setting. The component is typically retrieved by a more generic name and
+ * organized & cached by the explicit name.
+ */
+export default class SingletonMetadata extends MetadataRegistryEntry {
+    retrieveName;
+    constructor(opts) {
+        super(opts);
+        this.retrieveName = opts.retrieveName ?? String(this.rootNodeName);
+    }
+    /**
+     * Resolves component names, retrieves the metadata and returns
+     * as a strongly typed result.
+     *
+     * @param con
+     * @param componentNames
+     * @returns
+     */
+    async resolve(con) {
+        const cmpSet = new ComponentSet([{ type: this.retrieveType, fullName: this.retrieveName }]);
+        const retrieveResult = await retrieve(cmpSet, con);
+        return this.parseSourceFile(retrieveResult.components);
+    }
+    parseSourceFile(componentSet) {
+        const cmps = componentSet.getSourceComponents({ type: this.retrieveType, fullName: this.retrieveName }).toArray();
+        if (cmps.length > 0 && cmps[0].xml) {
+            return this.parse(cmps[0].xml);
+        }
+        throw new Error('Failed to resolve settings for: ' + this.retrieveName);
+    }
+}
+//# sourceMappingURL=singletonMetadataType.js.map