{"_id":"@aurahelper/xml-definitions","_rev":"3-09587ec2726a51c6c7b00bf5c8bf3534","name":"@aurahelper/xml-definitions","dist-tags":{"latest":"2.0.1"},"versions":{"1.0.0":{"name":"@aurahelper/xml-definitions","productName":"Aura Helper SalesForce XML Definitions","displayName":"Aura Helper Framework SalesForce XML Definitions","version":"1.0.0","description":"Powerfull Libraries to get the XML Definitions of ALL XML Salesforce Metadata Files. Support All API Versions up to API 51.0. You can get the definition of one or more XML files for a specific version of Salesforce. For Example: You can get the XML Defini","main":"index.js","scripts":{"test":"jest --coverage"},"keywords":["aura-helper-framework","aura helper framework","Aura Helper Framework","ah-framework","AH Framework","Aura Helper","aura-helper","AuraHelper Library","AuraHelper Libraries","AH","ah","Salesforce","Salesforce Metadata","Salesforce Apps","Salesforce XML","Salesforce Tools","Apex","force.com","DevOps","devops","sf-xml-definitions","SF XML Definitions","SF XML","xml-definitions","XML Definitions"],"author":{"name":"Juan José Longoria López","email":"juanjoselongoria@gmail.com","url":"Kanko"},"license":"GPLv3","repository":{"type":"git","url":"git+https://github.com/JJLongoria/aura-helper-xml-definitions.git"},"bugs":{"url":"https://github.com/JJLongoria/aura-helper-xml-definitions/issues","email":"juanjoselongoria@gmail.com"},"devDependencies":{"@types/jest":"^26.0.20","jest":"^26.6.3"},"dependencies":{"@aurahelper/core":"^1.0.0"},"gitHead":"a91f47592fcd4f3fb2bff227466c99a3d3458946","homepage":"https://github.com/JJLongoria/aura-helper-xml-definitions#readme","_id":"@aurahelper/xml-definitions@1.0.0","_nodeVersion":"12.15.0","_npmVersion":"7.24.0","dist":{"integrity":"sha512-48Z9knTdLTnG+Lr8F+/b8+H5v813wIPip2Lvk1sQBZL+5P1u4WNXk5Puf/z3WdmfP7XDuvdzQnGSAv+YwqI6Rg==","shasum":"7fa4b085b975bf5aec187b0ed167a715b7b1dcd3","tarball":"https://registry.npmjs.org/@aurahelper/xml-definitions/-/xml-definitions-1.0.0.tgz","fileCount":239,"unpackedSize":980456,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCmMSfJ8PIROJFSfVPu7oh/D3SyiAXrMybuexZqzqLXQQIgEnRNpG3cD5rsZtMN7tBdXUD7rNZKZ60gZskQDzLYN98="}]},"_npmUser":{"name":"jjlongoria","email":"juanjoselongoria@gmail.com"},"directories":{},"maintainers":[{"name":"jjlongoria","email":"juanjoselongoria@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/xml-definitions_1.0.0_1631919787597_0.8737629091105619"},"_hasShrinkwrap":false},"2.0.0":{"name":"@aurahelper/xml-definitions","productName":"Aura Helper SalesForce XML Definitions","displayName":"Aura Helper Framework SalesForce XML Definitions","version":"2.0.0","description":"Powerfull Libraries to get the XML Definitions of ALL XML Salesforce Metadata Files. Support All API Versions up to API 53.0. You can get the definition of one or more XML files for a specific version of Salesforce. For Example: You can get the XML Defini","main":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"compile":"tsc -p ./ ","lint":"eslint src --ext ts","lint-fix":"eslint src --ext ts --fix","watch":"tsc -watch -p ./","test":"jest --coverage --runInBand"},"keywords":["aura-helper-framework","aura helper framework","Aura Helper Framework","ah-framework","AH Framework","Aura Helper","aura-helper","AuraHelper Library","AuraHelper Libraries","AH","ah","Salesforce","Salesforce Metadata","Salesforce Apps","Salesforce XML","Salesforce Tools","Apex","force.com","DevOps","devops","sf-xml-definitions","SF XML Definitions","SF XML","xml-definitions","XML Definitions"],"author":{"name":"Juan José Longoria López","email":"juanjoselongoria@gmail.com","url":"Kanko"},"license":"GPLv3","repository":{"type":"git","url":"git+https://github.com/JJLongoria/aura-helper-xml-definitions.git"},"bugs":{"url":"https://github.com/JJLongoria/aura-helper-xml-definitions/issues","email":"juanjoselongoria@gmail.com"},"devDependencies":{"@types/jest":"^27.0.3","@types/node":"^12.12.47","@typescript-eslint/eslint-plugin":"^5.4.0","@typescript-eslint/parser":"^5.4.0","eslint":"^8.3.0","jest":"^27.4.3","ts-jest":"^27.0.7","typescript":"^3.9.6"},"dependencies":{"@aurahelper/core":"^2.0.0"},"gitHead":"424dd5a5fd888ccd2d202e807d4e36e29d0b9610","homepage":"https://github.com/JJLongoria/aura-helper-xml-definitions#readme","_id":"@aurahelper/xml-definitions@2.0.0","_nodeVersion":"16.10.0","_npmVersion":"7.24.0","dist":{"integrity":"sha512-XckalE56krF5+1894bW9qNeIvi/9Lm4Xseu+nA7GcyuySltbSgC6K1Y/RBGDNVrygPxg8SUn0EOdCtqufw1PIg==","shasum":"6346046f70ff562e3356a684d8243681ce01dcb0","tarball":"https://registry.npmjs.org/@aurahelper/xml-definitions/-/xml-definitions-2.0.0.tgz","fileCount":774,"unpackedSize":1827790,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhto6JCRA9TVsSAnZWagAAfPwP/1WeE0tb6kuqOktSRgcU\nAPx13BXWNW7FJIxp4luMOL02FdmaPIKbmZoUvO1x9abLInR2MXElzwBw0ZeN\n5MmSDrBHS8WnrlO8X6MV7/TkI3tpQIj8JJ5ugnRB2j8bDj8X9FCs1LJFD85W\n/oxG0wjfPaSTtj+Ec9RF5iKigwwX8+jp3Q5wOSj/mz3erPlLTxEhNuqDNZHY\ne2RR1lci+GDxku1d28X6pKDfLLTemz/K3FYsAmsekQ9ZCprQXqogmiwrxn7T\nN4EV3l2Uou5VpOeNQKeretbbT/bKASB0Am19ZddreuONxrpqr5tz4njm+oIw\nv9706YourIWj57m3ptGaEaCDYczJVAU6See8crtSlg7yghyu3kGUyQvzC+UP\nr9xUXdhI1pKc40uT2h/6AlNqFXuSD261LelJvGoIJHtfQCmz010GMw7QhzAY\nPgNCi+Wl96vEJIYfXuhiW4038qu2z41jCQzX4b6Xlk0RJhuJiPR2881vFVRe\nu6pwW5I1R/6lVHwfW0cREf6x6UxrxF/FFRFqTyw41+FAHZwqfYEx0Pjgi3Si\n1zscln0vsRKHqtxjn82FWUfui9vgKi7V3ghDSuQie4amsZS0sQzs1K6QDz/A\nUWcnjnAqCJbg/c5jOmDKk748JV1m3bVrfqtr1hr2xZSJTjyhSdcMRJB+qq5l\nMzqp\r\n=an8A\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBlE7hhHDaoTcMurF06HelcfmozYun5KV9JPRGsz7nI1AiEA5zowrTjv70zA+p2kEJ6XUTrrZOCGm6Zo27eVQmcBy/w="}]},"_npmUser":{"name":"jjlongoria","email":"juanjoselongoria@gmail.com"},"directories":{},"maintainers":[{"name":"jjlongoria","email":"juanjoselongoria@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/xml-definitions_2.0.0_1639353993512_0.5706632524431066"},"_hasShrinkwrap":false},"2.0.1":{"name":"@aurahelper/xml-definitions","productName":"Aura Helper SalesForce XML Definitions","displayName":"Aura Helper Framework SalesForce XML Definitions","version":"2.0.1","description":"Powerfull Libraries to get the XML Definitions of ALL XML Salesforce Metadata Files. Support All API Versions up to API 53.0. You can get the definition of one or more XML files for a specific version of Salesforce. For Example: You can get the XML Defini","main":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"compile":"tsc -p ./ ","lint":"eslint src --ext ts","lint-fix":"eslint src --ext ts --fix","watch":"tsc -watch -p ./","test":"jest --coverage --runInBand"},"keywords":["aura-helper-framework","aura helper framework","Aura Helper Framework","ah-framework","AH Framework","Aura Helper","aura-helper","AuraHelper Library","AuraHelper Libraries","AH","ah","Salesforce","Salesforce Metadata","Salesforce Apps","Salesforce XML","Salesforce Tools","Apex","force.com","DevOps","devops","sf-xml-definitions","SF XML Definitions","SF XML","xml-definitions","XML Definitions"],"author":{"name":"Juan José Longoria López","email":"juanjoselongoria@gmail.com","url":"Kanko"},"license":"GPLv3","repository":{"type":"git","url":"git+https://github.com/JJLongoria/aura-helper-xml-definitions.git"},"bugs":{"url":"https://github.com/JJLongoria/aura-helper-xml-definitions/issues","email":"juanjoselongoria@gmail.com"},"devDependencies":{"@types/jest":"^27.0.3","@types/node":"^12.12.47","@typescript-eslint/eslint-plugin":"^5.4.0","@typescript-eslint/parser":"^5.4.0","eslint":"^8.3.0","jest":"^27.4.3","ts-jest":"^27.0.7","typescript":"^3.9.6"},"dependencies":{"@aurahelper/core":"^2.0.0"},"gitHead":"cdf0a03eccd2b99ee565a2e8bc12125b969b24a8","homepage":"https://github.com/JJLongoria/aura-helper-xml-definitions#readme","_id":"@aurahelper/xml-definitions@2.0.1","_nodeVersion":"16.10.0","_npmVersion":"7.24.0","dist":{"integrity":"sha512-PPBIMQGdxyk+n8g3AXoCiFxsnrv6R34mNqQFOUmXyzN8A36ALYpEFkFB+9PvIG3x5PJeW3hpRyyl5/SmSqueAw==","shasum":"4ebe57e369fba042384bd6a979df08049cc4a026","tarball":"https://registry.npmjs.org/@aurahelper/xml-definitions/-/xml-definitions-2.0.1.tgz","fileCount":774,"unpackedSize":1827312,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhvLQeCRA9TVsSAnZWagAAif8QAIM4tQlQINWifFHd0pez\n4DSiZYelXyDK8JSW+e+rzhlsRy569dPrd05Dv19/r4tlkh4UxbaRMLBaZjNO\nJNANm0xebTRutMftHCd509xmgfLn8ePtPZhFBWllg9FUPzp6buL7aZunLl+C\nN46/scaWJwSh29zqAcxqWKkmq1IuuT2FL+4yHwlcSGGu/TvwxEXIN+rUt6rp\ncpOZHZ0R5ZXsyUPJkMGH9UgrWyVHlkHpW1GUP3S6pSDmIFKepDtSLQr3goZG\nmH/1aWOXAFWWdkkvy3UY1+OyOeDuhjix+td5NEH/3nOpUCVhE+0HQU/AZG/u\nsRrIBopmt+L884AIGSugumw/6DttcCuilzf92RvtGkLTcnTfiTgVBt+bJVxx\n1GXNPQ7eRAoNuOXmk03LY+NZJWLlEZcY6KfKFcPkKrSbrZbIIIzdebElJvNQ\nUKPevqgnrhXxko80g5buZLjQC1nnv1HoZAi2A4E82N1MQCAjg9lHJOAAE8Mp\ngisWTdiKJlzvUoS1IwScXqL7boLqGgYFgCzbUuoOzlpoxzekYZFLdHcuykJr\nfVFdLzuhC64UZPnftHxOUxCSTaqrK0MPV3ek/ATcCcCV/po3Au5uiYJD3lV5\nkHpD0jtAISSEBI1X3SLX1v4K4tDueOvHpM98zMPKg+yhMn+mGBe7NZZrA95a\nQA3L\r\n=Dlp9\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICHvHoWsFEzDenUC9v3vWxS5dpmohC3E3cGPIxwWNVb0AiAC1edyGpnKJ608JIhAdt4Di9KNknwX9Hb65rVKJLSdkQ=="}]},"_npmUser":{"name":"jjlongoria","email":"juanjoselongoria@gmail.com"},"directories":{},"maintainers":[{"name":"jjlongoria","email":"juanjoselongoria@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/xml-definitions_2.0.1_1639756830378_0.04609028236480173"},"_hasShrinkwrap":false}},"time":{"created":"2021-09-17T23:03:07.525Z","1.0.0":"2021-09-17T23:03:07.744Z","modified":"2022-04-04T16:25:04.440Z","2.0.0":"2021-12-13T00:06:33.775Z","2.0.1":"2021-12-17T16:00:30.535Z"},"maintainers":[{"name":"jjlongoria","email":"juanjoselongoria@gmail.com"}],"description":"Powerfull Libraries to get the XML Definitions of ALL XML Salesforce Metadata Files. Support All API Versions up to API 53.0. You can get the definition of one or more XML files for a specific version of Salesforce. For Example: You can get the XML Defini","homepage":"https://github.com/JJLongoria/aura-helper-xml-definitions#readme","keywords":["aura-helper-framework","aura helper framework","Aura Helper Framework","ah-framework","AH Framework","Aura Helper","aura-helper","AuraHelper Library","AuraHelper Libraries","AH","ah","Salesforce","Salesforce Metadata","Salesforce Apps","Salesforce XML","Salesforce Tools","Apex","force.com","DevOps","devops","sf-xml-definitions","SF XML Definitions","SF XML","xml-definitions","XML Definitions"],"repository":{"type":"git","url":"git+https://github.com/JJLongoria/aura-helper-xml-definitions.git"},"author":{"name":"Juan José Longoria López","email":"juanjoselongoria@gmail.com","url":"Kanko"},"bugs":{"url":"https://github.com/JJLongoria/aura-helper-xml-definitions/issues","email":"juanjoselongoria@gmail.com"},"license":"GPLv3","readme":"# **Aura Helper XML Definitions Module**\r\n\r\n[![Version](https://img.shields.io/npm/v/@aurahelper/xml-definitions?logo=npm)](https://www.npmjs.com/package/@aurahelper/xml-definitions)\r\n[![Total Downloads](https://img.shields.io/npm/dt/@aurahelper/xml-definitions?logo=npm)](https://www.npmjs.com/package/@aurahelper/xml-definitions)\r\n[![Downloads/Month](https://img.shields.io/npm/dm/@aurahelper/xml-definitions?logo=npm)](https://www.npmjs.com/package/@aurahelper/xml-definitions)\r\n[![Issues](https://img.shields.io/github/issues/jjlongoria/aura-helper-xml-definitions)](https://github.com/JJLongoria/aura-helper-xml-definitions/issues)\r\n[![Known Vulnerabilities](https://snyk.io/test/github/JJLongoria/aura-helper-xml-definitions/badge.svg)](https://snyk.io/test/github/JJLongoria/aura-helper-xml-definitions)\r\n[![Code Size](https://img.shields.io/github/languages/code-size/jjlongoria/aura-helper-xml-definitions)](https://github.com/JJLongoria/aura-helper-xml-definitions)\r\n[![License](https://img.shields.io/github/license/jjlongoria/aura-helper-xml-definitions?logo=github)](https://github.com/JJLongoria/aura-helper-xml-definitions/blob/master/LICENSE)\r\n\r\nModule to get any Salesforce Metadata XML Files Definition to process Metadata files properly. Yoy can get all Raw definitions, a Raw definition for a specific type or get All or specific definitions for a specific api version. For example, yo can get all Salesforce XML Definitions for API 45.0 or get the Custom Object XML File Definition for API 35.0.\r\n\r\nThe **difference** between the **XML definition** and the **raw XML definition** is that the raw definition *is not processed*, it returns the entire XML information. The XML definitions return the XML definition processed for a *specific API version*, omitting everything that does not correspond to the indicated version.\r\n\r\n### **Support up to API 53.0**\r\n\r\n# [**XMLDefinitions Class**](#xmldefinitions-class)\r\nClass with static methods to get the XML Definitions for one Metadata Type or get all XML Definitions for all types and specific Salesforce API Version. Also you can get a XML Raw definitions and Resolve Recursive definitions on some files. \r\n\r\n# [**Methods**](#xmldefinitions-methods)\r\n  - [**getDefinition(type, apiVersion)**](#getdefinitiontype-apiversion)\r\n\r\n    Method to get the Metadata Type's XML definition for an API Version.\r\n\r\n  - [**getRawDefinition(type)**](#getrawdefinitiontype)\r\n \r\n    Method to get the Metadata Type's XML RAW definition\r\n\r\n  - [**getAllDefinitions(apiVersion)**](#getalldefinitionsapiversion)\r\n  \r\n    Method to get all XML Definitions for all Metadata Types for an specific API Version\r\n\r\n  - [**getAllRawDefinitions()**](#getallrawdefinitions)\r\n\r\n    Method to get all XML RAW Definitions for all Metadata Types\r\n    \r\n  - [**resolveDefinitionReference(xmlDefinition, subFieldDefinition)**](#resolvedefinitionreferencexmldefinition-subfielddefinition)\r\n\r\n    Method to resolve the recursive reference from some XML Definition files\r\n\r\n---\r\n\r\n## [**getDefinition(type, apiVersion)**](#getdefinitiontype-apiversion)\r\nMethod to get the Metadata Type's XML definition for an API Version.\r\n\r\n### **Parameters:**\r\n  - **type**: Metadata Type API Name to get the XML definition\r\n    - `string` \r\n  - **apiVersion**: API Version number to get the version definition\r\n    - `string` | `number`\r\n   \r\n### **Return:**\r\nReturn the XML definition for the selected type and API version. If the type exists, but is not available in the selected API, return an empty object. If type not exists, return undefined.\r\n- `{ [key: string]: any }` | `undefined`\r\n    \r\n### **Examples:**\r\n**Get the Profile XML definition for API 45.0**\r\n```javascript\r\n    import { XMLDefinitions } from '@aurahelper/xml-definitions';\r\n\r\n    const ProfileDefinition = XMLDefinitions.getDefinition('Profile', 45);\r\n    console.log(ProfileDefinition);\r\n```\r\n**Get the CustomObject XML definition for API 33.0**\r\n```javascript\r\n    import { XMLDefinitions } from '@aurahelper/xml-definitions';\r\n\r\n    const CustomObjectDefinition = XMLDefinitions.getDefinition('CustomObject', 33);\r\n    console.log(CustomObjectDefinition);    \r\n```\r\n---\r\n## [**getRawDefinition(type)**](#getrawdefinitiontype)\r\nMethod to get the Metadata Type's XML RAW definition\r\n\r\n### **Parameters:**\r\n  - **type**: Metadata Type API Name to get the XML definition\r\n      - `string` \r\n### **Return:**\r\nReturn the XML raw definition for the selected type. If type not exists, return undefined\r\n- `{ [key: string]: any }` | `undefined`\r\n\r\n### **Examples:**\r\n**Get the ConnectedApp XML raw definition**\r\n```javascript\r\n    import { XMLDefinitions } from '@aurahelper/xml-definitions';\r\n\r\n    const ConnectedAppDefinition = XMLDefinitions.getRawDefinition('ConnectedApp');\r\n    console.log(ConnectedAppDefinition);\r\n```\r\n**Get the CustomField XML raw definition**\r\n```javascript\r\n    import { XMLDefinitions } from '@aurahelper/xml-definitions';\r\n\r\n    const CustomFieldDefinition = XMLDefinitions.getRawDefinition('CustomField');\r\n    console.log(CustomFieldDefinition);\r\n```\r\n---\r\n## [**getAllDefinitions(apiVersion)**](#getalldefinitionsapiversion)\r\nMethod to get all XML Definitions for all Metadata Types for an specific API Version.\r\n\r\n### **Parameters:**\r\n  - **apiVersion**: API Version number to get the version definition\r\n    - `string` | `number` \r\n### **Return:**\r\nReturn an Object with all XML definitions for the selected API version. The object has the Type as key and the XML definition as value. If not exists any definition for the selected API return an empty object\r\n- `{ [key: string]: { [key: string]: any } }`\r\n\r\n### **Examples:**\r\n**Get All XML Definitions for API 43.0**\r\n```javascript\r\n    import { XMLDefinitions } from '@aurahelper/xml-definitions';\r\n\r\n    const AllDefinitions = XMLDefinitions.getAllDefinitions(43);\r\n\r\n    const CustomObjectDefinition = AllDefinitions.CustomObject;\r\n    const SkilDefinition = AllDefinitions['Skill'];\r\n\r\n    console.log(CustomObjectDefinition);\r\n    console.log(SkilDefinition);\r\n```\r\n---\r\n## [**getAllRawDefinitions()**](#getallrawdefinitions)\r\nMethod to get all XML RAW Definitions for all Metadata Types\r\n\r\n### **Return:**\r\nReturn an Object with all XML raw definitions. The object has the Type as key and the XML definition as value\r\n- `{ [key: string]: { [key: string]: any } }`\r\n\r\n### **Examples:**\r\n**Get All XML raw definitions**\r\n```javascript\r\n    import { XMLDefinitions } from '@aurahelper/xml-definitions';\r\n\r\n    const AllRawDefinitions = XMLDefinitions.getAllRawDefinitions();\r\n\r\n    const CustomFieldRawDefinition = AllRawDefinitions.CustomField;\r\n    const WorkflowRawDefinition = AllRawDefinitions['Workflow'];\r\n\r\n    console.log(CustomFieldRawDefinition);\r\n    console.log(WorkflowRawDefinition);\r\n```\r\n---\r\n## [**resolveDefinitionReference(xmlDefinition, subFieldDefinition)**](#resolvedefinitionreferencexmldefinition-subfielddefinition)\r\nMethod to resolve the recursive reference from some XML Definition files\r\n\r\n### **Parameters:**\r\n  - **typeDefinition**: XML file Definition\r\n    -  `any` \r\n  - **subFieldDefinition**: XML Field definition to resolve\r\n    - `any` \r\n   \r\n### **Return:**\r\nReturns the XML Definition to the selected XML field\r\n- `any`\r\n    \r\n### **Examples:**\r\nResolve the recursive definition references on an object like Bot Steps on Bot XML Definition\r\n\r\n```javascript\r\n    import { XMLDefinitions } from '@aurahelper/xml-definitions';\r\n\r\n    const BotDefinition = XMLDefinitions.getDefinition('Bot', 50);\r\n    ...\r\n    ...\r\n    ...\r\n    if(botStep.definitionRef){\r\n        let botStepResolvedDefinition = XMLDefinitions.resolveDefinitionReference(BotDefinition, botStep);\r\n    }\r\n```\r\n\r\n","readmeFilename":"README.md"}