@benup/bensdk 1.10.2 → 1.11.1

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 (10) hide show
  1. package/bin/src/cli/init.js +4 -0
  2. package/bin/src/cli/init.js.map +1 -1
  3. package/bin/src/cli/templates/ICON.placeholder.png +0 -0
  4. package/bin/src/cli/templates/benefit.manifest.template.json +43 -0
  5. package/bin/src/cli/templates/bensdk-lib/mocks/DOCUMENTATION.md +189 -0
  6. package/bin/src/cli/templates/bensdk-lib/mocks/action.deduction.mock.ts +276 -0
  7. package/bin/src/cli/templates/bensdk-lib/mocks/action.grant.mock.ts +271 -0
  8. package/bin/src/cli/templates/bensdk-lib/mocks/action.recharge.mock.ts +221 -0
  9. package/bin/src/cli/templates/bensdk-lib/mocks/action.revoke.mock.ts +271 -0
  10. package/package.json +1 -1
package/bin/src/cli/init.js CHANGED
@@ -11,6 +11,8 @@ const __filename = fileURLToPath(import.meta.url);
11
11
  const __dirname = path.dirname(__filename);
12
12
  const templatesDir = path.join(__dirname, 'templates');
13
13
  const benefitDefinitionTemplate = fs.readFileSync(path.join(templatesDir, 'benefit-definition.template.ts'), 'utf-8');
