@enerlence/suntropy-cli 0.4.0 → 0.5.1

package/README.md

@@ -209,6 +209,51 @@ suntropy solarform calculate --data '{"center":{"lat":37.39,"lng":-5.99},...}'
 suntropy solarform config
 ```
 
+### `suntropy ppa` - PPA Analysis
+
+Read PPA (Power Purchase Agreement) templates and run PPA simulations on a solar study.
+
+```bash
+# Read-only templates
+suntropy ppa templates list --fields _id,name,mode,ppaPrice,useInSolarForm
+suntropy ppa templates get <ppaTemplateId>
+
+# Run a PPA simulation on a study (read-only, does not persist)
+suntropy ppa calculate --study <studyId>                       # uses client useInSolarForm templates
+suntropy ppa calculate --study <studyId> --template <ppaTemplateId>   # uses a single template
+cat study.json | suntropy ppa calculate --data -               # full SolarStudy via stdin
+suntropy ppa calculate --study <studyId> --raw --save-file ppa.json
+```
+
+The response is the study with `economicResults.ppaAnalysis` populated
+(`simulationResults[].profitabilityResults` → `irr`, `paybackYears`). Heavy
+PowerCurve objects are summarized unless `--raw` is passed.
+
+### `suntropy shareables` - Shareable Links
+
+Create shareable links for studies (sharing service, exposed under `/templates`).
+The backend fills `uid`, `url`, `clientUID` and `idShareable` from the token.
+
+```bash
+# Public shareable for a solar study
+suntropy shareables create --element-id <studyId>
+
+# With template, name and expiration
+suntropy shareables create --element-id <studyId> \
+  --template-id <templateId> --name "Estudio Juan" --expiration-date 2026-12-31
+
+# Private (password) + send to recipients
+suntropy shareables create --element-id <studyId> \
+  --privacy PRIVATE --password secret --email-list "a@x.com;b@y.com"
+
+# Extra link query params / extra DTO fields
+suntropy shareables create --element-id <studyId> --link-params "utm_source=cli"
+suntropy shareables create --element-id <studyId> --data '{"customLayout":true}'
+```
+
+`--element-type` (default `solarStudy`): `solarStudy | colectiveSolarStudy | veChargerStudy | heatpumpStudy | billing`.
+`--shareable-type` (default `TEMPLATE`): `TEMPLATE | CONTRACT`. The response includes the public `url` and `uid`.
+
 ### `suntropy config` - Configuration
 
 ```bash

package/dist/bin/suntropy.js

@@ -4044,10 +4044,173 @@ Examples:
   });
 }
 
