@cargo-ai/cli 1.0.120 → 1.0.122

package/build/utils/actionDryRun.d.ts

@@ -0,0 +1,90 @@
+import { type SampleSubject } from "./sampleFromSchema.js";
+/** A single action runs as one node with this slug (`ACTION_NODE_SLUG`). */
+export declare const DRY_RUN_NODE_SLUG = "action";
+export declare const DRY_RUN_NOTE = "Sample data generated from the output schema. Nothing ran and no credits were used.";
+export type DryRunCreditsCost = {
+    type: string;
+    cost: number;
+    unit?: string;
+    unitsCount?: number;
+    fixedCost?: number;
+    config?: {
+        jsonSchema?: unknown;
+    };
+};
+/** The fields of an integration or native action this needs. */
+export type DryRunActionDefinition = {
+    name?: string;
+    config?: {
+        schema?: unknown;
+    };
+    output?: {
+        schema?: unknown;
+    };
+    credits?: {
+        costs?: DryRunCreditsCost[];
+    };
+};
+export type DataValidation = {
+    valid: true;
+} | {
+    valid: false;
+    errors: string[];
+};
+export type CreditsEstimate = {
+    /** What one call costs; for a metered price, one unit or one block of them. */
+    credits: number;
+    /** How the number was reached, and what it scales with when it does. */
+    formula: string;
+};
+export type DryRunResult = {
+    run: {
+        status: "success";
+        executions: {
+            nodeSlug: string;
+            title: string;
+            status: "success";
+            creditsUsedCount: number;
+        }[];
+    };
+    runContext: {
+        action: unknown;
+    };
+    runComputedConfigs: {
+        action: unknown;
+    };
+    dryRun: {
+        sample: true;
+        estimatedCredits: number;
+        creditsFormula: string;
+        note: string;
+    };
+};
+/**
+ * Check `--data` against the action's input schema, the way the run would.
+ * A missing or empty schema accepts anything: the action takes no declared
+ * inputs, or declares them at run time.
+ */
+export declare function validateActionData(schema: unknown, data: unknown): DataValidation;
+/**
+ * The price of one call, read the way billing reads it: the first cost entry
+ * whose `config.jsonSchema` the inputs match (an LLM model, a phone-or-email
+ * toggle), then that entry's shape.
+ *
+ * A metered price depends on what the call returns, so it is shown for one
+ * unit (or one block of them) with the formula that scales it.
+ */
+export declare function estimateCredits(costs: DryRunCreditsCost[] | undefined, data: unknown): CreditsEstimate;
+/**
+ * Whether the action is about a company or a person, read off its slug and
+ * name, so a bare `name` in its output samples as the right kind of name.
+ */
+export declare function sampleSubjectFor(actionSlug: string, actionName: string | undefined): SampleSubject;
+export declare function buildDryRunResult(input: {
+    title: string;
+    data: unknown;
+    outputSchema: unknown;
+    subject: SampleSubject;
+    estimate: CreditsEstimate;
+}): DryRunResult;
+//# sourceMappingURL=actionDryRun.d.ts.map

