@stackfactor/client-api 1.3.6 → 1.5.0

package/dist/cjs/lib/avatar.d.ts

@@ -24,15 +24,13 @@ export interface StoredAvatar {
 }
 /**
  * A generated avatar, from the run that generated it. The caller says nothing
- * about WHICH avatar: the run ticket names the run, and the run's own record
+ * about WHICH avatar: its AGENT token names the run, and the run's own record
  * says which element, type and store. Called by the image agent's event
- * handler with the token the execution was started with and the ticket from
- * its envelope (`request.runTicket`).
+ * handler with the token the execution was started with.
  * @param {AvatarFile[]} files The PNG for each stored size
  * @param {Object|null} usage The generator's usage descriptor (`{ cost, tokens }`), so the credits are charged to the element; null when none
- * @param {String} token The execution's token
- * @param {String} runTicket The ticket from this run's envelope
+ * @param {String} token The run's AGENT token (it names the run)
  * @returns {Promise<StoredAvatar>}
  */
-export declare const storeAvatar: (files: AvatarFile[], usage: Record<string, unknown> | null, token: string, runTicket: string) => Promise<StoredAvatar>;
+export declare const storeAvatar: (files: AvatarFile[], usage: Record<string, unknown> | null, token: string) => Promise<StoredAvatar>;
 //# sourceMappingURL=avatar.d.ts.map

package/dist/cjs/lib/avatar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"avatar.d.ts","sourceRoot":"","sources":["../../../src/lib/avatar.ts"],"names":[],"mappings":"AAIA;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,GACpB,WAAW,MAAM,EACjB,MAAM,MAAM,EACZ,OAAO,MAAM,EACb,QAAQ,MAAM,EACd,OAAO,MAAM,EACb,QAAO,MAAW,KACjB,OAAO,CAAC,IAAI,CAmBd,CAAC;AAEF,8DAA8D;AAC9D,MAAM,WAAW,UAAU;IACzB,gGAAgG;IAChG,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,8BAA8B;AAC9B,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,WAAW,GACtB,OAAO,UAAU,EAAE,EACnB,OAAO,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,EACrC,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,YAAY,CAiBtB,CAAC"}
+{"version":3,"file":"avatar.d.ts","sourceRoot":"","sources":["../../../src/lib/avatar.ts"],"names":[],"mappings":"AAGA;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,GACpB,WAAW,MAAM,EACjB,MAAM,MAAM,EACZ,OAAO,MAAM,EACb,QAAQ,MAAM,EACd,OAAO,MAAM,EACb,QAAO,MAAW,KACjB,OAAO,CAAC,IAAI,CAmBd,CAAC;AAEF,8DAA8D;AAC9D,MAAM,WAAW,UAAU;IACzB,gGAAgG;IAChG,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,8BAA8B;AAC9B,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,GACtB,OAAO,UAAU,EAAE,EACnB,OAAO,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,EACrC,OAAO,MAAM,KACZ,OAAO,CAAC,YAAY,CAiBtB,CAAC"}

package/dist/cjs/lib/avatar.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.storeAvatar = exports.getAvatar = void 0;
 const axiosClient_js_1 = require("./axiosClient.js");
-const integration_js_1 = require("./integration.js");
 /**
  * Get avatar for an elementId
  * @param {String} elementId
@@ -33,20 +32,18 @@ const getAvatar = (elementId, type, width, height, token, title = "") => {
 exports.getAvatar = getAvatar;
 /**
  * A generated avatar, from the run that generated it. The caller says nothing
- * about WHICH avatar: the run ticket names the run, and the run's own record
+ * about WHICH avatar: its AGENT token names the run, and the run's own record
  * says which element, type and store. Called by the image agent's event
- * handler with the token the execution was started with and the ticket from
- * its envelope (`request.runTicket`).
+ * handler with the token the execution was started with.
  * @param {AvatarFile[]} files The PNG for each stored size
  * @param {Object|null} usage The generator's usage descriptor (`{ cost, tokens }`), so the credits are charged to the element; null when none
- * @param {String} token The execution's token
- * @param {String} runTicket The ticket from this run's envelope
+ * @param {String} token The run's AGENT token (it names the run)
  * @returns {Promise<StoredAvatar>}
  */
