@mapcreator/api 0.0.0-co-edit.4 → 0.0.0-co-edit.5

package/src/api/job.ts

@@ -1,5 +1,5 @@
 import type { ApiJobShare, JobShare, JobShareVisibility } from './jobShare.js';
-import { type JobSearchResult, listJobs } from './apiCommon.js';
+import { type DashboardSortType, type JobSearchResult, listJobs } from './apiCommon.js';
 import {
   type ApiCommon,
   type ApiCommonData,
@@ -23,6 +23,7 @@ export type Job = {
   previewPath: string | undefined;
   convertedJobId: number | null;
   private: boolean;
+  jobOpenUserName: string | null;
 
   userEmail: string | undefined; // ?
   orgName: string | undefined;  // ?
@@ -42,6 +43,7 @@ export type ApiJob = {
     star: boolean;              // TODO: not present in API specification!
     converted_job_id?: number | null;
     private: boolean;
+    job_open_user_name: string | null;
   } & ApiCommonData;
 } & Omit<ApiSuccess, 'data'> | ApiError;
 
@@ -58,9 +60,9 @@ export const jobRevivers: Revivers<ApiJob, Job> = {
   convertedJobId: (data: ApiJobData) => data.converted_job_id ?? null,
 };
 
-export async function createJob(title: string, oldJobId?: number): Promise<Job> {
+export async function createJob(title: string, jobTypeId = 9, oldJobId?: number): Promise<Job> {
   const path = `/v1/jobs`;
-  const body = { title, job_type_id: 9, ...oldJobId && { cloned_v4_job_id: oldJobId } };
+  const body = { title, job_type_id: jobTypeId, ...oldJobId && { cloned_v4_job_id: oldJobId } };
   const options = { revivers: jobRevivers };
 
   // Technically, the returning `data` will contain only the following fields:
@@ -146,9 +148,47 @@ export async function uploadJobPreview(
 }
 
 export async function listFeaturedJobs(
-  title: string,
+  search: string,
+  sort: DashboardSortType,
   page: number,
-  options?: Record<string, unknown>,
 ): Promise<JobSearchResult> {
-  return listJobs(`/v1/jobs/featured`, title, page, options);
+  return listJobs(`/v1/jobs/featured`, search, sort, 'all', page);
+}
+
+export type JobCoEditEvent = {
+  jobId: number;
+  userName: string;
+  status: 'open' | 'close';
+};
+
+export type JobTakeoverEvent = {
+  userId: number;
+  userName: string;
+  requestedAt: string;
+  status: 'pending' | 'approved' | 'denied';
+};
+
+export async function openJob(jobId: number): Promise<Record<string, never>> {
+  return request<ApiCommon, Record<string, never>>(`/v1/jobs/${jobId}/open`, null, null, { method: 'POST' });
+}
+
+export async function heartbeat(jobId: number): Promise<Record<string, never>> {
+  // TODO handle disconnections. Throw the right error so we can show a modal in the tool when the connection is down
+  return request<ApiCommon, Record<string, never>>(`/v1/jobs/${jobId}/heartbeat`, null, null, { method: 'POST' });
+}
+
+export async function requestTakeover(jobId: number): Promise<Record<string, never>> {
+  return request<ApiCommon, Record<string, never>>(`/v1/jobs/${jobId}/takeover/request`, null, null, { method: 'POST' });
+}
+
+export async function approveTakeover(jobId: number, userId: number): Promise<Record<string, never>> {
+  return request<ApiCommon, Record<string, never>>(`/v1/jobs/${jobId}/takeover/approve`, { user_id: userId }, null, { method: 'POST' });
+}
+
+export async function denyTakeover(jobId: number, userId: number): Promise<Record<string, never>> {
+  return request<ApiCommon, Record<string, never>>(`/v1/jobs/${jobId}/takeover/deny`, { user_id: userId }, null, { method: 'POST' });
+}
+
+export async function closeJob(jobId: number): Promise<Record<string, never>> {
+  return request<ApiCommon, Record<string, never>>(`/v1/jobs/${jobId}/close`, null, null, { method: 'POST' });
 }

package/src/api/jobRevision.ts

@@ -2,6 +2,7 @@ import { apiHost, authenticate, getAuthorizationHeaders, token } from '../oauth.
 import { type ApiLayerData, type Layer, layerRevivers } from './layer.js';
 import type { ApiMapstyleSetData } from './mapstyleSet.js';
 import type { ApiLanguageData } from './language.js';
+import type Echo from 'laravel-echo';
 import {
   APIError,
   type ApiCommon,
@@ -13,6 +14,7 @@ import {
   NetworkError,
   type Revivers,
   TimeoutError,
+  combineSignals,
   defaultListHeader,
   defaultTimeout,
   deletedNoneParam,
@@ -225,11 +227,17 @@ export type JobRevisionOutput = { blob: Blob; filename?: string | undefined };
 export async function getJobRevisionOutput(jobId: number): Promise<JobRevisionOutput> {
   await createJobRevisionBuild(jobId);
 
+  return fetchOutput(jobId);
+}
+
+async function fetchOutput(jobId: number, signal?: AbortSignal): Promise<JobRevisionOutput> {
   const href = `${apiHost}/v1/jobs/${jobId}/revisions/${lastJobRevision}/result/output`;
   const headers = getAuthorizationHeaders();
 
   const timeout = defaultTimeout;
-  const { signal, cleanup } = makeTimeoutSignal(timeout);
+  const { signal: timeoutSignal, cleanup } = makeTimeoutSignal(timeout);
+
+  signal = signal ? combineSignals(signal, timeoutSignal) : timeoutSignal;
 
   const response = await fetch(href, { headers, signal, ...!token && { credentials: 'include' } })
     .catch((error: Error) => {
@@ -296,3 +304,53 @@ async function createJobRevisionBuild(jobId: number, skipValidation?: boolean):
 
   return request<ApiCommon, string>(path, body, null, { method: 'POST' });
 }
+
+async function waitForJobToFinish(jobId: number, echo: Echo<'reverb'>, signal?: AbortSignal): Promise<void> {
+  signal?.throwIfAborted();
+
+  return new Promise((resolve, reject) => {
+    const channel = `jobresult.${jobId}`;
+
+    const onAbort = (): void => {
+      echo.leaveChannel(channel);
+      reject(signal?.reason);
+    };
+
+    const cleanup = (): void => {
+      echo.leaveChannel(channel);
+      signal?.removeEventListener('abort', onAbort);
+    };
+
+    type JobResultEvent =
+      | { revisionId: number; status: string }
+      | { revisionId: number; filePathSet: boolean };
+
+    const handler = (event: JobResultEvent): void => {
+      if ('filePathSet' in event) {
+        cleanup();
+        resolve();
+      } else if (event.status !== 'processing' && event.status !== 'queued' && event.status !== 'completed') {
+        cleanup();
+        reject(new APIError({ success: false, error: { type: 'API Error', message: event.status } }));
+      }
+    };
+
+    signal?.addEventListener('abort', onAbort, { once: true });
+    echo.channel(channel).listen('.JobResultEvent', handler);
+  });
+}
+
+export async function getJobRevisionOutputForBackend(
+  jobId: number,
+  echo: Echo<'reverb'>,
+  signal?: AbortSignal,
+): Promise<JobRevisionOutput> {
+  await createJobRevisionBuild(jobId);
+  const jobrevision = await getJobRevision(jobId);
+
+  if (jobrevision) {
+    await waitForJobToFinish(jobrevision.id, echo, signal);
+  }
+
+  return fetchOutput(jobId);
+}

package/src/api/organisation.ts

@@ -1,5 +1,5 @@
 import type { ApiJobShareArray, JobShare } from './jobShare.js';
-import { type JobSearchResult, listJobs } from './apiCommon.js';
+import { type DashboardFilterType, type DashboardSortType, type JobSearchResult, listJobs } from './apiCommon.js';
 import {
   type ApiCommonData,
   type ApiError,
@@ -74,13 +74,13 @@ export async function getOrganisation(
 
 export async function listOrganisationJobs(
   organisationId: number | typeof myOrganisations,
-  title: string,
+  search: string,
+  sort: DashboardSortType,
+  filter: DashboardFilterType,
   page: number,
-  options?: Record<string, unknown>,
+  folderId: number | null
 ): Promise<JobSearchResult> {
-  const search = { ...options };
-
-  return listJobs(`/v1/organisations/${organisationId}/jobs`, title, page, search);
+  return listJobs(`/v1/organisations/${organisationId}/jobs`, search, sort, filter, page, folderId);
 }
 
 export async function listOrganisationShares(jobId: number): Promise<JobShare[]> {

package/src/api/resources.ts

@@ -51,6 +51,30 @@ export type CustomFeature =
   | 'developer_menu'
   | 'allow_editing_other_users_jobs';
 
+export type ApiAccessibleOrganisationFolder = {
+  id: number;
+  organisation_id: number;
+  name: string;
+};
+
+export type AccessibleOrganisationFolder = {
+  id: number;
+  organisationId: number;
+  name: string;
+};
+
+export type ApiAccessibleOrganisation = {
+  id: number;
+  name: string;
+  job_folders: ApiAccessibleOrganisationFolder[];
+};
+
+export type AccessibleOrganisation = {
+  id: number;
+  name: string;
+  jobFolders: AccessibleOrganisationFolder[];
+};
+
 export interface Resources {
   organisation: Organisation;
   user: User;
@@ -66,6 +90,7 @@ export interface Resources {
   layers: Layer[];
   fonts: Font[];
   fontFamilies: FontFamily[];
+  accessibleOrganisations: AccessibleOrganisation[];
 }
 
 type ApiResources = {
@@ -88,6 +113,7 @@ type ApiResources = {
     layers: ApiLayerData[];
     fonts: ApiFontData[];
     font_families: ApiFontFamilyData[];
+    accessible_organisations: ApiAccessibleOrganisation[];
   } & ApiCommonData;
 } & Omit<ApiSuccess, 'data'> | ApiError;
 
@@ -132,6 +158,10 @@ export async function loadResources(): Promise<Resources> {
     svgSets: (raw.svgSets?.map(processData, getContext(svgSetRevivers)) ?? []) as SvgSet[],
     fonts: (raw.fonts?.map(processData, getContext(fontRevivers)) ?? []) as Font[],
     fontFamilies: (raw.fontFamilies?.map(processData, getContext(fontFamilyRevivers)) ?? []) as FontFamily[],
+    // TODO revivers and such
+    accessibleOrganisations: (raw.accessibleOrganisations?.map(
+      processData, getContext({})
+    ) ?? []) as AccessibleOrganisation[],
   };
 }
 

package/src/api/user.ts

@@ -2,8 +2,9 @@ import { type ApiFontFamilyData, type FontFamily, fontFamilyRevivers } from './f
 import { type ApiSvgSetData, type SvgSet, svgSetRevivers } from './svgSet.js';
 import { type ApiLayerData, type Layer, layerRevivers } from './layer.js';
 import { type ApiSvgData, type Svg, svgRevivers } from './svg.js';
-import { type JobSearchResult, listJobs } from './apiCommon.js';
+import { type DashboardFilterType, type DashboardSortType, type JobSearchResult, listJobs } from './apiCommon.js';
 import type { ApiJobShareArray, JobShare } from './jobShare.js';
+import type { AccessibleOrganisation, ApiAccessibleOrganisation } from './resources.js';
 import type { RequireAtLeastOne } from 'type-fest';
 import {
   type ApiCommon,
@@ -210,21 +211,32 @@ export async function listUserHatchingSvgs(): Promise<Svg[]> {
 
 export async function listUserJobs(
   userId: number | typeof myUser,
-  title: string,
+  search: string,
+  sort: DashboardSortType,
+  filter: DashboardFilterType,
   page: number,
-  options?: Record<string, unknown>
 ): Promise<JobSearchResult> {
-  return listJobs(`/v1/users/${userId}/jobs`, title, page, options);
+  return listJobs(`/v1/users/${userId}/jobs`, search, sort, filter, page);
 }
 
-export async function listUserFolders(): Promise<JobFolder[]> {
-  const path = `/v1/users/${myUser}/folders`;
+export async function listUserEditedJobs(
+  userId: number | typeof myUser,
+  search: string,
+  sort: DashboardSortType,
+  filter: DashboardFilterType,
+  page: number,
+): Promise<JobSearchResult> {
+  return listJobs(`/v1/users/${userId}/edited-jobs`, search, sort, filter, page);
+}
+
+export async function listUserAccessibleOrganisations(): Promise<AccessibleOrganisation[]> {
+  const path = `/v1/users/${myUser}/accessible-organisations`;
 
-  type ApiJobFolderArray = {
-    data: ApiJobFolderData[];
+  type ApiAccessibleOrganisationArray = {
+    data: ApiAccessibleOrganisation[];
   } & Omit<ApiSuccess, 'data'> | ApiError;
 
-  return request<ApiJobFolderArray, JobFolder>(path);
+  return request<ApiAccessibleOrganisationArray, AccessibleOrganisation>(path);
 }
 
 export async function createUserFolder(name: string): Promise<JobFolder> {