package/build/utils/actionDryRun.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actionDryRun.d.ts","sourceRoot":"","sources":["../../src/utils/actionDryRun.ts"],"names":[],"mappings":"AASA,OAAO,EAAoB,KAAK,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE7E,4EAA4E;AAC5E,eAAO,MAAM,iBAAiB,WAAW,CAAC;AAE1C,eAAO,MAAM,YAAY,wFAC8D,CAAC;AAExF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CACnC,CAAC;AAEF,gEAAgE;AAChE,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IAC9B,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IAC9B,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAA;KAAE,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,cAAc,GACtB;IAAE,KAAK,EAAE,IAAI,CAAA;CAAE,GACf;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAEvC,MAAM,MAAM,eAAe,GAAG;IAC5B,+EAA+E;IAC/E,OAAO,EAAE,MAAM,CAAC;IAChB,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE;QACH,MAAM,EAAE,SAAS,CAAC;QAClB,UAAU,EAAE;YACV,QAAQ,EAAE,MAAM,CAAC;YACjB,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,SAAS,CAAC;YAClB,gBAAgB,EAAE,MAAM,CAAC;SAC1B,EAAE,CAAC;KACL,CAAC;IACF,UAAU,EAAE;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC;IAChC,kBAAkB,EAAE;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC;IACxC,MAAM,EAAE;QACN,MAAM,EAAE,IAAI,CAAC;QACb,gBAAgB,EAAE,MAAM,CAAC;QACzB,cAAc,EAAE,MAAM,CAAC;QACvB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,EACf,IAAI,EAAE,OAAO,GACZ,cAAc,CAYhB;AAkBD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,iBAAiB,EAAE,GAAG,SAAS,EACtC,IAAI,EAAE,OAAO,GACZ,eAAe,CAiDjB;AAWD;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GAAG,SAAS,GAC7B,aAAa,CA2Bf;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,YAAY,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,aAAa,CAAC;IACvB,QAAQ,EAAE,eAAe,CAAC;CAC3B,GAAG,YAAY,CAwBf"}

package/build/utils/actionDryRun.js