-const storeAvatar = (files, usage, token, runTicket) => {
+const storeAvatar = (files, usage, token) => {
     return new Promise((resolve, reject) => {
         const request = axiosClient_js_1.client.post("/api/v1/avatar/store", { files, usage }, {
-            headers: { authorization: token, [integration_js_1.RUN_TICKET_HEADER]: runTicket },
+            headers: { authorization: token },
         });
         request
             .then((response) => {

package/dist/cjs/lib/avatar.js.map

@@ -1 +1 @@
-{"version":3,"file":"avatar.js","sourceRoot":"","sources":["../../../src/lib/avatar.ts"],"names":[],"mappings":";;;AACA,qDAA0C;AAC1C,qDAAqD;AAErD;;;;;;;;;GASG;AACI,MAAM,SAAS,GAAG,CACvB,SAAiB,EACjB,IAAY,EACZ,KAAa,EACb,MAAc,EACd,KAAa,EACb,QAAgB,EAAE,EACH,EAAE;IACjB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,mBAAmB,GAAG,uBAAM,CAAC,GAAG,CACpC,4BAA4B,SAAS,IAAI,IAAI,IAAI,KAAK,IAAI,MAAM,GAAG,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAC7H;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,KAAK;aACrB;YACD,YAAY,EAAE,MAAM;SACrB,CACF,CAAC;QACF,mBAAmB;aAChB,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,EAAE;YACV,MAAM,CAAC,sBAAsB,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AA1BW,QAAA,SAAS,aA0BpB;AAiBF;;;;;;;;;;;GAWG;AACI,MAAM,WAAW,GAAG,CACzB,KAAmB,EACnB,KAAqC,EACrC,KAAa,EACb,SAAiB,EACM,EAAE;IACzB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,sBAAsB,EACtB,EAAE,KAAK,EAAE,KAAK,EAAE,EAChB;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,kCAAiB,CAAC,EAAE,SAAS,EAAE;SAClE,CACF,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAtBW,QAAA,WAAW,eAsBtB"}
+{"version":3,"file":"avatar.js","sourceRoot":"","sources":["../../../src/lib/avatar.ts"],"names":[],"mappings":";;;AACA,qDAA0C;AAE1C;;;;;;;;;GASG;AACI,MAAM,SAAS,GAAG,CACvB,SAAiB,EACjB,IAAY,EACZ,KAAa,EACb,MAAc,EACd,KAAa,EACb,QAAgB,EAAE,EACH,EAAE;IACjB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,mBAAmB,GAAG,uBAAM,CAAC,GAAG,CACpC,4BAA4B,SAAS,IAAI,IAAI,IAAI,KAAK,IAAI,MAAM,GAAG,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAC7H;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,KAAK;aACrB;YACD,YAAY,EAAE,MAAM;SACrB,CACF,CAAC;QACF,mBAAmB;aAChB,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,EAAE;YACV,MAAM,CAAC,sBAAsB,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AA1BW,QAAA,SAAS,aA0BpB;AAiBF;;;;;;;;;GASG;AACI,MAAM,WAAW,GAAG,CACzB,KAAmB,EACnB,KAAqC,EACrC,KAAa,EACU,EAAE;IACzB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,sBAAsB,EACtB,EAAE,KAAK,EAAE,KAAK,EAAE,EAChB;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;SAClC,CACF,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AArBW,QAAA,WAAW,eAqBtB"}

package/dist/cjs/lib/integration.d.ts

@@ -99,7 +99,7 @@ export declare const setDefaultIntegration: (id: string, token: string, capabili
  * resolved configuration, the identity to act as). Called by the agent runtime
  * in run-once mode with the token the execution was started with.
  * @param {String} batchJobId The event record the execution was started for
- * @param {String} token The execution's token
+ * @param {String} token The run's AGENT token (it names the run)
  */
 export declare const getExecutionEnvelope: (batchJobId: string, token: string) => Promise<object>;
 /** One permission an integration may ask an organization for. */
@@ -119,8 +119,6 @@ export interface DeclarablePermission {
  * @param {String} token Authorization token (Admin - Manage Interoperability)
  */
 export declare const getDeclarablePermissions: (token: string) => Promise<DeclarablePermission[]>;
-/** The request header an agent returns its run ticket in. */
-export declare const RUN_TICKET_HEADER = "x-stackfactor-run-ticket";
 /** How an execution settles its run. */
 export declare const EXECUTION_OUTCOME: {
     readonly COMPLETED: 2;
@@ -144,53 +142,170 @@ export interface SettledExecution {
  * An execution claiming its run, once: PENDING → RUNNING. Of however many
  * executions the transport may start for one run, exactly one claim answers
  * `claimed: true`; the others get `claimed: false` and should exit without
- * doing the work. Which run is never sent: the run ticket names it. Called by
- * the agent runtime at start, with the token the execution was started with
- * (or, for an anonymous run, the ticket as the token).
- * @param {String} token The execution's token
- * @param {String} runTicket The ticket from this run's envelope
+ * doing the work. Which run is never sent: the run's token names it. Called by
+ * the agent runtime at start, with the token the execution was started with.
+ * @param {String} token The run's AGENT token (it names the run)
  */
-export declare const claimExecution: (token: string, runTicket: string) => Promise<ClaimedExecution>;
+export declare const claimExecution: (token: string) => Promise<ClaimedExecution>;
 /**
  * An execution keeping its run alive. Called on a fast cadence (~30 s) while
  * the handler runs, so a run that stops beating is known to be abandoned.
- * @param {String} token The execution's token
- * @param {String} runTicket The ticket from this run's envelope
+ * @param {String} token The run's AGENT token (it names the run)
  */
-export declare const heartbeatExecution: (token: string, runTicket: string) => Promise<void>;
+export declare const heartbeatExecution: (token: string) => Promise<void>;
 /**
  * An execution settling its run as COMPLETED or FAILED, with what it wants
  * remembered. `settled: false` means the run was no longer running (the
  * platform's sweeper got there first) and the outcome was not recorded.
  * @param {Number} status EXECUTION_OUTCOME.COMPLETED or FAILED
  * @param {*} outcome A result summary, or the error — kept on the run's record
- * @param {String} token The execution's token
- * @param {String} runTicket The ticket from this run's envelope
- */
-export declare const settleExecution: (status: number, outcome: unknown, token: string, runTicket: string) => Promise<SettledExecution>;
-/** One organization's settings for the calling integration. */
-export interface IntegrationTenantSettings {
-    tenant: {
-        _id: string;
-        name: string;
-    };
-    /** The tenant-level fields the integration declares, secret ones included. */
-    settings: Record<string, unknown>;
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+export declare const settleExecution: (status: number, outcome: unknown, token: string) => Promise<SettledExecution>;
+/** Notification statuses a run may move its own notification to. */
+export declare const RUN_NOTIFICATION_STATUS: {
+    readonly INPROGRESS: 5;
+    readonly COMPLETED: 6;
+    readonly FAILED: 7;
+};
+/** What a run may save its learning content as. */
+export declare const RUN_LEARNING_CONTENT_TYPE: {
+    readonly VIDEO: 2;
+    readonly TEXT_CONTENT: 3;
+};
+/** A log line a run reports; `type` defaults to "info". */
+export interface RunLogLine {
+    type?: "info" | "warning" | "error";
+    value: string;
+}
+/** A run's progress as the platform stored it. */
+export interface RunProgress {
+    percent: number;
+    message: string | null;
+    updatedAt: string;
+}
+/** The run's notification after an update; `cancelled` means stop working. */
+export interface RunNotificationState {
+    status: number;
+    cancelled: boolean;
+}
+/** The answer to a quota consume. `unlimited`: the plan does not meter the type. */
+export interface RunQuotaConsumed {
+    unlimited: boolean;
+    remaining: number | null;
+}
+/** The answer to a quota refund: the run's total refunded for the type. */
+export interface RunQuotaRefunded {
+    refunded: number;
+    remaining: number | null;
 }
+/** The learning content a run saved; `created` is false when it was there already. */
+export interface RunLearningContentSaved {
+    learningContentId: string;
+    created: boolean;
+}
+/** A learning activity of one of the run's micro-skills. */
+export interface RunActivityTarget {
+    microSkillId: string;
+    learningActivityId: string;
+}
+/** A scene's narration; `usage` is what synthesising it consumed, when known. */
+export interface RunSceneAudioStored {
+    stored: boolean;
+    usage: unknown;
+}
+/**
+ * Reports how far the run got, with log lines; kept on the run's record (the
+ * newest 200 lines).
+ * @param {Number} percent 0–100
+ * @param {String|null} message A one-line summary, e.g. "micro-skill 4 of 10"
+ * @param {RunLogLine[]} log Up to 50 lines
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+export declare const reportRunProgress: (percent: number, message: string | null, log: RunLogLine[], token: string) => Promise<RunProgress>;
+/**
+ * Moves the run's own notification to in progress, completed or failed, with
+ * the details the person sees. Resolves `cancelled: true` when the person
+ * cancelled it — the notification is left as they left it and the run should
+ * stop, clean up and settle.
+ * @param {Number} status A RUN_NOTIFICATION_STATUS value
+ * @param {*} details What the notification shows: progress, log, …
+ * @param {String|null} description Replaces the notification's text; null keeps it
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+export declare const updateRunNotification: (status: number, details: unknown, description: string | null, token: string) => Promise<RunNotificationState>;
 /**
- * The CALLING integration's own settings, for every organization that has it
- * enabled. What a scheduled run — which starts once for the platform, with no
- * identity — reads to find the tenants it works on. Nothing names an
- * integration: the run ticket the platform put in the run's envelope
- * (`request.runTicket`) decides which one is answered for.
- * @param {String} token The integration's own API token (an admin-tenant
- * service account's, holding Admin - Read Own Integration Settings)
- * @param {String} runTicket The ticket from this run's envelope
- */
-export declare const getOwnTenantSettings: (token: string, runTicket: string) => Promise<{
-    integrationId: string;
-    tenants: IntegrationTenantSettings[];
+ * Consumes generation quota (a GENERATE_* type) for the person the run acts
+ * for. Rejects with 400 QUOTA_EXCEEDED when fewer than `amount` remain.
+ * @param {String} type e.g. "GENERATE_LEARNING_CONTENT"
+ * @param {Number} amount 1–100
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+export declare const consumeRunQuota: (type: string, amount: number, token: string) => Promise<RunQuotaConsumed>;
+/**
+ * Refunds quota this same run consumed and has not refunded yet — never more;
+ * a larger refund rejects with 422.
+ * @param {String} type The type the run consumed
+ * @param {Number} amount 1–100
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+export declare const refundRunQuota: (type: string, amount: number, token: string) => Promise<RunQuotaRefunded>;
+/**
+ * Saves a micro-skill of the learning content the run was started for — a new
+ * one, or a new draft of one it has. The parent does not need to exist yet.
+ * @param {Object} microSkill `microSkillId` plus learning activities, objectives, …
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+export declare const saveRunMicroSkill: (microSkill: {
+    microSkillId: string;
+    [key: string]: unknown;
+}, token: string) => Promise<object>;
+/**
+ * Deletes a micro-skill of the run's learning content by its record id, or all
+ * of them when `id` is null — what a cancelled or failed run cleans up.
+ * @param {String|null} id The micro-skill record's id, or null for all
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+export declare const deleteRunMicroSkills: (id: string | null, token: string) => Promise<{
+    deleted: number;
 }>;
+/**
+ * Saves the learning content the run was started for, as video or text
+ * content, with the settings it was generated with. It is recorded as the work
+ * of the person the run acts for. Save it once its micro-skills are stored.
+ * @param {Number} type A RUN_LEARNING_CONTENT_TYPE value
+ * @param {Object|null} settings The generation settings; null keeps the defaults
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+export declare const saveRunLearningContent: (type: number, settings: object | null, token: string) => Promise<RunLearningContentSaved>;
+/**
+ * Stores an image or a video clip of one of the run's learning activities
+ * (PNG, JPEG or MP4, up to 100 MB). Any other type rejects with 400.
+ * @param {Object} target The activity, and the `mediaId` the file is stored as
+ * @param {Blob|Uint8Array} media The file's bytes (a Buffer is a Uint8Array)
+ * @param {String} mimeType "image/png", "image/jpeg" or "video/mp4"
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+export declare const storeRunMedia: (target: RunActivityTarget & {
+    mediaId: string;
+}, media: Blob | Uint8Array, mimeType: string, token: string) => Promise<{
+    mediaId: string;
+}>;
+/**
+ * Has the platform synthesise the narration of one scene of one of the run's
+ * video activities and store it where the player reads it. Resolves
+ * `stored: false` when there was nothing to store.
+ * @param {Object} target The activity, and the `sceneId` the narration is for
+ * @param {Object} script The narration: `items`, each with its `text`
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+export declare const storeRunSceneAudio: (target: RunActivityTarget & {
+    sceneId: string;
+}, script: {
+    items: {
+        text: string;
+    }[];
+}, token: string) => Promise<RunSceneAudioStored>;
 /**
  * Get an integration agent's live health (cheap: deploy state + Cloud Run
  * readiness; does not contact the agent). Use for the live status on the cards.

package/dist/cjs/lib/integration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"integration.d.ts","sourceRoot":"","sources":["../../../src/lib/integration.ts"],"names":[],"mappings":"AAuBA,UAAU,0BAA0B;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAC5B,MAAM,MAAM,EACZ,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAoBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAC5B,IAAI,MAAM,EACV,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,GACpC,IAAI,MAAM,EACV,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,GACxC,IAAI,MAAM,EACV,SAAS,MAAM,EACf,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mBAAmB,GAC9B,QAAQ,MAAM,EAAE,GAAG,IAAI,EACvB,YAAY,MAAM,GAAG,IAAI,EACzB,SAAS,MAAM,EACf,8BAA8B,OAAO,EACrC,iBAAiB,OAAO,EACxB,OAAO,MAAM,EACb,GAAG,SAAS,OAAO,EAAE,KACpB,OAAO,CAAC,MAAM,CAqChB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,GACtC,YAAY,MAAM,EAClB,SAAS,MAAM,EACf,8BAA8B,OAAO,EACrC,iBAAiB,OAAO,EACxB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAQd,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,GACrC,KAAK,MAAM,EACX,MAAM,MAAM,EACZ,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAqBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qCAAqC,GAChD,KAAK,MAAM,KACV,OAAO,CAAC,0BAA0B,CAyFpC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,GACrC,QAAQ,MAAM,EACd,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAC7B,IAAI,MAAM,EACV,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GACpC,IAAI,MAAM,EACV,MAAM,MAAM,EACZ,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAoBhB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAChC,IAAI,MAAM,EACV,OAAO,MAAM,EACb,YAAY,MAAM,KACjB,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,GAC/B,YAAY,MAAM,EAClB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF,iEAAiE;AACjE,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,GACnC,OAAO,MAAM,KACZ,OAAO,CAAC,oBAAoB,EAAE,CAShC,CAAC;AAEF,6DAA6D;AAC7D,eAAO,MAAM,iBAAiB,6BAA6B,CAAC;AAE5D,wCAAwC;AACxC,eAAO,MAAM,iBAAiB;;;CAGpB,CAAC;AAEX,0EAA0E;AAC1E,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,gEAAgE;AAChE,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AA2BD;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,GACzB,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,gBAAgB,CAWxB,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAC7B,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,IAAI,CAWd,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAC1B,QAAQ,MAAM,EACd,SAAS,OAAO,EAChB,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,gBAAgB,CAWxB,CAAC;AAEJ,+DAA+D;AAC/D,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACtC,8EAA8E;IAC9E,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,GAC/B,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC;IAAE,aAAa,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,yBAAyB,EAAE,CAAA;CAAE,CAazE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAC/B,IAAI,MAAM,EACV,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAChC,IAAI,MAAM,EACV,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC"}
+{"version":3,"file":"integration.d.ts","sourceRoot":"","sources":["../../../src/lib/integration.ts"],"names":[],"mappings":"AAuBA,UAAU,0BAA0B;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAC5B,MAAM,MAAM,EACZ,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAoBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAC5B,IAAI,MAAM,EACV,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,GACpC,IAAI,MAAM,EACV,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,GACxC,IAAI,MAAM,EACV,SAAS,MAAM,EACf,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mBAAmB,GAC9B,QAAQ,MAAM,EAAE,GAAG,IAAI,EACvB,YAAY,MAAM,GAAG,IAAI,EACzB,SAAS,MAAM,EACf,8BAA8B,OAAO,EACrC,iBAAiB,OAAO,EACxB,OAAO,MAAM,EACb,GAAG,SAAS,OAAO,EAAE,KACpB,OAAO,CAAC,MAAM,CAqChB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,GACtC,YAAY,MAAM,EAClB,SAAS,MAAM,EACf,8BAA8B,OAAO,EACrC,iBAAiB,OAAO,EACxB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAQd,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,GACrC,KAAK,MAAM,EACX,MAAM,MAAM,EACZ,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAqBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qCAAqC,GAChD,KAAK,MAAM,KACV,OAAO,CAAC,0BAA0B,CAyFpC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,GACrC,QAAQ,MAAM,EACd,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAC7B,IAAI,MAAM,EACV,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GACpC,IAAI,MAAM,EACV,MAAM,MAAM,EACZ,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAoBhB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAChC,IAAI,MAAM,EACV,OAAO,MAAM,EACb,YAAY,MAAM,KACjB,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,GAC/B,YAAY,MAAM,EAClB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF,iEAAiE;AACjE,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,GACnC,OAAO,MAAM,KACZ,OAAO,CAAC,oBAAoB,EAAE,CAShC,CAAC;AAEF,wCAAwC;AACxC,eAAO,MAAM,iBAAiB;;;CAGpB,CAAC;AAEX,0EAA0E;AAC1E,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,gEAAgE;AAChE,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AA+BD;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,GACzB,OAAO,MAAM,KACZ,OAAO,CAAC,gBAAgB,CAWxB,CAAC;AAEJ;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAC7B,OAAO,MAAM,KACZ,OAAO,CAAC,IAAI,CAWd,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,GAC1B,QAAQ,MAAM,EACd,SAAS,OAAO,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,gBAAgB,CAWxB,CAAC;AAiBJ,oEAAoE;AACpE,eAAO,MAAM,uBAAuB;;;;CAI1B,CAAC;AAEX,mDAAmD;AACnD,eAAO,MAAM,yBAAyB;;;CAG5B,CAAC;AASX,2DAA2D;AAC3D,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;IACpC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,kDAAkD;AAClD,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,8EAA8E;AAC9E,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,oFAAoF;AACpF,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,2EAA2E;AAC3E,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,sFAAsF;AACtF,MAAM,WAAW,uBAAuB;IACtC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,4DAA4D;AAC5D,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,iFAAiF;AACjF,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,OAAO,CAAC;CAChB;AASD;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,GAC5B,SAAS,MAAM,EACf,SAAS,MAAM,GAAG,IAAI,EACtB,KAAK,UAAU,EAAE,EACjB,OAAO,MAAM,KACZ,OAAO,CAAC,WAAW,CAOnB,CAAC;AAEJ;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB,GAChC,QAAQ,MAAM,EACd,SAAS,OAAO,EAChB,aAAa,MAAM,GAAG,IAAI,EAC1B,OAAO,MAAM,KACZ,OAAO,CAAC,oBAAoB,CAO5B,CAAC;AAEJ;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAC1B,MAAM,MAAM,EACZ,QAAQ,MAAM,EACd,OAAO,MAAM,KACZ,OAAO,CAAC,gBAAgB,CAOxB,CAAC;AAEJ;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,MAAM,EACZ,QAAQ,MAAM,EACd,OAAO,MAAM,KACZ,OAAO,CAAC,gBAAgB,CAOxB,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAC5B,YAAY;IAAE,YAAY,EAAE,MAAM,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,EAC5D,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAOd,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAC/B,IAAI,MAAM,GAAG,IAAI,EACjB,OAAO,MAAM,KACZ,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAQ3B,CAAC;AAEJ;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,GACjC,MAAM,MAAM,EACZ,UAAU,MAAM,GAAG,IAAI,EACvB,OAAO,MAAM,KACZ,OAAO,CAAC,uBAAuB,CAO/B,CAAC;AAEJ;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,GACxB,QAAQ,iBAAiB,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,EAC/C,OAAO,IAAI,GAAG,UAAU,EACxB,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAkB7B,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,iBAAiB,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,EAC/C,QAAQ;IAAE,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,EACrC,OAAO,MAAM,KACZ,OAAO,CAAC,mBAAmB,CAY3B,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAC/B,IAAI,MAAM,EACV,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAChC,IAAI,MAAM,EACV,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC"}

package/dist/cjs/lib/integration.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testIntegrationHealth = exports.getIntegrationHealth = exports.getOwnTenantSettings = exports.settleExecution = exports.heartbeatExecution = exports.claimExecution = exports.EXECUTION_OUTCOME = exports.RUN_TICKET_HEADER = exports.getDeclarablePermissions = exports.getExecutionEnvelope = exports.setDefaultIntegration = exports.setIntegrationInformation = exports.publishIntegration = exports.getEnabledContentProviders = exports.getContentInformationByUrlFromBrowser = exports.getContentInformationByUrl = exports.getIntegrationsByCapability = exports.getIntegrationsList = exports.getIntegrationInformationById = exports.discardIntegrationChanges = exports.deleteIntegration = exports.createIntegration = void 0;
+exports.testIntegrationHealth = exports.getIntegrationHealth = exports.storeRunSceneAudio = exports.storeRunMedia = exports.saveRunLearningContent = exports.deleteRunMicroSkills = exports.saveRunMicroSkill = exports.refundRunQuota = exports.consumeRunQuota = exports.updateRunNotification = exports.reportRunProgress = exports.RUN_LEARNING_CONTENT_TYPE = exports.RUN_NOTIFICATION_STATUS = exports.settleExecution = exports.heartbeatExecution = exports.claimExecution = exports.EXECUTION_OUTCOME = exports.getDeclarablePermissions = exports.getExecutionEnvelope = exports.setDefaultIntegration = exports.setIntegrationInformation = exports.publishIntegration = exports.getEnabledContentProviders = exports.getContentInformationByUrlFromBrowser = exports.getContentInformationByUrl = exports.getIntegrationsByCapability = exports.getIntegrationsList = exports.getIntegrationInformationById = exports.discardIntegrationChanges = exports.deleteIntegration = exports.createIntegration = void 0;
 const axiosClient_js_1 = require("./axiosClient.js");
 const axios_1 = __importDefault(require("axios"));
 const node_html_parser_1 = __importDefault(require("node-html-parser"));
@@ -358,7 +358,7 @@ exports.setDefaultIntegration = setDefaultIntegration;
  * resolved configuration, the identity to act as). Called by the agent runtime
  * in run-once mode with the token the execution was started with.
  * @param {String} batchJobId The event record the execution was started for
- * @param {String} token The execution's token
+ * @param {String} token The run's AGENT token (it names the run)
  */
 const getExecutionEnvelope = (batchJobId, token) => {
     return new Promise((resolve, reject) => {
@@ -396,15 +396,17 @@ const getDeclarablePermissions = (token) => {
     });
 };
 exports.getDeclarablePermissions = getDeclarablePermissions;
-/** The request header an agent returns its run ticket in. */
-exports.RUN_TICKET_HEADER = "x-stackfactor-run-ticket";
 /** How an execution settles its run. */
 exports.EXECUTION_OUTCOME = {
     COMPLETED: 2,
     FAILED: 3,
 };
-const lifecycleHeaders = (token, runTicket) => ({
-    headers: { authorization: token, [exports.RUN_TICKET_HEADER]: runTicket },
+/**
+ * A run's calls carry one credential: the AGENT token the platform minted for
+ * it, which names the run — so no call here says which run it is.
+ */
+const lifecycleHeaders = (token) => ({
+    headers: { authorization: token },
 });
 /**
  * Resolves the lifecycle answer whether the platform said yes (200) or "not
@@ -427,23 +429,20 @@ const lifecycleAnswer = (request, resolve, reject) => {
  * An execution claiming its run, once: PENDING → RUNNING. Of however many
  * executions the transport may start for one run, exactly one claim answers
  * `claimed: true`; the others get `claimed: false` and should exit without
- * doing the work. Which run is never sent: the run ticket names it. Called by
- * the agent runtime at start, with the token the execution was started with
- * (or, for an anonymous run, the ticket as the token).
- * @param {String} token The execution's token
- * @param {String} runTicket The ticket from this run's envelope
+ * doing the work. Which run is never sent: the run's token names it. Called by
+ * the agent runtime at start, with the token the execution was started with.
+ * @param {String} token The run's AGENT token (it names the run)
  */
-const claimExecution = (token, runTicket) => new Promise((resolve, reject) => lifecycleAnswer(axiosClient_js_1.client.post("/api/v1/integrations/executions/claim", {}, lifecycleHeaders(token, runTicket)), resolve, reject));
+const claimExecution = (token) => new Promise((resolve, reject) => lifecycleAnswer(axiosClient_js_1.client.post("/api/v1/integrations/executions/claim", {}, lifecycleHeaders(token)), resolve, reject));
 exports.claimExecution = claimExecution;
 /**
  * An execution keeping its run alive. Called on a fast cadence (~30 s) while
  * the handler runs, so a run that stops beating is known to be abandoned.
- * @param {String} token The execution's token
- * @param {String} runTicket The ticket from this run's envelope
+ * @param {String} token The run's AGENT token (it names the run)
  */
-const heartbeatExecution = (token, runTicket) => {
+const heartbeatExecution = (token) => {
     return new Promise((resolve, reject) => {
-        const request = axiosClient_js_1.client.post("/api/v1/integrations/executions/heartbeat", {}, lifecycleHeaders(token, runTicket));
+        const request = axiosClient_js_1.client.post("/api/v1/integrations/executions/heartbeat", {}, lifecycleHeaders(token));
         request
             .then(() => resolve())
             .catch((error) => reject(error));
@@ -456,36 +455,151 @@ exports.heartbeatExecution = heartbeatExecution;
  * platform's sweeper got there first) and the outcome was not recorded.
  * @param {Number} status EXECUTION_OUTCOME.COMPLETED or FAILED
  * @param {*} outcome A result summary, or the error — kept on the run's record
- * @param {String} token The execution's token
- * @param {String} runTicket The ticket from this run's envelope
+ * @param {String} token The run's AGENT token (it names the run)
  */
-const settleExecution = (status, outcome, token, runTicket) => new Promise((resolve, reject) => lifecycleAnswer(axiosClient_js_1.client.post("/api/v1/integrations/executions/settle", { status, outcome: outcome ?? null }, lifecycleHeaders(token, runTicket)), resolve, reject));
+const settleExecution = (status, outcome, token) => new Promise((resolve, reject) => lifecycleAnswer(axiosClient_js_1.client.post("/api/v1/integrations/executions/settle", { status, outcome: outcome ?? null }, lifecycleHeaders(token)), resolve, reject));
 exports.settleExecution = settleExecution;
+// ── A run's own state while it runs ─────────────────────────────────────
+//
+// What an agent run changes about itself: progress, its notification, the
+// generation quota it spends and the micro-skills of the learning content it
+// generates. Every call needs the run's AGENT token (the one the execution was
+// started with — never a person's session), which names the run, and the
+// platform answers for that one run only: nothing here names a batch job,
+// notification, quota record or learning content. The integration
+// must declare the matching permission, and the tenant must have accepted it:
+//   progress, notification  System - Update Own Run State
+//   quota                   System - Manage Own Run Quota
+//   micro-skills            System - Manage Own Run Micro-Skills
+//   learning content, media, audio
+//                           System - Manage Own Run Learning Content
+/** Notification statuses a run may move its own notification to. */
+exports.RUN_NOTIFICATION_STATUS = {
+    INPROGRESS: 5,
+    COMPLETED: 6,
+    FAILED: 7,
+};
+/** What a run may save its learning content as. */
+exports.RUN_LEARNING_CONTENT_TYPE = {
+    VIDEO: 2,
+    TEXT_CONTENT: 3,
+};
+/** The media types a run may store, and the file name each is sent under. */
+const RUN_MEDIA_FILE_NAMES = {
+    "image/jpeg": "media.jpg",
+    "image/png": "media.png",
+    "video/mp4": "media.mp4",
+};
+const runStateCall = (request) => new Promise((resolve, reject) => {
+    request
+        .then((response) => resolve(response.data))
+        .catch((error) => reject(error));
+});
 /**
- * The CALLING integration's own settings, for every organization that has it
- * enabled. What a scheduled run — which starts once for the platform, with no
- * identity — reads to find the tenants it works on. Nothing names an
- * integration: the run ticket the platform put in the run's envelope
- * (`request.runTicket`) decides which one is answered for.
- * @param {String} token The integration's own API token (an admin-tenant
- * service account's, holding Admin - Read Own Integration Settings)
- * @param {String} runTicket The ticket from this run's envelope
+ * Reports how far the run got, with log lines; kept on the run's record (the
+ * newest 200 lines).
+ * @param {Number} percent 0–100
+ * @param {String|null} message A one-line summary, e.g. "micro-skill 4 of 10"
+ * @param {RunLogLine[]} log Up to 50 lines
+ * @param {String} token The run's AGENT token (it names the run)
  */
-const getOwnTenantSettings = (token, runTicket) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_js_1.client.get("/api/v1/integrations/mine/tenant-settings", {
-            headers: { authorization: token, [exports.RUN_TICKET_HEADER]: runTicket },
-        });
-        request
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
+const reportRunProgress = (percent, message, log, token) => runStateCall(axiosClient_js_1.client.post("/api/v1/integrations/executions/progress", { percent, message, log }, lifecycleHeaders(token)));
+exports.reportRunProgress = reportRunProgress;
+/**
+ * Moves the run's own notification to in progress, completed or failed, with
+ * the details the person sees. Resolves `cancelled: true` when the person
+ * cancelled it — the notification is left as they left it and the run should
+ * stop, clean up and settle.
+ * @param {Number} status A RUN_NOTIFICATION_STATUS value
+ * @param {*} details What the notification shows: progress, log, …
+ * @param {String|null} description Replaces the notification's text; null keeps it
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+const updateRunNotification = (status, details, description, token) => runStateCall(axiosClient_js_1.client.post("/api/v1/integrations/executions/notification", { status, details: details ?? null, description }, lifecycleHeaders(token)));
+exports.updateRunNotification = updateRunNotification;
+/**
+ * Consumes generation quota (a GENERATE_* type) for the person the run acts
+ * for. Rejects with 400 QUOTA_EXCEEDED when fewer than `amount` remain.
+ * @param {String} type e.g. "GENERATE_LEARNING_CONTENT"
+ * @param {Number} amount 1–100
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+const consumeRunQuota = (type, amount, token) => runStateCall(axiosClient_js_1.client.post("/api/v1/integrations/executions/quota/consume", { type, amount }, lifecycleHeaders(token)));
+exports.consumeRunQuota = consumeRunQuota;
+/**
+ * Refunds quota this same run consumed and has not refunded yet — never more;
+ * a larger refund rejects with 422.
+ * @param {String} type The type the run consumed
+ * @param {Number} amount 1–100
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+const refundRunQuota = (type, amount, token) => runStateCall(axiosClient_js_1.client.post("/api/v1/integrations/executions/quota/refund", { type, amount }, lifecycleHeaders(token)));
+exports.refundRunQuota = refundRunQuota;
+/**
+ * Saves a micro-skill of the learning content the run was started for — a new
+ * one, or a new draft of one it has. The parent does not need to exist yet.
+ * @param {Object} microSkill `microSkillId` plus learning activities, objectives, …
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+const saveRunMicroSkill = (microSkill, token) => runStateCall(axiosClient_js_1.client.put("/api/v1/integrations/executions/microskills", microSkill, lifecycleHeaders(token)));
+exports.saveRunMicroSkill = saveRunMicroSkill;
+/**
+ * Deletes a micro-skill of the run's learning content by its record id, or all
+ * of them when `id` is null — what a cancelled or failed run cleans up.
+ * @param {String|null} id The micro-skill record's id, or null for all
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+const deleteRunMicroSkills = (id, token) => runStateCall(axiosClient_js_1.client.delete(id
+    ? `/api/v1/integrations/executions/microskills/${encodeURIComponent(id)}`
+    : "/api/v1/integrations/executions/microskills", lifecycleHeaders(token)));
+exports.deleteRunMicroSkills = deleteRunMicroSkills;
+/**
+ * Saves the learning content the run was started for, as video or text
+ * content, with the settings it was generated with. It is recorded as the work
+ * of the person the run acts for. Save it once its micro-skills are stored.
+ * @param {Number} type A RUN_LEARNING_CONTENT_TYPE value
+ * @param {Object|null} settings The generation settings; null keeps the defaults
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+const saveRunLearningContent = (type, settings, token) => runStateCall(axiosClient_js_1.client.put("/api/v1/integrations/executions/learning-content", { type, settings }, lifecycleHeaders(token)));
+exports.saveRunLearningContent = saveRunLearningContent;
+/**
+ * Stores an image or a video clip of one of the run's learning activities
+ * (PNG, JPEG or MP4, up to 100 MB). Any other type rejects with 400.
+ * @param {Object} target The activity, and the `mediaId` the file is stored as
+ * @param {Blob|Uint8Array} media The file's bytes (a Buffer is a Uint8Array)
+ * @param {String} mimeType "image/png", "image/jpeg" or "video/mp4"
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+const storeRunMedia = (target, media, mimeType, token) => {
+    const formData = new FormData();
+    formData.append("microSkillId", target.microSkillId);
+    formData.append("learningActivityId", target.learningActivityId);
+    formData.append("mediaId", target.mediaId);
+    formData.append("file", new Blob([media], { type: mimeType }), RUN_MEDIA_FILE_NAMES[mimeType] ?? "media.bin");
+    return runStateCall(axiosClient_js_1.client.put("/api/v1/integrations/executions/media", formData, {
+        headers: {
+            authorization: token,
+            "Content-Type": "multipart/form-data",
+        },
+    }));
 };
-exports.getOwnTenantSettings = getOwnTenantSettings;
+exports.storeRunMedia = storeRunMedia;
+/**
+ * Has the platform synthesise the narration of one scene of one of the run's
+ * video activities and store it where the player reads it. Resolves
+ * `stored: false` when there was nothing to store.
+ * @param {Object} target The activity, and the `sceneId` the narration is for
+ * @param {Object} script The narration: `items`, each with its `text`
+ * @param {String} token The run's AGENT token (it names the run)
+ */
+const storeRunSceneAudio = (target, script, token) => runStateCall(axiosClient_js_1.client.post("/api/v1/integrations/executions/audio", {
+    microSkillId: target.microSkillId,
+    learningActivityId: target.learningActivityId,
+    sceneId: target.sceneId,
+    script,
+}, lifecycleHeaders(token)));
+exports.storeRunSceneAudio = storeRunSceneAudio;
 /**
  * Get an integration agent's live health (cheap: deploy state + Cloud Run
  * readiness; does not contact the agent). Use for the live status on the cards.