@wix/auto_sdk_containers_project-jobs 1.0.2 → 1.0.4

package/build/cjs/index.typings.d.ts

@@ -76,6 +76,13 @@ interface ProjectJob {
      * @maxLength 100000
      */
     assistantResponse?: string | null;
+    /**
+     * Himalaya release this edit published, persisted when the agent reports AGENT_DONE. Read by
+     * containers-projects to post the edit's chat checkpoint. Empty for jobs that publish no release.
+     * @readonly
+     * @maxLength 100
+     */
+    himalayaReleaseId?: string | null;
     /**
      * Whether this job's owner is exempt from AI credits, decided once at creation time.
      * @readonly
@@ -88,6 +95,14 @@ interface ProjectJob {
      * @maxLength 20
      */
     creditsCostUsd?: string;
+    /**
+     * The AI-credits cost (in USD) of this edit if the user stops it after the agent started work,
+     * resolved at creation time with credits_cost_usd. Set only for USER_REQUEST jobs. Empty for other
+     * job types and for jobs created before this field existed, which are not charged when stopped.
+     * @readonly
+     * @maxLength 20
+     */
+    creditsStoppedCostUsd?: string | null;
     /**
      * Chat suggestion chips proposed by a GENERATE_SUGGESTIONS job. Empty for every other job type.
      * Set only via UpdateProjectJobStatus, alongside AGENT_DONE — never at creation time.
@@ -109,6 +124,13 @@ interface ProjectJob {
      * @format GUID
      */
     initiatingMetaSiteId?: string;
+    /**
+     * Why a CANCELLED job was cancelled. Set only by StopProjectJob (USER_STOPPED); every other
+     * cancellation leaves it unset. containers-projects reads it to cancel the stopped chat turn
+     * instead of closing it as an error.
+     * @readonly
+     */
+    cancelReason?: CancelReasonWithLiterals;
 }
 declare enum JobType {
     INITIAL_GENERATION = "INITIAL_GENERATION",
@@ -177,6 +199,12 @@ interface Suggestion {
      */
     prompt?: string;
 }
+declare enum CancelReason {
+    /** The user stopped the edit from the chat. The worker discards the run; its chat turn is cancelled. */
+    USER_STOPPED = "USER_STOPPED"
+}
+/** @enumType */
+type CancelReasonWithLiterals = CancelReason | 'USER_STOPPED';
 interface CreateProjectJobRequest {
     /** ProjectJob to be created. */
     projectJob: ProjectJob;
@@ -232,6 +260,12 @@ interface UpdateProjectJobStatusRequest {
      * @maxLength 100000
      */
     assistantResponse?: string | null;
+    /**
+     * Himalaya release the edit published. Only supplied with AGENT_DONE; preserved on later
+     * transitions. containers-projects reads it off the job to post the edit's chat checkpoint.
+     * @maxLength 100
+     */
+    himalayaReleaseId?: string | null;
 }
 interface UpdateProjectJobStatusResponse {
     /** The updated job. */
@@ -361,6 +395,17 @@ interface CancelProjectJobResponse {
     /** The cancelled job. */
     projectJob?: ProjectJob;
 }
+interface StopProjectJobRequest {
+    /**
+     * ID of the job to stop.
+     * @format GUID
+     */
+    projectJobId: string;
+}
+interface StopProjectJobResponse {
+    /** The stopped job. */
+    projectJob?: ProjectJob;
+}
 interface GetLatestProjectJobRequest {
     /**
      * ID of the project to get the latest job for.
@@ -374,6 +419,11 @@ interface GetLatestProjectJobResponse {
      * if the project has no jobs yet.
      */
     projectJob?: ProjectJob;
+    /**
+     * Whether Stop Project Job can stop `projectJob` now. Clients show a stop control only when
+     * this is true; false when there is no job.
+     */
+    stopAvailable?: boolean;
 }
 interface CreateSuggestionsJobRequest {
     /**
@@ -759,6 +809,12 @@ interface UpdateProjectJobStatusOptions {
      * @maxLength 100000
      */
     assistantResponse?: string | null;
+    /**
+     * Himalaya release the edit published. Only supplied with AGENT_DONE; preserved on later
+     * transitions. containers-projects reads it off the job to post the edit's chat checkpoint.
+     * @maxLength 100
+     */
+    himalayaReleaseId?: string | null;
 }
 interface QueryProjectJobsOptions {
     /**
@@ -845,7 +901,7 @@ interface ProjectJobsQueryBuilder {
  * @requiredField query
  * @requiredField options
  */
-declare function typedQueryProjectJobs(query: ProjectJobQuery, options: QueryProjectJobsOptions): Promise<NonNullablePaths<QueryProjectJobsResponse, `projectJobs` | `projectJobs.${number}.projectId` | `projectJobs.${number}.jobType` | `projectJobs.${number}.platform` | `projectJobs.${number}.jobStatus` | `projectJobs.${number}.prompt` | `projectJobs.${number}.codingAgentSessionId` | `projectJobs.${number}.failureReason` | `projectJobs.${number}.creditsExempt` | `projectJobs.${number}.creditsCostUsd` | `projectJobs.${number}.initiatingUserId` | `projectJobs.${number}.initiatingMetaSiteId`, 2>>;
+declare function typedQueryProjectJobs(query: ProjectJobQuery, options: QueryProjectJobsOptions): Promise<NonNullablePaths<QueryProjectJobsResponse, `projectJobs` | `projectJobs.${number}.projectId` | `projectJobs.${number}.jobType` | `projectJobs.${number}.platform` | `projectJobs.${number}.jobStatus` | `projectJobs.${number}.prompt` | `projectJobs.${number}.codingAgentSessionId` | `projectJobs.${number}.failureReason` | `projectJobs.${number}.creditsExempt` | `projectJobs.${number}.creditsCostUsd` | `projectJobs.${number}.initiatingUserId` | `projectJobs.${number}.initiatingMetaSiteId` | `projectJobs.${number}.cancelReason`, 2>>;
 interface ProjectJobQuerySpec extends QuerySpec {
     paging: 'cursor';
     wql: [
@@ -935,4 +991,4 @@ interface QueryProjectJobActivityOptions {
     limit?: number;
 }
 
-export { type AccountInfo, type ActionEvent, type ActivityBatch, type ActivityEvent, ActivityEventType, type ActivityEventTypeWithLiterals, ActivitySource, type ActivitySourceWithLiterals, ActivityWorkflow, type ActivityWorkflowWithLiterals, type Attachment, AttachmentType, type AttachmentTypeWithLiterals, type CancelProjectJobRequest, type CancelProjectJobResponse, type ClearProjectJobAssistantResponseRequest, type ClearProjectJobAssistantResponseResponse, type CommonQueryWithEntityContext, type CreateProjectJobRequest, type CreateProjectJobResponse, type CreateSuggestionsJobOptions, type CreateSuggestionsJobRequest, type CreateSuggestionsJobResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetCurrentProjectJobRequest, type GetCurrentProjectJobResponse, type GetLatestProjectJobRequest, type GetLatestProjectJobResponse, type GetProjectJobRequest, type GetProjectJobResponse, type IdentificationData, type IdentificationDataIdOneOf, JobStatus, type JobStatusWithLiterals, JobType, type JobTypeWithLiterals, type MessageEnvelope, type OpenProjectJobActivityRequest, type OpenProjectJobActivityResponse, Platform, type PlatformWithLiterals, type ProjectJob, type ProjectJobQuery, type ProjectJobQuerySpec, type ProjectJobsQueryBuilder, type ProjectJobsQueryResult, type QueryProjectJobActivityOptions, type QueryProjectJobActivityRequest, type QueryProjectJobActivityResponse, type QueryProjectJobsOptions, type QueryProjectJobsRequest, type QueryProjectJobsResponse, type ReportProjectJobActivityRequest, type ReportProjectJobActivityResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type Suggestion, type UpdateProjectJobStatusOptions, type UpdateProjectJobStatusRequest, type UpdateProjectJobStatusResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, typedQueryProjectJobs, utils };
+export { type AccountInfo, type ActionEvent, type ActivityBatch, type ActivityEvent, ActivityEventType, type ActivityEventTypeWithLiterals, ActivitySource, type ActivitySourceWithLiterals, ActivityWorkflow, type ActivityWorkflowWithLiterals, type Attachment, AttachmentType, type AttachmentTypeWithLiterals, type CancelProjectJobRequest, type CancelProjectJobResponse, CancelReason, type CancelReasonWithLiterals, type ClearProjectJobAssistantResponseRequest, type ClearProjectJobAssistantResponseResponse, type CommonQueryWithEntityContext, type CreateProjectJobRequest, type CreateProjectJobResponse, type CreateSuggestionsJobOptions, type CreateSuggestionsJobRequest, type CreateSuggestionsJobResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetCurrentProjectJobRequest, type GetCurrentProjectJobResponse, type GetLatestProjectJobRequest, type GetLatestProjectJobResponse, type GetProjectJobRequest, type GetProjectJobResponse, type IdentificationData, type IdentificationDataIdOneOf, JobStatus, type JobStatusWithLiterals, JobType, type JobTypeWithLiterals, type MessageEnvelope, type OpenProjectJobActivityRequest, type OpenProjectJobActivityResponse, Platform, type PlatformWithLiterals, type ProjectJob, type ProjectJobQuery, type ProjectJobQuerySpec, type ProjectJobsQueryBuilder, type ProjectJobsQueryResult, type QueryProjectJobActivityOptions, type QueryProjectJobActivityRequest, type QueryProjectJobActivityResponse, type QueryProjectJobsOptions, type QueryProjectJobsRequest, type QueryProjectJobsResponse, type ReportProjectJobActivityRequest, type ReportProjectJobActivityResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type StopProjectJobRequest, type StopProjectJobResponse, type Suggestion, type UpdateProjectJobStatusOptions, type UpdateProjectJobStatusRequest, type UpdateProjectJobStatusResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, typedQueryProjectJobs, utils };

package/build/cjs/index.typings.js

@@ -24,6 +24,7 @@ __export(index_typings_exports, {
   ActivitySource: () => ActivitySource,
   ActivityWorkflow: () => ActivityWorkflow,
   AttachmentType: () => AttachmentType,
+  CancelReason: () => CancelReason,
   JobStatus: () => JobStatus,
   JobType: () => JobType,
   Platform: () => Platform,
@@ -40,6 +41,7 @@ __export(index_typings_exports, {
   queryProjectJobActivity: () => queryProjectJobActivity2,
   queryProjectJobs: () => queryProjectJobs2,
   reportProjectJobActivity: () => reportProjectJobActivity2,
+  stopProjectJob: () => stopProjectJob2,
   typedQueryProjectJobs: () => typedQueryProjectJobs,
   updateProjectJobStatus: () => updateProjectJobStatus2,
   utils: () => utils
@@ -287,6 +289,33 @@ function cancelProjectJob(payload) {
   }
   return __cancelProjectJob;
 }
+function stopProjectJob(payload) {
+  function __stopProjectJob({ host }) {
+    const metadata = {
+      entityFqdn: "wix.containers.project_jobs.v1.project_job",
+      method: "POST",
+      methodFqn: "wix.containers.project.jobs.v1.ContainersProjectJobs.StopProjectJob",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixContainersProjectJobsV1ContainersProjectJobsUrl({
+        protoPath: "/v1/project-jobs/{projectJobId}/stop",
+        data: payload,
+        host
+      }),
+      data: payload,
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+          paths: TRANSFORM_PATHS_0
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __stopProjectJob;
+}
 function getLatestProjectJob(payload) {
   function __getLatestProjectJob({ host }) {
     const metadata = {
@@ -436,6 +465,10 @@ var AttachmentType = /* @__PURE__ */ ((AttachmentType2) => {
   AttachmentType2["URL"] = "URL";
   return AttachmentType2;
 })(AttachmentType || {});
+var CancelReason = /* @__PURE__ */ ((CancelReason2) => {
+  CancelReason2["USER_STOPPED"] = "USER_STOPPED";
+  return CancelReason2;
+})(CancelReason || {});
 var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
   SortOrder2["ASC"] = "ASC";
   SortOrder2["DESC"] = "DESC";
@@ -559,7 +592,8 @@ async function updateProjectJobStatus2(projectJobId, jobStatus, options) {
     revision: options?.revision,
     failureReason: options?.failureReason,
     suggestions: options?.suggestions,
-    assistantResponse: options?.assistantResponse
+    assistantResponse: options?.assistantResponse,
+    himalayaReleaseId: options?.himalayaReleaseId
   });
   const reqOpts = updateProjectJobStatus(
     payload
@@ -580,7 +614,8 @@ async function updateProjectJobStatus2(projectJobId, jobStatus, options) {
           revision: "$[2].revision",
           failureReason: "$[2].failureReason",
           suggestions: "$[2].suggestions",
-          assistantResponse: "$[2].assistantResponse"
+          assistantResponse: "$[2].assistantResponse",
+          himalayaReleaseId: "$[2].himalayaReleaseId"
         },
         singleArgumentUnchanged: false
       },
@@ -718,6 +753,31 @@ async function cancelProjectJob2(projectJobId, revision) {
     throw transformedError;
   }
 }
+async function stopProjectJob2(projectJobId) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    projectJobId
+  });
+  const reqOpts = stopProjectJob(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { projectJobId: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["projectJobId"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function getLatestProjectJob2(projectId) {
   const { httpClient, sideEffects } = arguments[1];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -873,6 +933,7 @@ async function queryProjectJobActivity2(projectJobId, options) {
   ActivitySource,
   ActivityWorkflow,
   AttachmentType,
+  CancelReason,
   JobStatus,
   JobType,
   Platform,
@@ -889,6 +950,7 @@ async function queryProjectJobActivity2(projectJobId, options) {
   queryProjectJobActivity,
   queryProjectJobs,
   reportProjectJobActivity,
+  stopProjectJob,
   typedQueryProjectJobs,
   updateProjectJobStatus,
   utils