+// src/commands/ppa/index.ts
+function getGlobalOpts12(cmd) {
+  let root = cmd;
+  while (root.parent) root = root.parent;
+  return root.opts();
+}
+function readStdin3() {
+  return new Promise((resolve, reject) => {
+    let data = "";
+    process.stdin.setEncoding("utf-8");
+    process.stdin.on("data", (chunk) => {
+      data += chunk;
+    });
+    process.stdin.on("end", () => resolve(data));
+    process.stdin.on("error", reject);
+  });
+}
+async function parseData5(data) {
+  if (!data) return void 0;
+  if (data === "-") {
+    const input = await readStdin3();
+    return JSON.parse(input);
+  }
+  return JSON.parse(data);
+}
+function compactStudyOutput2(study) {
+  if (study === null || study === void 0 || typeof study !== "object") return study;
+  if (Array.isArray(study)) return study.map(compactStudyOutput2);
+  const record = study;
+  if (Array.isArray(record.days) && record.days.length > 0 && record.identifier !== void 0) {
+    return { _type: "PowerCurve", days: record.days.length, identifier: record.identifier };
+  }
+  const result = {};
+  for (const [key, val] of Object.entries(record)) {
+    if (val && typeof val === "object" && !Array.isArray(val)) {
+      const v = val;
+      if (Array.isArray(v.days) && v.days.length > 0 && v.identifier !== void 0) {
+        result[key] = { _type: "PowerCurve", days: v.days.length, identifier: v.identifier };
+        continue;
+      }
+    }
+    result[key] = compactStudyOutput2(val);
+  }
+  return result;
+}
+function registerPPACommands(program2) {
+  const ppa = program2.command("ppa").description(
+    "PPA (Power Purchase Agreement) analysis.\nRead PPA templates and run PPA simulations on a solar study."
+  );
+  const templates = ppa.command("templates").description("Read-only access to the client PPA templates.");
+  templates.command("list").description(
+    "List all PPA templates for the authenticated client.\nExample:\n  suntropy ppa templates list --fields _id,name,mode,ppaPrice,useInSolarForm"
+  ).action(async () => {
+    try {
+      const global = getGlobalOpts12(ppa);
+      const client = createServiceClient("solar", global);
+      const res = await client.get("/solar-study/ppa-templates");
+      output(res.data, global);
+    } catch (err) {
+      outputError(handleApiError(err));
+    }
+  });
+  templates.command("get <id>").description(
+    "Get a single PPA template by its Mongo _id.\nExample:\n  suntropy ppa templates get 665f0a1b2c3d4e5f60718293"
+  ).action(async (id) => {
+    try {
+      const global = getGlobalOpts12(ppa);
+      const client = createServiceClient("solar", global);
+      const res = await client.get(`/solar-study/ppa-templates/${id}`);
+      output(res.data, global);
+    } catch (err) {
+      outputError(handleApiError(err));
+    }
+  });
+  ppa.command("calculate").description(
+    "Run PPA simulations on a solar study (read-only, does not persist).\n\nProvide the study via --study <id> (downloaded from the API) or --data <json>|- (full SolarStudy).\nWith --template <ppaTemplateId> the simulation uses that single PPA template;\nwithout it, the backend uses the client templates flagged useInSolarForm.\n\nNote: the study must include consumption and economicResults (a study fetched\nby --study already does). The response is the study with economicResults.ppaAnalysis populated.\n\nExamples:\n  suntropy ppa calculate --study 665f0a1b2c3d4e5f60718293\n  suntropy ppa calculate --study 665f... --template 6700aa11bb22cc33dd44ee55\n  cat study.json | suntropy ppa calculate --data -"
+  ).option("--study <id>", "Solar study Mongo id to download and analyze").option("--data <json>", "Full SolarStudy JSON body (or - for stdin)").option("--template <ppaTemplateId>", "PPA template id to apply (defaults to client useInSolarForm templates)").option("--raw", "Return full study with PowerCurve data (no compaction)").option("--save-file <file>", "Save result to local file").action(async (opts) => {
+    try {
+      const global = getGlobalOpts12(ppa);
+      const client = createServiceClient("solar", global);
+      let study;
+      if (opts.study) {
+        const res2 = await client.get(`/solar-study/findById/${opts.study}`);
+        study = res2.data;
+      } else if (opts.data) {
+        study = await parseData5(opts.data);
+      } else {
+        outputError(new Error("Provide --study <id> or --data <json>|- (full SolarStudy)."));
+        return;
+      }
+      const body = { data: study };
+      if (opts.template) body.ppaTemplateId = opts.template;
+      const res = await client.post("/solar-study/calculate-ppa-on-study", body);
+      const result = opts.raw ? res.data : compactStudyOutput2(res.data);
+      output(result, { ...global, save: opts.saveFile || global.save });
+    } catch (err) {
+      outputError(handleApiError(err));
+    }
+  });
+}
+
+// src/commands/shareables/index.ts
+function getGlobalOpts13(cmd) {
+  let root = cmd;
+  while (root.parent) root = root.parent;
+  return root.opts();
+}
+function readStdin4() {
+  return new Promise((resolve, reject) => {
+    let data = "";
+    process.stdin.setEncoding("utf-8");
+    process.stdin.on("data", (chunk) => {
+      data += chunk;
+    });
+    process.stdin.on("end", () => resolve(data));
+    process.stdin.on("error", reject);
+  });
+}
+async function parseData6(data) {
+  if (!data) return void 0;
+  if (data === "-") {
+    const input = await readStdin4();
+    return JSON.parse(input);
+  }
+  return JSON.parse(data);
+}
+function registerShareableCommands(program2) {
+  const shareables = program2.command("shareables").description(
+    "Create shareable links for studies (sharing service, exposed under /templates)."
+  );
+  shareables.command("create").description(
+    'Create a shareable link for a study (POST /shareable).\nThe backend fills uid, url, clientUID and idShareable from the token.\n\nelementType: solarStudy (default), colectiveSolarStudy, veChargerStudy, heatpumpStudy, billing\nshareableType: TEMPLATE (default), CONTRACT\nprivacy: PUBLIC (default), PRIVATE (use --password)\n\nExamples:\n  suntropy shareables create --element-id 665f0a1b2c3d4e5f60718293\n  suntropy shareables create --element-id 665f... --template-id 6700aa... --name "Estudio Juan"\n  suntropy shareables create --element-id 665f... --privacy PRIVATE --password secret --email-list "a@x.com;b@y.com"\n  suntropy shareables create --element-id 665f... --expiration-date 2026-12-31 --link-params "utm_source=cli"'
+  ).requiredOption("--element-id <id>", "Id of the element (study) to share").option("--element-type <type>", "solarStudy | colectiveSolarStudy | veChargerStudy | heatpumpStudy | billing", "solarStudy").option("--shareable-type <type>", "TEMPLATE | CONTRACT", "TEMPLATE").option("--privacy <privacy>", "PUBLIC | PRIVATE", "PUBLIC").option("--template-id <id>", "Template id to apply to the shareable").option("--name <name>", "Descriptive name for the shareable").option("--password <pwd>", "Protect the link with a password (implies PRIVATE)").option("--expiration-date <date>", "Expiration date (e.g. 2026-12-31)").option("--activation-date <date>", "Activation date (e.g. 2026-01-01)").option("--email-list <emails>", "Semicolon-separated list of recipient emails").option("--reply-to <email>", "Reply-to email for notifications").option("--custom-layout", "Enable custom layout").option("--read-only", "Mark the shareable as read-only").option("--link-params <qs>", "Extra query params appended to the shareable link (k=v&k2=v2)").option("--data <json>", "Extra ShareableDto fields as JSON (or - for stdin), merged last").action(async (opts) => {
+    try {
+      const global = getGlobalOpts13(shareables);
+      const client = createServiceClient("templates", global);
+      const extra = await parseData6(opts.data) || {};
+      const body = {
+        elementId: opts.elementId,
+        elementType: opts.elementType,
+        shareableType: opts.shareableType,
+        privacy: opts.password ? "PRIVATE" : opts.privacy,
+        ...opts.templateId ? { templateId: opts.templateId } : {},
+        ...opts.name ? { name: opts.name } : {},
+        ...opts.password ? { password: opts.password, passwordConfirm: opts.password } : {},
+        ...opts.expirationDate ? { expirationDate: opts.expirationDate } : {},
+        ...opts.activationDate ? { activationDate: opts.activationDate } : {},
+        ...opts.emailList ? { emailList: opts.emailList } : {},
+        ...opts.replyTo ? { replyTo: opts.replyTo } : {},
+        ...opts.customLayout ? { customLayout: true } : {},
+        ...opts.readOnly ? { readOnly: true } : {},
+        ...extra
+      };
+      const url = opts.linkParams ? `/shareable?${opts.linkParams}` : "/shareable";
+      const res = await client.post(url, body);
+      output(res.data, { ...global, save: global.save });
+    } catch (err) {
+      outputError(handleApiError(err));
+    }
+  });
+}
+
 // src/index.ts