@@ -0,0 +1,145 @@
+// The pure half of `cargo-ai orchestration action execute --dry-run`: check the
+// inputs against the action's own schema, price the call, and dress a sample
+// output in the shape a real waited run returns. The command fetches the
+// action definition and hands it here; nothing in this file touches the
+// network.
+import { validate as jsonSchemaValidate } from "jsonschema";
+import { sampleFromSchema } from "./sampleFromSchema.js";
+/** A single action runs as one node with this slug (`ACTION_NODE_SLUG`). */
+export const DRY_RUN_NODE_SLUG = "action";
+export const DRY_RUN_NOTE = "Sample data generated from the output schema. Nothing ran and no credits were used.";
+/**
+ * Check `--data` against the action's input schema, the way the run would.
+ * A missing or empty schema accepts anything: the action takes no declared
+ * inputs, or declares them at run time.
+ */
+export function validateActionData(schema, data) {
+    if (isObject(schema) === false || Object.keys(schema).length === 0) {
+        return { valid: true };
+    }
+    const result = jsonSchemaValidate(data, schema);
+    if (result.valid === true) {
+        return { valid: true };
+    }
+    return { valid: false, errors: result.errors.map(formatValidationError) };
+}
+function formatValidationError(error) {
+    const path = error.property
+        .replace(/^instance\.?/, "")
+        .replace(/^\[/, "")
+        .replace(/\]\[/g, ".")
+        .replace(/[[\]]/g, "");
+    if (error.name === "required" && typeof error.argument === "string") {
+        const field = path === "" ? error.argument : `${path}.${error.argument}`;
+        return `Missing required field: ${field}`;
+    }
+    return `${path === "" ? "data" : path}: ${error.message}`;
+}
+/**
+ * The price of one call, read the way billing reads it: the first cost entry
+ * whose `config.jsonSchema` the inputs match (an LLM model, a phone-or-email
+ * toggle), then that entry's shape.
+ *
+ * A metered price depends on what the call returns, so it is shown for one
+ * unit (or one block of them) with the formula that scales it.
+ */
+export function estimateCredits(costs, data) {
+    if (costs === undefined || costs.length === 0) {
+        return { credits: 0, formula: "This action costs no credits." };
+    }
+    const cost = costs.find((entry) => {
+        if (entry.config === undefined || entry.config.jsonSchema === undefined) {
+            return true;
+        }
+        return (jsonSchemaValidate(data, entry.config.jsonSchema).valid === true);
+    });
+    if (cost === undefined) {
+        return {
+            credits: 0,
+            formula: "No price matches these inputs, so billing would charge nothing for them.",
+        };
+    }
+    const fixedCost = cost.fixedCost === undefined ? 0 : cost.fixedCost;
+    const base = fixedCost === 0 ? "" : `${formatCredits(fixedCost)} + `;
+    if (cost.type === "unit") {
+        const unit = cost.unit === undefined ? "unit" : cost.unit;
+        return {
+            credits: roundCredits(fixedCost + cost.cost),
+            formula: `${base}${formatCredits(cost.cost)} × <${unit}s returned> credits (shown for 1 ${unit})`,
+        };
+    }
+    if (cost.type === "package") {
+        const unit = cost.unit === undefined ? "unit" : cost.unit;
+        const unitsCount = cost.unitsCount === undefined ? 1 : cost.unitsCount;
+        return {
+            credits: roundCredits(fixedCost + cost.cost),
+            formula: `${base}${formatCredits(cost.cost)} × ceil(<${unit}s used> / ${String(unitsCount)}) credits (shown for one block of ${String(unitsCount)} ${unit}s)`,
+        };
+    }
+    return {
+        credits: roundCredits(cost.cost),
+        formula: `${formatCredits(cost.cost)} credits per call`,
+    };
+}
+/** Prices from the API (`0.175 + 0.025`) print without their float artifacts. */
+function roundCredits(value) {
+    return Math.round(value * 10000) / 10000;
+}
+function formatCredits(value) {
+    return String(roundCredits(value));
+}
+/**
+ * Whether the action is about a company or a person, read off its slug and
+ * name, so a bare `name` in its output samples as the right kind of name.
+ */
+export function sampleSubjectFor(actionSlug, actionName) {
+    const text = `${actionSlug} ${actionName === undefined ? "" : actionName}`
+        .toLowerCase()
+        .replace(/[^a-z]/g, "");
+    if (text.includes("person") ||
+        text.includes("people") ||
+        text.includes("contact") ||
+        text.includes("email") ||
+        text.includes("phone") ||
+        text.includes("lead")) {
+        return "person";
+    }
+    if (text.includes("company") ||
+        text.includes("companies") ||
+        text.includes("organization") ||
+        text.includes("account") ||
+        text.includes("domain")) {
+        return "company";
+    }
+    return "person";
+}
+export function buildDryRunResult(input) {
+    return {
+        run: {
+            status: "success",
+            executions: [
+                {
+                    nodeSlug: DRY_RUN_NODE_SLUG,
+                    title: input.title,
+                    status: "success",
+                    creditsUsedCount: 0,
+                },
+            ],
+        },
+        runContext: {
+            action: sampleFromSchema(input.outputSchema, { subject: input.subject }),
+        },
+        runComputedConfigs: { action: input.data },
+        dryRun: {
+            sample: true,
+            estimatedCredits: input.estimate.credits,
+            creditsFormula: input.estimate.formula,
+            note: DRY_RUN_NOTE,
+        },
+    };
+}
+function isObject(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        Array.isArray(value) === false);
+}

package/build/utils/sampleFromSchema.d.ts

@@ -0,0 +1,15 @@
+/** What the whole sample is about, which decides what a bare `name` means. */
+export type SampleSubject = "person" | "company";
+export type SampleOptions = {
+    /** Defaults to "person". A company enrichment's `name` is a company name. */
+    subject?: SampleSubject;
+};
+export declare function sampleFromSchema(schema: unknown, options?: SampleOptions): unknown;
+/**
+ * Whether a schema says enough about an output to sample it. `{}`, a bare
+ * `{ type: "object" }` and a free-form record all describe "some object", and
+ * a sample of one would be `{}` — which reads as "this action returns nothing"
+ * rather than "the shape is decided at run time".
+ */
+export declare function describesOutput(schema: unknown): boolean;
+//# sourceMappingURL=sampleFromSchema.d.ts.map

package/build/utils/sampleFromSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sampleFromSchema.d.ts","sourceRoot":"","sources":["../../src/utils/sampleFromSchema.ts"],"names":[],"mappings":"AAcA,8EAA8E;AAC9E,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEjD,MAAM,MAAM,aAAa,GAAG;IAC1B,6EAA6E;IAC7E,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB,CAAC;AAmBF,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,OAAO,EACf,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAST;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAExD"}