14
+ const benefitManifest = fs.readFileSync(path.join(templatesDir, "benefit.manifest.template.json"), "utf-8");
15
+ const iconPlaceHolder = path.join(templatesDir, "ICON.placeholder.png");
14
16
  const getAllFiles = (dirPath, arrayOfFiles = []) => {
15
17
  const files = fs.readdirSync(dirPath);
16
18
  files.forEach((file) => {
@@ -68,6 +70,8 @@ export default async function (benefitID) {
68
70
  const appDirectory = `${currentDirectory}/${benefitID}`;
69
71
  fs.mkdirSync(`${appDirectory}/src`, { recursive: true });
70
72
  fs.writeFileSync(`${appDirectory}/src/benefit-definition.ts`, benefitDefinition);
73
+ fs.writeFileSync(`${appDirectory}/src/benefit.manifest.json`, benefitManifest);
74
+ fs.copyFileSync(iconPlaceHolder, `${appDirectory}/ICON.png`);
71
75
  fs.mkdirSync(`${appDirectory}/src/lib`, { recursive: true });
72
76
  fs.cpSync(path.join(templatesDir, 'bensdk-lib'), `${appDirectory}/src/lib`, { recursive: true });
73
77
  fs.mkdirSync(`${appDirectory}/bin/server`, { recursive: true });
package/bin/src/cli/init.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/cli/init.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,eAAe,MAAM,mCAAmC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAEtF,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAC3C,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;AAEvD,MAAM,yBAAyB,GAAG,EAAE,CAAC,YAAY,CAC/C,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,gCAAgC,CAAC,EACzD,OAAO,CACR,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,OAAe,EAAE,eAAyB,EAAE,EAAE,EAAE;IACnE,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEtC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC1C,IAAI,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;YACxC,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;QACrF,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAIF,MAAM,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC;AAExE,MAAM,CAAC,OAAO,CAAC,KAAK,WAAW,SAAiB;IAC9C,MAAM,gBAAgB,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAE7C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC;QACvD,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,wBAAwB;QAC9B,OAAO,EAAE,8BAA8B;QACvC,OAAO,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,iBAAiB,EAAE,kBAAkB,CAAC;KAC1E,CAAC,CAAC;IAEH,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC;QAChD,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,gDAAgD;KAC1D,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,GAAG,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,CAAC;IAEhD,IAAI,OAAO,GAAG,CAAC,GAAG,gBAAgB,EAAE,GAAG,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC;IAE9F,eAAe,CAAC,IAAI,GAAG,SAAS,CAAC;IAEjC,IAAI,iBAAiB,GAAG,yBAAyB,CAAC,OAAO,CACvD,iBAAiB,EACjB,eAAe,SAAS,CAAC,WAAW,EAAE,GAAG,CAC1C,CAAC;IAEF,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACjD,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAC3C,yDAAyD,EACzD,EAAE,CACH,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,oEAAoE;QACpE,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;QAChF,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,IACE,CAAC,sBAAsB,CAAC,QAAQ,CAAC,iBAAiB,CAAC;QACnD,CAAC,sBAAsB,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EACpD,CAAC;QACD,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAC3C,2DAA2D,EAC3D,EAAE,CACH,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,oEAAoE;QACpE,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAAC,6BAA6B,EAAE,EAAE,CAAC,CAAC;QACjF,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAAC,+BAA+B,EAAE,EAAE,CAAC,CAAC;IACrF,CAAC;IAED,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IACvC,MAAM,YAAY,GAAG,GAAG,gBAAgB,IAAI,SAAS,EAAE,CAAC;IAExD,EAAE,CAAC,SAAS,CAAC,GAAG,YAAY,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACzD,EAAE,CAAC,aAAa,CAAC,GAAG,YAAY,4BAA4B,EAAE,iBAAiB,CAAC,CAAC;IACjF,EAAE,CAAC,SAAS,CAAC,GAAG,YAAY,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,GAAG,YAAY,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEjG,EAAE,CAAC,SAAS,CAAC,GAAG,YAAY,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,qBAAqB,CAAC,EAAE,GAAG,YAAY,aAAa,EAAE;QACtF,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;IAEH,EAAE,CAAC,SAAS,CAAC,GAAG,YAAY,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,GAAG,YAAY,aAAa,EAAE;QAChF,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;IAEH,EAAE,CAAC,SAAS,CAAC,GAAG,YAAY,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,GAAG,YAAY,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEjG,WAAW,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE;QACvC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAAC;QAC5E,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,gBAAgB,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,CAAC;QAE7F,0CAA0C;QAC1C,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEjE,EAAE,CAAC,aAAa,CAAC,eAAe,EAAE,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,IAAI,EAAE,CAAC;IACf,EAAE,CAAC,aAAa,CAAC,GAAG,YAAY,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3F,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAE9C,IAAI,QAAQ,GAAG,MAAM,YAAY,sEAAsE,CAAC;IACxG,IAAI,eAAe,EAAC,CAAC;QACnB,QAAQ,IAAI,wHAAwH,CAAA;IACtI,CAAC;IACD,QAAQ,IAAI,+EAA+E,CAAC;IAE5F,OAAO,CAAC,IAAI,GAAG,wBAAwB,SAAS,GAAG,CAAC;IACpD,OAAO,CAAC,KAAK,EAAE,CAAC;IAChB,IAAI,CACF,QAAQ,EACR,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;QACxB,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC3B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC,CAAC;YACzE,OAAO,CAAC,IAAI,EAAE,CAAC;YACf,OAAO;QACT,CAAC;QACD,OAAO,CAAC,IAAI,EAAE,CAAC;QACf,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,iBAAiB,SAAS,WAAW,CAAC,CAAC,CAAC;IAClE,CAAC,CACF,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/cli/init.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,eAAe,MAAM,mCAAmC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAEtF,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAC3C,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;AAEvD,MAAM,yBAAyB,GAAG,EAAE,CAAC,YAAY,CAC/C,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,gCAAgC,CAAC,EACzD,OAAO,CACR,CAAC;AAEF,MAAM,eAAe,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,gCAAgC,CAAC,EAAE,OAAO,CAAC,CAAC;AAC5G,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,sBAAsB,CAAC,CAAC;AAExE,MAAM,WAAW,GAAG,CAAC,OAAe,EAAE,eAAyB,EAAE,EAAE,EAAE;IACnE,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEtC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC1C,IAAI,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;YACxC,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;QACrF,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAIF,MAAM,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC;AAExE,MAAM,CAAC,OAAO,CAAC,KAAK,WAAW,SAAiB;IAC9C,MAAM,gBAAgB,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAE7C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC;QACvD,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,wBAAwB;QAC9B,OAAO,EAAE,8BAA8B;QACvC,OAAO,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,iBAAiB,EAAE,kBAAkB,CAAC;KAC1E,CAAC,CAAC;IAEH,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC;QAChD,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,gDAAgD;KAC1D,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,GAAG,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,CAAC;IAEhD,IAAI,OAAO,GAAG,CAAC,GAAG,gBAAgB,EAAE,GAAG,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC;IAE9F,eAAe,CAAC,IAAI,GAAG,SAAS,CAAC;IAEjC,IAAI,iBAAiB,GAAG,yBAAyB,CAAC,OAAO,CACvD,iBAAiB,EACjB,eAAe,SAAS,CAAC,WAAW,EAAE,GAAG,CAC1C,CAAC;IAEF,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACjD,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAC3C,yDAAyD,EACzD,EAAE,CACH,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,oEAAoE;QACpE,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;QAChF,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,IACE,CAAC,sBAAsB,CAAC,QAAQ,CAAC,iBAAiB,CAAC;QACnD,CAAC,sBAAsB,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EACpD,CAAC;QACD,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAC3C,2DAA2D,EAC3D,EAAE,CACH,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,oEAAoE;QACpE,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAAC,6BAA6B,EAAE,EAAE,CAAC,CAAC;QACjF,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAAC,+BAA+B,EAAE,EAAE,CAAC,CAAC;IACrF,CAAC;IAED,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IACvC,MAAM,YAAY,GAAG,GAAG,gBAAgB,IAAI,SAAS,EAAE,CAAC;IAExD,EAAE,CAAC,SAAS,CAAC,GAAG,YAAY,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACzD,EAAE,CAAC,aAAa,CAAC,GAAG,YAAY,4BAA4B,EAAE,iBAAiB,CAAC,CAAC;IACjF,EAAE,CAAC,aAAa,CAAC,GAAG,YAAY,4BAA4B,EAAE,eAAe,CAAC,CAAC;IAC/E,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,GAAG,YAAY,WAAW,CAAC,CAAC;IAC7D,EAAE,CAAC,SAAS,CAAC,GAAG,YAAY,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,GAAG,YAAY,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEjG,EAAE,CAAC,SAAS,CAAC,GAAG,YAAY,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,qBAAqB,CAAC,EAAE,GAAG,YAAY,aAAa,EAAE;QACtF,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;IAEH,EAAE,CAAC,SAAS,CAAC,GAAG,YAAY,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,GAAG,YAAY,aAAa,EAAE;QAChF,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;IAEH,EAAE,CAAC,SAAS,CAAC,GAAG,YAAY,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,GAAG,YAAY,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEjG,WAAW,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE;QACvC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAAC;QAC5E,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,gBAAgB,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,CAAC;QAE7F,0CAA0C;QAC1C,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEjE,EAAE,CAAC,aAAa,CAAC,eAAe,EAAE,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,IAAI,EAAE,CAAC;IACf,EAAE,CAAC,aAAa,CAAC,GAAG,YAAY,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3F,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAE9C,IAAI,QAAQ,GAAG,MAAM,YAAY,sEAAsE,CAAC;IACxG,IAAI,eAAe,EAAC,CAAC;QACnB,QAAQ,IAAI,wHAAwH,CAAA;IACtI,CAAC;IACD,QAAQ,IAAI,+EAA+E,CAAC;IAE5F,OAAO,CAAC,IAAI,GAAG,wBAAwB,SAAS,GAAG,CAAC;IACpD,OAAO,CAAC,KAAK,EAAE,CAAC;IAChB,IAAI,CACF,QAAQ,EACR,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;QACxB,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC3B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC,CAAC;YACzE,OAAO,CAAC,IAAI,EAAE,CAAC;YACf,OAAO;QACT,CAAC;QACD,OAAO,CAAC,IAAI,EAAE,CAAC;QACf,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,iBAAiB,SAAS,WAAW,CAAC,CAAC,CAAC;IAClE,CAAC,CACF,CAAC;AACJ,CAAC"}
package/bin/src/cli/templates/benefit.manifest.template.json ADDED
@@ -0,0 +1,43 @@
1
+ {
2
+ "benefitName": "",
3
+ "supportingText": "",
4
+ "shortDescription": "",
5
+ "description": "",
6
+ "availiableActions": [],
7
+ "auth": [
8
+ {
9
+ "key": "",
10
+ "label": "",
11
+ "description": "",
12
+ "type": "",
13
+ "required": true,
14
+ "jsonSchema": {
15
+ "type": "",
16
+ "minLength": 0
17
+ }
18
+ }
19
+ ],
20
+ "provider": "benefits-orchestrator",
21
+ "category": "",
22
+ "products": [
23
+ {
24
+ "productID": "",
25
+ "productName": ""
26
+ }
27
+ ],
28
+ "options": [
29
+ {
30
+ "key": "",
31
+ "label": "",
32
+ "description": "",
33
+ "type": "",
34
+ "options": [],
35
+ "default": "",
36
+ "required": true,
37
+ "jsonSchema": {
38
+ "type": "",
39
+ "minLength": 0
40
+ }
41
+ }
42
+ ]
43
+ }
package/bin/src/cli/templates/bensdk-lib/mocks/DOCUMENTATION.md ADDED
@@ -0,0 +1,189 @@
1
+ # Action Fields Documentation
2
+
3
+ Este documento lista todos os campos presentes nas diferentes actions do sistema.
4
+
5
+ **Legenda:**
6
+
7
+ - 🔵 Campo compartilhado entre múltiplas actions
8
+ - 🟢 Campo específico de uma action
9
+
10
+ **Actions documentadas:** GRANT, RECHARGE, DEDUCTION, REVOKE
11
+
12
+ ## 🔵 Campos Compartilhados
13
+
14
+ Campos presentes em múltiplas actions.
15
+
16
+ | Campo | Tipo | Actions | Exemplo | Descrição |
17
+ | ------------------------------------------------------------------------------------------------------ | ------- | ---------------------------------- | ------------------------------------------------------------------ | --------- |
18
+ | `_id` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "683877a6e780f979be00048c" | |
19
+ | `action` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "GRANT" | |
20
+ | `batchID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "e05db2a3-9f9e-45c3-a5a9-f2d77bb47647" | |
21
+ | `benefitID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "NEW_VALUE" | |
22
+ | `createdAt` | Date | DEDUCTION, GRANT, RECHARGE, REVOKE | Date("2025-05-29T15:05:10.431Z") | |
23
+ | `eligibilityOptions.externalBenefitID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "NV101.1" | |
24
+ | `eligibilityOptions.plan.externalPorductID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "NV101.1" | |
25
+ | `eligibilityOptions.plan.name` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "CLUBE DE BENEFICIOS" | |
26
+ | `executionID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "e05db2a3-9f9e-45c3-a5a9-f2d77bb47647" | |
27
+ | `fingerprint` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "870036743251b6e8ada273819175df6379e18142e35ffd04d696bd2b68be9d31" | |
28
+ | `origin` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "test" | |
29
+ | `parentActionID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
30
+ | `planApprovalStatus` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "APPROVED" | |
31
+ | `planID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
32
+ | `requiresPlanApproval` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
33
+ | `state` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "INITIAL" | |
34
+ | `target.company._id` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "678016b2410559c21dd53226" | |
35
+ | `target.company.accountID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "681b75421180f14cd49dafc1" | |
36
+ | `target.company.address.city` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
37
+ | `target.company.address.complement` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
38
+ | `target.company.address.country` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
39
+ | `target.company.address.neighborhood` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
40
+ | `target.company.address.number` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
41
+ | `target.company.address.state` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
42
+ | `target.company.address.street` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
43
+ | `target.company.address.zipCode` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
44
+ | `target.company.businessName` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "RD Saude" | |
45
+ | `target.company.cnpj` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "61.585.865/0001-51" | |
46
+ | `target.company.createdAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "2025-01-09T18:34:26.466Z" | |
47
+ | `target.company.externalCompanyID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
48
+ | `target.company.tradeName` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "Raia Drogasil S/A" | |
49
+ | `target.company.updatedAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
50
+ | `target.dependent.benefits.DUMMY.isEligible` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
51
+ | `target.dependent.benefits.DUMMY.status` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "ENABLED" | |
52
+ | `target.dependent.benefits.DUMMY.statusOriginID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
53
+ | `target.dependent.benefits.DUMMY.value` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
54
+ | `target.dependent.birthDate` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
55
+ | `target.dependent.cpf` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
56
+ | `target.dependent.externalDependentCode` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
57
+ | `target.dependent.externalDependentID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
58
+ | `target.dependent.isDeleted` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
59
+ | `target.dependent.maritalStatus` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "NONE" | |
60
+ | `target.dependent.mothersName` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
61
+ | `target.dependent.name` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
62
+ | `target.dependent.relationshipType` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "OTHER" | |
63
+ | `target.dependent.sex` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "M" | |
64
+ | `target.dependent.status` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "LINKED" | |
65
+ | `target.employee._id` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "681e3f1a230ab8b41591abc1" | |
66
+ | `target.employee.address.city` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
67
+ | `target.employee.address.complement` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
68
+ | `target.employee.address.country` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
69
+ | `target.employee.address.neighborhood` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
70
+ | `target.employee.address.number` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
71
+ | `target.employee.address.state` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
72
+ | `target.employee.address.street` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
73
+ | `target.employee.address.zipCode` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
74
+ | `target.employee.birthdate` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "1979-10-10" | |
75
+ | `target.employee.cpf` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "756.896.500-72" | |
76
+ | `target.employee.createdAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
77
+ | `target.employee.documents.rg.issueDate` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
78
+ | `target.employee.documents.rg.issuer` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
79
+ | `target.employee.documents.rg.number` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
80
+ | `target.employee.documents.rg.state` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
81
+ | `target.employee.email` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
82
+ | `target.employee.maritalStatus` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "NONE" | |
83
+ | `target.employee.name` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "Gabrielle Pumpkin Verbrugghen" | |
84
+ | `target.employee.sex` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "M" | |
85
+ | `target.employee.updatedAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
86
+ | `target.employmentContract._id` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
87
+ | `target.employmentContract.accountID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
88
+ | `target.employmentContract.admissionDate` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
89
+ | `target.employmentContract.benefits.DUMMY.isEligible` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
90
+ | `target.employmentContract.benefits.DUMMY.status` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "ENABLED" | |
91
+ | `target.employmentContract.benefits.DUMMY.statusOriginID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
92
+ | `target.employmentContract.benefits.DUMMY.value` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
93
+ | `target.employmentContract.businessUnit.code` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
94
+ | `target.employmentContract.businessUnit.description` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
95
+ | `target.employmentContract.cellphone` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
96
+ | `target.employmentContract.companyID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
97
+ | `target.employmentContract.costCenter.code` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
98
+ | `target.employmentContract.costCenter.description` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
99
+ | `target.employmentContract.createdAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
100
+ | `target.employmentContract.customerID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
101
+ | `target.employmentContract.dependents` | array | DEDUCTION, GRANT, RECHARGE, REVOKE | [] | |
102
+ | `target.employmentContract.employmentContractID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
103
+ | `target.employmentContract.establishment.cnpj` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
104
+ | `target.employmentContract.establishment.code` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 0 | |
105
+ | `target.employmentContract.establishment.description` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
106
+ | `target.employmentContract.externalDeliveryAddress.address.city` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
107
+ | `target.employmentContract.externalDeliveryAddress.address.complement` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
108
+ | `target.employmentContract.externalDeliveryAddress.address.country` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
109
+ | `target.employmentContract.externalDeliveryAddress.address.neighborhood` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
110
+ | `target.employmentContract.externalDeliveryAddress.address.number` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
111
+ | `target.employmentContract.externalDeliveryAddress.address.state` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
112
+ | `target.employmentContract.externalDeliveryAddress.address.street` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
113
+ | `target.employmentContract.externalDeliveryAddress.address.zipCode` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
114
+ | `target.employmentContract.externalDeliveryAddress.externalDeliveryAddressID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
115
+ | `target.employmentContract.externalDeliveryAddress.externalEstablishmentCNPJ` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
116
+ | `target.employmentContract.externalEmploymentContractID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
117
+ | `target.employmentContract.externalPersonID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
118
+ | `target.employmentContract.fingerprint` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
119
+ | `target.employmentContract.isDeleted` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
120
+ | `target.employmentContract.mothersName` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
121
+ | `target.employmentContract.originExecutionID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
122
+ | `target.employmentContract.phone` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
123
+ | `target.employmentContract.position.code` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 0 | |
124
+ | `target.employmentContract.position.description` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
125
+ | `target.employmentContract.revision` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 0 | |
126
+ | `target.employmentContract.situation.code` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 0 | |
127
+ | `target.employmentContract.situation.description` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
128
+ | `target.employmentContract.situation.origin` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "TRANSFER_IN" | |
129
+ | `target.employmentContract.situation.transfer.from.externalCompanyID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
130
+ | `target.employmentContract.situation.transfer.from.externalEmploymentContractID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
131
+ | `target.employmentContract.situation.transfer.to.externalCompanyID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
132
+ | `target.employmentContract.situation.transfer.to.externalEmploymentContractID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
133
+ | `target.employmentContract.situation.transfer.transferredAt` | Date | DEDUCTION, GRANT, RECHARGE, REVOKE | Date("2025-05-29T15:05:10.431Z") | |
134
+ | `target.employmentContract.startDateOfCurrentSituation` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
135
+ | `target.employmentContract.status` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "ADMITTED" | |
136
+ | `target.payrollConfiguration._id` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "6836097c80d6be838db32525" | |
137
+ | `target.payrollConfiguration.accountID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "681b75421180f14cd49dafc1" | |
138
+ | `target.payrollConfiguration.companyID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "678016b2410559c21dd53226" | |
139
+ | `target.payrollConfiguration.createdAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "2025-05-27T18:50:36.135Z" | |
140
+ | `target.payrollConfiguration.dataMapping.deduction` | array | DEDUCTION, GRANT, RECHARGE, REVOKE | [] | |
141
+ | `target.payrollConfiguration.dataMapping.eligibility` | array | DEDUCTION, GRANT, RECHARGE, REVOKE | [3 items] | |
142
+ | `target.payrollConfiguration.dataMapping.eligibility[0].benefitID` | string | DEDUCTION, GRANT, REVOKE | "FLEURY_CHECKUP" | |
143
+ | `target.payrollConfiguration.dataMapping.eligibility[0].eligibilityCode` | string | DEDUCTION, GRANT, REVOKE | "" | |
144
+ | `target.payrollConfiguration.dataMapping.eligibility[0].eligibilityMap` | array | DEDUCTION, GRANT, REVOKE | [] | |
145
+ | `target.payrollConfiguration.dataMapping.eligibility[0].eligibilityType` | string | DEDUCTION, GRANT, REVOKE | "BENEFIT" | |
146
+ | `target.payrollConfiguration.dataMapping.eligibility[0].options.contractID` | string | DEDUCTION, GRANT, REVOKE | "47d9b27a-1933-47d5-856b-6b827cb43d2c" | |
147
+ | `target.payrollConfiguration.dataMapping.eligibility[0].settings.grant.daysBeforeAdmissionDateToGrant` | number | DEDUCTION, GRANT, REVOKE | 1 | |
148
+ | `target.payrollConfiguration.dataMapping.eligibility[0].settings.grant.shouldGrantBeforeAdmissionDate` | boolean | DEDUCTION, GRANT, REVOKE | false | |
149
+ | `target.payrollConfiguration.dataMapping.eligibility[0].settings.revoke.daysInAdvanceToScheduleRevoke` | number | DEDUCTION, GRANT, REVOKE | 1 | |
150
+ | `target.payrollConfiguration.dataMapping.eligibility[0].settings.revoke.shouldScheduleRevoke` | boolean | DEDUCTION, GRANT, REVOKE | false | |
151
+ | `target.payrollConfiguration.dataMapping.events` | array | DEDUCTION, GRANT, RECHARGE, REVOKE | [] | |
152
+ | `target.payrollConfiguration.dataMapping.rechargeTemplate` | array | DEDUCTION, GRANT, RECHARGE, REVOKE | [] | |
153
+ | `target.payrollConfiguration.dataMapping.situation` | array | DEDUCTION, GRANT, RECHARGE, REVOKE | [] | |
154
+ | `target.payrollConfiguration.deletedAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
155
+ | `target.payrollConfiguration.eligibilitySource` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "BENEFIT_MODULE" | |
156
+ | `target.payrollConfiguration.isDeleted` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
157
+ | `target.payrollConfiguration.modifiedContractsWindowInDays` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 15 | |
158
+ | `target.payrollConfiguration.payrollReferenceCutoffDay` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 20 | |
159
+ | `target.payrollConfiguration.payrollSystem` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "LG_CLOUD" | |
160
+ | `target.payrollConfiguration.productToggle.isIntegratorActive` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | true | |
161
+ | `target.payrollConfiguration.productToggle.isOrchestratorActive` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | true | |
162
+ | `target.payrollConfiguration.updatedAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
163
+ | `target.payrollConfiguration.version` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 3 | |
164
+ | `updatedAt` | Date | DEDUCTION, GRANT, RECHARGE, REVOKE | Date("2025-05-29T20:30:03.720Z") | |
165
+
166
+ ## 🟢 Campos Específicos por Action
167
+
168
+ ### RECHARGE
169
+
170
+ Campos exclusivos da action `RECHARGE`.
171
+
172
+ | Campo | Tipo | Exemplo | Descrição |
173
+ | --------------------------- | ------ | ------- | --------- |
174
+ | `rechargeInput.date` | string | "" | |
175
+ | `rechargeInput.productID` | string | "" | |
176
+ | `rechargeInput.quantity` | number | 0 | |
177
+ | `rechargeInput.tariffValue` | number | 0 | |
178
+ | `rechargeInput.ticketCode` | number | 0 | |
179
+ | `rechargeInput.value` | number | 0 | |
180
+
181
+ ### DEDUCTION
182
+
183
+ Campos exclusivos da action `DEDUCTION`.
184
+
185
+ | Campo | Tipo | Exemplo | Descrição |
186
+ | ------------------------------- | ------- | ------- | --------- |
187
+ | `deductionInput.date` | string | "" | |
188
+ | `deductionInput.isAccumulative` | boolean | false | |
189
+ | `deductionInput.value` | number | 0 | |
package/bin/src/cli/templates/bensdk-lib/mocks/action.deduction.mock.ts ADDED
@@ -0,0 +1,276 @@
1
+ import { DeductionActionSchema } from '#shared/schemas/action.schema';
2
+ import z from 'zod';
3
+
4
+ type DeepRequired<T> = T extends object
5
+ ? {
6
+ [P in keyof T]-?: DeepRequired<T[P]>;
7
+ }
8
+ : T;
9
+
10
+ export default {
11
+ _id: '683877a6e780f979be00048c',
12
+ batchID: 'e05db2a3-9f9e-45c3-a5a9-f2d77bb47647',
13
+ executionID: 'e05db2a3-9f9e-45c3-a5a9-f2d77bb47647',
14
+ parentActionID: '',
15
+ fingerprint: '870036743251b6e8ada273819175df6379e18142e35ffd04d696bd2b68be9d31',
16
+ action: 'GRANT',
17
+ benefitID: 'NEW_VALUE',
18
+ state: 'INITIAL',
19
+ target: {
20
+ employee: {
21
+ _id: '681e3f1a230ab8b41591abc1',
22
+ name: 'Gabrielle Pumpkin Verbrugghen',
23
+ cpf: '756.896.500-72',
24
+ birthdate: '1979-10-10',
25
+ address: {
26
+ number: '',
27
+ state: '',
28
+ street: '',
29
+ complement: '',
30
+ neighborhood: '',
31
+ city: '',
32
+ zipCode: '',
33
+ country: ''
34
+ },
35
+ email: '',
36
+ sex: 'M',
37
+ maritalStatus: 'NONE',
38
+ documents: {
39
+ rg: {
40
+ number: '',
41
+ state: '',
42
+ issueDate: '',
43
+ issuer: ''
44
+ }
45
+ },
46
+ createdAt: '',
47
+ updatedAt: ''
48
+ },
49
+ employmentContract: {
50
+ status: 'ADMITTED',
51
+ _id: '',
52
+ fingerprint: '',
53
+ createdAt: '',
54
+ lastSeenAtExecutionID: '',
55
+ companyID: '',
56
+ customerID: '',
57
+ accountID: '',
58
+ admissionDate: '',
59
+ externalEmploymentContractID: '',
60
+ externalPersonID: '',
61
+ position: {
62
+ code: 0,
63
+ description: ''
64
+ },
65
+ establishment: {
66
+ code: 0,
67
+ description: '',
68
+ cnpj: ''
69
+ },
70
+ startDateOfCurrentSituation: '',
71
+ situation: {
72
+ code: 0,
73
+ description: '',
74
+ origin: 'TRANSFER_IN',
75
+ transfer: {
76
+ from: {
77
+ externalEmploymentContractID: '',
78
+ externalCompanyID: ''
79
+ },
80
+ to: {
81
+ externalEmploymentContractID: '',
82
+ externalCompanyID: ''
83
+ },
84
+ transferredAt: new Date('2025-05-29T15:05:10.431+0000')
85
+ }
86
+ },
87
+ dependents: [],
88
+ isDeleted: false,
89
+ revision: 0,
90
+ employmentContractID: '',
91
+ mothersName: '',
92
+ costCenter: {
93
+ code: '',
94
+ description: ''
95
+ },
96
+ businessUnit: {
97
+ code: '',
98
+ description: ''
99
+ },
100
+ phone: '',
101
+ cellphone: '',
102
+ externalDeliveryAddress: {
103
+ address: {
104
+ number: '',
105
+ street: '',
106
+ complement: '',
107
+ neighborhood: '',
108
+ city: '',
109
+ state: '',
110
+ zipCode: '',
111
+ country: ''
112
+ },
113
+ externalDeliveryAddressID: '',
114
+ externalEstablishmentCNPJ: '',
115
+ externalEstablishmentName: ''
116
+ },
117
+ originExecutionID: '',
118
+ benefits: {
119
+ DUMMY: {
120
+ options: {},
121
+ status: 'ENABLED',
122
+ value: false,
123
+ isEligible: false,
124
+ statusOriginID: ''
125
+ }
126
+ }
127
+ },
128
+ company: {
129
+ _id: '678016b2410559c21dd53226',
130
+ accountID: '681b75421180f14cd49dafc1',
131
+ cnpj: '61.585.865/0001-51',
132
+ businessName: 'RD Saude',
133
+ tradeName: 'Raia Drogasil S/A',
134
+ createdAt: '2025-01-09T18:34:26.466Z',
135
+ updatedAt: '',
136
+ address: {
137
+ number: '',
138
+ street: '',
139
+ complement: '',
140
+ neighborhood: '',
141
+ city: '',
142
+ state: '',
143
+ zipCode: '',
144
+ country: ''
145
+ },
146
+ externalCompanyID: ''
147
+ },
148
+ payrollConfiguration: {
149
+ _id: '6836097c80d6be838db32525',
150
+ accountID: '681b75421180f14cd49dafc1',
151
+ companyID: '678016b2410559c21dd53226',
152
+ payrollSystem: 'LG_CLOUD',
153
+ eligibilitySource: 'BENEFIT_MODULE',
154
+ productToggle: {
155
+ isOrchestratorActive: true,
156
+ isManualExecutionActive: true,
157
+ isIntegratorActive: true
158
+ },
159
+ payrollReferenceCutoffDay: 20,
160
+ modifiedContractsWindowInDays: 15,
161
+ dataMapping: {
162
+ eligibility: [
163
+ {
164
+ benefitID: 'FLEURY_CHECKUP',
165
+ eligibilityType: 'BENEFIT',
166
+ options: {
167
+ contractID: '47d9b27a-1933-47d5-856b-6b827cb43d2c'
168
+ },
169
+ settings: {
170
+ revoke: {
171
+ shouldScheduleRevoke: false,
172
+ daysInAdvanceToScheduleRevoke: 1
173
+ },
174
+ grant: {
175
+ shouldGrantBeforeAdmissionDate: false,
176
+ daysBeforeAdmissionDateToGrant: 1
177
+ }
178
+ },
179
+ eligibilityMap: [],
180
+ eligibilityCode: ''
181
+ },
182
+ {
183
+ benefitID: 'FLEURY_CHECKUP',
184
+ eligibilityType: 'BENEFIT',
185
+ options: {
186
+ contractID: '47d9b27a-1933-47d5-856b-6b827cb43d2c'
187
+ },
188
+ settings: {
189
+ revoke: {
190
+ shouldScheduleRevoke: false,
191
+ daysInAdvanceToScheduleRevoke: 1
192
+ },
193
+ grant: {
194
+ shouldGrantBeforeAdmissionDate: false,
195
+ daysBeforeAdmissionDateToGrant: 1
196
+ }
197
+ },
198
+ eligibilityMap: [],
199
+ eligibilityCode: ''
200
+ },
201
+ {
202
+ benefitID: 'FLEURY_TELEMEDICINA',
203
+ eligibilityType: 'BENEFIT',
204
+ options: {
205
+ contractID: '06f5c5c3-8b5d-4df5-a8ab-d671a5752c11'
206
+ },
207
+ settings: {
208
+ revoke: {
209
+ shouldScheduleRevoke: false,
210
+ daysInAdvanceToScheduleRevoke: 1
211
+ },
212
+ grant: {
213
+ shouldGrantBeforeAdmissionDate: false,
214
+ daysBeforeAdmissionDateToGrant: 1
215
+ }
216
+ },
217
+ eligibilityMap: [],
218
+ eligibilityCode: ''
219
+ }
220
+ ],
221
+ deduction: [],
222
+ situation: [],
223
+ events: [],
224
+ rechargeTemplate: []
225
+ },
226
+ version: 3,
227
+ isDeleted: false,
228
+ createdAt: '2025-05-27T18:50:36.135Z',
229
+ updatedAt: '',
230
+ deletedAt: ''
231
+ },
232
+ dependent: {
233
+ status: 'LINKED',
234
+ name: '',
235
+ cpf: '',
236
+ sex: 'M',
237
+ maritalStatus: 'NONE',
238
+ benefits: {
239
+ DUMMY: {
240
+ options: {},
241
+ status: 'ENABLED',
242
+ value: false,
243
+ isEligible: false,
244
+ statusOriginID: ''
245
+ }
246
+ },
247
+ isDeleted: false,
248
+ mothersName: '',
249
+ externalDependentID: '',
250
+ externalDependentCode: '',
251
+ birthDate: '',
252
+ relationshipType: 'OTHER'
253
+ }
254
+ },
255
+ eligibilityOptions: {
256
+ externalBenefitID: 'NV101.1',
257
+ plan: {
258
+ name: 'CLUBE DE BENEFICIOS',
259
+ externalPorductID: 'NV101.1'
260
+ }
261
+ },
262
+ ctx: {},
263
+ hooksCtx: {},
264
+ log: {},
265
+ origin: 'test',
266
+ requiresPlanApproval: false,
267
+ planID: '',
268
+ planApprovalStatus: 'APPROVED',
269
+ createdAt: new Date('2025-05-29T15:05:10.431+0000'),
270
+ updatedAt: new Date('2025-05-29T20:30:03.720+0000'),
271
+ deductionInput: {
272
+ value: 0,
273
+ date: '',
274
+ isAccumulative: false
275
+ }
276
+ } satisfies DeepRequired<z.infer<typeof DeductionActionSchema>>;