@salesforce/metadata-enrichment 0.0.13 → 0.0.14

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 (4) hide show
  1. package/lib/schemas/schemas.d.ts +7 -6
  2. package/lib/schemas/schemas.js +14 -13
  3. package/lib/schemas/schemas.js.map +1 -1
  4. package/package.json +1 -1
package/lib/schemas/schemas.d.ts CHANGED
@@ -31,16 +31,17 @@ export type MetadataTypeConfig = {
31
31
  */
32
32
  export declare const DEFAULT_XML_METADATA_SCHEMA: MetadataTypeXmlSchema;
33
33
  /**
34
- * XML metadata schema for CustomObject where enrichment is written within <aiDescriptor> block.
34
+ * XML metadata schema for CustomObject where enrichment is written within an <enrichments> block with <aiDescriptor>.
35
+ * Currently skipUplift and score are not supported in the schema and will be added in the future.
35
36
  *
36
37
  * Example output structure:
37
38
  * ```
38
39
  * <CustomObject>
39
- * <aiDescriptor>
40
- * <skipUplift>false</skipUplift>
41
- * <enrichedDescription>...</enrichedDescription>
42
- * <score>0.95</score>
43
- * </aiDescriptor>
40
+ * <enrichments>
41
+ * <aiDescriptor>
42
+ * <enrichedDescription>...</enrichedDescription>
43
+ * </aiDescriptor>
44
+ * </enrichments>
44
45
  * </CustomObject>
45
46
  * ```
46
47
  */
package/lib/schemas/schemas.js CHANGED
@@ -77,37 +77,38 @@ export const DEFAULT_XML_METADATA_SCHEMA = {
77
77
  isSkipUpliftEnabled(xmlRoot) {
78
78
  const root = xmlRoot;
79
79
  const skipUplift = root.ai?.skipUplift;
80
- return skipUplift === true || String(skipUplift).toLowerCase() === 'true';
80
+ return String(skipUplift).toLowerCase() === 'true';
81
81
  },
82
82
  };
83
83
  /**
84
- * XML metadata schema for CustomObject where enrichment is written within <aiDescriptor> block.
84
+ * XML metadata schema for CustomObject where enrichment is written within an <enrichments> block with <aiDescriptor>.
85
+ * Currently skipUplift and score are not supported in the schema and will be added in the future.
85
86
  *
86
87
  * Example output structure:
87
88
  * ```
88
89
  * <CustomObject>
89
- * <aiDescriptor>
90
- * <skipUplift>false</skipUplift>
91
- * <enrichedDescription>...</enrichedDescription>
92
- * <score>0.95</score>
93
- * </aiDescriptor>
90
+ * <enrichments>
91
+ * <aiDescriptor>
92
+ * <enrichedDescription>...</enrichedDescription>
93
+ * </aiDescriptor>
94
+ * </enrichments>
94
95
  * </CustomObject>
95
96
  * ```
96
97
  */
97
98
  export const CUSTOM_OBJECT_XML_METADATA_SCHEMA = {
98
99
  applyEnrichment(xmlRoot, result) {
99
100
  Object.assign(xmlRoot, {
100
- aiDescriptor: {
101
- skipUplift: 'false',
102
- enrichedDescription: result.description,
103
- score: String(result.descriptionScore),
101
+ enrichments: {
102
+ aiDescriptor: {
103
+ enrichedDescription: result.description,
104
+ },
104
105
  },
105
106
  });
106
107
  },
107
108
  isSkipUpliftEnabled(xmlRoot) {
108
109
  const root = xmlRoot;
109
- const skipUplift = root.aiDescriptor?.skipUplift;
110
- return skipUplift === true || String(skipUplift).toLowerCase() === 'true';
110
+ const skipUplift = root.enrichments?.aiDescriptor?.skipUplift;
111
+ return String(skipUplift).toLowerCase() === 'true';
111
112
  },
112
113
  };
113
114
  //# sourceMappingURL=schemas.js.map
package/lib/schemas/schemas.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../src/schemas/schemas.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAwB5C;;;;;;GAMG;AACH,SAAS,uBAAuB,CAAC,WAAmB;IAClD,MAAM,kBAAkB,GAAG,WAAW;SACnC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;SACtB,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAE3B,2CAA2C;IAC3C,6CAA6C;IAC7C,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC;QACjD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAC7C,CAAC;IAED,0FAA0F;IAC1F,oDAAoD;IACpD,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;QAC3B,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,UAAU;KAC7C,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,yFAAyF;QACzF,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,kBAAkB,SAAS,CAAuC,CAAC;QACxG,OAAO,MAAM,CAAC,IAAI,IAAI,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAC5D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAC7C,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAA0B;IAChE,eAAe,CAAC,OAAO,EAAE,MAAM;QAC7B,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;YACrB,EAAE,EAAE;gBACF,UAAU,EAAE,OAAO;gBACnB,GAAG,uBAAuB,CAAC,MAAM,CAAC,WAAW,CAAC;gBAC9C,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC;aACvC;SACF,CAAC,CAAC;IACL,CAAC;IACD,mBAAmB,CAAC,OAAO;QACzB,MAAM,IAAI,GAAG,OAAqD,CAAC;QACnE,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC;QACvC,OAAO,UAAU,KAAK,IAAI,IAAI,MAAM,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;IAC5E,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAA0B;IACtE,eAAe,CAAC,OAAO,EAAE,MAAM;QAC7B,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;YACrB,YAAY,EAAE;gBACZ,UAAU,EAAE,OAAO;gBACnB,mBAAmB,EAAE,MAAM,CAAC,WAAW;gBACvC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC;aACvC;SACF,CAAC,CAAC;IACL,CAAC;IACD,mBAAmB,CAAC,OAAO;QACzB,MAAM,IAAI,GAAG,OAA+D,CAAC;QAC7E,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC;QACjD,OAAO,UAAU,KAAK,IAAI,IAAI,MAAM,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;IAC5E,CAAC;CACF,CAAC"}
1
+ {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../src/schemas/schemas.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAwB5C;;;;;;GAMG;AACH,SAAS,uBAAuB,CAAC,WAAmB;IAClD,MAAM,kBAAkB,GAAG,WAAW;SACnC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;SACtB,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAE3B,2CAA2C;IAC3C,6CAA6C;IAC7C,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC;QACjD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAC7C,CAAC;IAED,0FAA0F;IAC1F,oDAAoD;IACpD,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;QAC3B,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,UAAU;KAC7C,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,yFAAyF;QACzF,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,kBAAkB,SAAS,CAAuC,CAAC;QACxG,OAAO,MAAM,CAAC,IAAI,IAAI,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAC5D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAC7C,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAA0B;IAChE,eAAe,CAAC,OAAO,EAAE,MAAM;QAC7B,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;YACrB,EAAE,EAAE;gBACF,UAAU,EAAE,OAAO;gBACnB,GAAG,uBAAuB,CAAC,MAAM,CAAC,WAAW,CAAC;gBAC9C,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC;aACvC;SACF,CAAC,CAAC;IACL,CAAC;IACD,mBAAmB,CAAC,OAAO;QACzB,MAAM,IAAI,GAAG,OAAqD,CAAC;QACnE,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC;QACvC,OAAO,MAAM,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;IACrD,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAA0B;IACtE,eAAe,CAAC,OAAO,EAAE,MAAM;QAC7B,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;YACrB,WAAW,EAAE;gBACX,YAAY,EAAE;oBACZ,mBAAmB,EAAE,MAAM,CAAC,WAAW;iBACxC;aACF;SACF,CAAC,CAAC;IACL,CAAC;IACD,mBAAmB,CAAC,OAAO;QACzB,MAAM,IAAI,GAAG,OAAiF,CAAC;QAC/F,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,CAAC;QAC9D,OAAO,MAAM,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;IACrD,CAAC;CACF,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforce/metadata-enrichment",
3
- "version": "0.0.13",
3
+ "version": "0.0.14",
4
4
  "description": "A library for handling metadata enrichment",
5
5
  "author": "Salesforce",
6
6
  "main": "lib/index",