+var CLI_VERSION = true ? "0.5.1" : "0.0.0-dev";
 function createProgram() {
   const program2 = new Command2();
-  program2.name("suntropy").description("Agent-first CLI for Suntropy solar platform. Optimized for programmatic data manipulation and progressive exploration.").version("0.1.0").option("--format <format>", "Output format: json (default), human, csv", "json").option("--fields <fields>", "Comma-separated fields to include in output").option("--server <url>", "Override API server URL").option("--token <jwt>", "Override authentication token").option("--profile <name>", "Use a specific config profile").option("--verbose", "Show HTTP request/response details on stderr").option("--quiet", "Suppress non-data output").option("--save <file>", "Save output to file (also writes to stdout)");
+  program2.name("suntropy").description("Agent-first CLI for Suntropy solar platform. Optimized for programmatic data manipulation and progressive exploration.").version(CLI_VERSION).option("--format <format>", "Output format: json (default), human, csv", "json").option("--fields <fields>", "Comma-separated fields to include in output").option("--server <url>", "Override API server URL").option("--token <jwt>", "Override authentication token").option("--profile <name>", "Use a specific config profile").option("--verbose", "Show HTTP request/response details on stderr").option("--quiet", "Suppress non-data output").option("--save <file>", "Save output to file (also writes to stdout)");
   registerAuthCommands(program2);
   registerConfigCommands(program2);
   registerInventoryCommands(program2);
@@ -4055,6 +4218,8 @@ function createProgram() {
   registerCurvesCommands(program2);
   registerConsumptionCommands(program2);
   registerSolarformCommands(program2);
+  registerPPACommands(program2);
+  registerShareableCommands(program2);
   return program2;
 }