@prisme.ai/sdk 1.0.0 → 1.0.2

package/lib/api.ts

@@ -1,10 +1,17 @@
 import QueryString from 'qs';
-import Fetcher from './fetcher';
+import pkceChallenge from 'pkce-challenge';
+import Fetcher, { Fetched } from './fetcher';
 import { Event, Workspace } from './types';
 import { Events } from './events';
 import { removedUndefinedProperties } from './utils';
 import WorkspacesEndpoint from './endpoints/workspaces';
 import ApiError from './ApiError';
+import UsersEndpoint from './endpoints/users';
+import {
+  ImportProcessing,
+  ImportProcessingError,
+  ImportSuccess,
+} from './ImportProcessing';
 
 interface PageWithMetadata extends Prismeai.Page {
   createdAt: string;
@@ -24,10 +31,81 @@ export type UserPermissions = {
   };
 };
 
+export interface ApiOptions {
+  host: string;
+  oidc?: {
+    url: string;
+    clientId: string;
+    clientIdHeader?: string;
+    redirectUri: string;
+  };
+  websockets?: {
+    transports?: string[];
+  };
+}
+
+export interface AccessToken {
+  access_token: string;
+  id_token: string;
+  scope: string;
+  expiresIn: number;
+  token_type: 'Bearer';
+}
+
+export interface InteractiveSignin {
+  interaction: string;
+  login: string;
+  password: string;
+  remember?: boolean;
+}
+
+function dataURItoBlob(dataURI: string): [Blob, string] {
+  // convert base64/URLEncoded data component to raw binary data held in a string
+  let byteString;
+  if (dataURI.split(',')[0].indexOf('base64') >= 0)
+    byteString = atob(dataURI.split(',')[1]);
+  else byteString = unescape(dataURI.split(',')[1]);
+  // separate out the mime component
+  const metadata = dataURI
+    .split(';')
+    .filter((v, k, all) => k < all.length - 1)
+    .map((v) => v.split(/:/));
+  const [, mimeString = ''] = metadata.find(([k, v]) => k === 'data') || [];
+  const [, ext] = mimeString.split(/\//);
+  const [, fileName = `file.${ext}`] =
+    metadata.find(([k, v]) => k === 'filename') || [];
+
+  // write the bytes of the string to a typed array
+  let ia = new Uint8Array(byteString.length);
+  for (var i = 0; i < byteString.length; i++) {
+    ia[i] = byteString.charCodeAt(i);
+  }
+
+  return [new Blob([ia], { type: mimeString }), fileName];
+}
+
 export class Api extends Fetcher {
+  public opts: Required<ApiOptions>;
   private sessionId?: string;
   private _user?: Prismeai.User & { sessionId?: string };
 
+  constructor(opts: ApiOptions) {
+    super(opts.host, opts?.oidc?.clientIdHeader);
+    this.opts = {
+      ...opts,
+      oidc: {
+        url: 'http://studio.local.prisme.ai:3001',
+        clientId: 'local-client-id',
+        redirectUri: 'http://studio.local.prisme.ai:3000/signin',
+        ...opts.oidc,
+      },
+      websockets: {
+        ...opts.websockets,
+        transports: opts.websockets?.transports || ['polling', 'websocket'],
+      },
+    };
+  }
+
   get user() {
     return this._user;
   }
@@ -39,24 +117,85 @@ export class Api extends Fetcher {
     return me;
   }
 
-  async signin(
-    email: string,
-    password: string
-  ): Promise<
-    Prismeai.User & {
-      token: string;
+  clientId(): string {
+    return this.overwriteClientId || this.opts?.oidc?.clientId;
+  }
+
+  async getAuthorizationURL(
+    overrideRedirectUri?: string,
+    authParams?: { max_age?: string; acr_values?: string },
+    locale = window?.navigator?.language
+      ? window.navigator.language.substring(0, 2)
+      : undefined
+  ) {
+    const url = new URL('/oidc/auth', this.opts.oidc.url);
+    url.searchParams.set('response_type', 'code');
+    url.searchParams.set('response_mode', 'query'); // Send the final authorization code as a query param to the redirect uri
+    url.searchParams.set(
+      'redirect_uri',
+      overrideRedirectUri || this.opts.oidc?.redirectUri || ''
+    );
+    url.searchParams.set(
+      'scope',
+      'openid profile email settings offline_access events:write events:read webhooks pages:read files:write files:read'
+    );
+    const clientId = this.clientId();
+    url.searchParams.set('client_id', clientId);
+
+    url.searchParams.set('code_challenge_method', 'S256');
+    const { code_verifier: codeVerifier, code_challenge: codeChallenge } =
+      await pkceChallenge(64);
+    url.searchParams.set('code_challenge', codeChallenge);
+    if (locale) {
+      url.searchParams.set('locale', locale);
     }
-  > {
-    const user = await this.post<
-      Prismeai.User & {
-        token: string;
-      }
-    >('/login', {
-      email,
-      password,
+
+    Object.entries(authParams || {}).forEach(([k, v]) => {
+      url.searchParams.set(k, v);
     });
-    this._user = user;
-    return user;
+
+    return {
+      url: url.toString(),
+      codeVerifier,
+      clientId,
+    };
+  }
+
+  async signin(body: InteractiveSignin): Promise<{ redirectTo: string }> {
+    const url = new URL(
+      `/oidc/interaction/${body.interaction}/login`,
+      this.opts.oidc.url
+    );
+
+    // Do not follow redirects as we need to get redirected from browser itself to save final token in local storage
+    await this.post(url.toString(), new URLSearchParams(body as any), {
+      redirect: 'manual',
+    });
+    const redirectTo = new URL(
+      `/oidc/auth/${body.interaction}`,
+      this.opts.oidc.url
+    );
+    return { redirectTo: redirectTo.toString() };
+  }
+
+  async getToken(
+    authorizationCode: string,
+    codeVerifier: string,
+    overrideRedirectUri?: string
+  ): Promise<AccessToken> {
+    this.token = null;
+    const url = new URL('/oidc/token', this.opts.oidc.url);
+    const token = await this.post<AccessToken>(
+      url.toString(),
+      new URLSearchParams({
+        grant_type: 'authorization_code',
+        code: authorizationCode,
+        code_verifier: codeVerifier,
+        client_id: this.clientId(),
+        redirect_uri: overrideRedirectUri || this.opts.oidc.redirectUri,
+      })
+    );
+    return token;
   }
 
   async createAnonymousSession(): Promise<
@@ -84,18 +223,32 @@ export class Api extends Fetcher {
       token: string;
     }
   > {
-    return await this.post('/signup', {
-      email: email,
-      password,
-      firstName,
-      lastName,
-      language,
-    });
+    return await this.post(
+      '/signup',
+      {
+        email: email,
+        password,
+        firstName,
+        lastName,
+        language,
+      },
+      {
+        credentials: 'omit',
+      }
+    );
   }
 
-  async signout() {
-    await this.post('/logout');
-    this.token = null;
+  getSignoutURL(redirectUri?: string) {
+    const params = new URLSearchParams();
+    params.set('client_id', this.clientId());
+    if (redirectUri) {
+      params.set('post_logout_redirect_uri', redirectUri);
+    }
+    const url = new URL(
+      `/oidc/session/end?${params.toString()}`,
+      this.opts.oidc.url
+    );
+    return url.toString();
   }
 
   // Mail validation
@@ -118,7 +271,7 @@ export class Api extends Fetcher {
 
   // Workspaces
   async getWorkspaces(): Promise<Workspace[]> {
-    return await this.get('/workspaces?limit=600');
+    return await this.get('/workspaces?limit=2000');
   }
 
   async getWorkspace(
@@ -136,27 +289,54 @@ export class Api extends Fetcher {
   async updateWorkspaceSecurity(
     workspaceId: string,
     security: Prismeai.WorkspaceSecurity
-  ): Promise<PrismeaiAPI.UpdateSecurity.Responses.$200> {
+  ): Promise<Fetched<PrismeaiAPI.UpdateSecurity.Responses.$200>> {
     return await this.put(`/workspaces/${workspaceId}/security`, security);
   }
 
   async getWorkspaceRoles(
     id: string
-  ): Promise<PrismeaiAPI.GetRoles.Responses.$200> {
+  ): Promise<Fetched<PrismeaiAPI.GetRoles.Responses.$200>> {
     return await this.get(`/workspaces/${id}/security/roles`);
   }
 
-  async createWorkspace(name: string): Promise<Workspace> {
-    return await this.post('/workspaces', { name });
+  async getWorkspaceSecrets(
+    id: string
+  ): Promise<Fetched<PrismeaiAPI.GetWorkspaceSecrets.Responses.$200>> {
+    return await this.get(`/workspaces/${id}/security/secrets`);
+  }
+
+  async updateWorkspaceSecrets(
+    id: string,
+    newSecrets: any
+  ): Promise<Workspace> {
+    return await this.patch(`/workspaces/${id}/security/secrets`, {
+      ...newSecrets,
+    });
+  }
+
+  async deleteWorkspaceSecrets(
+    id: string,
+    secretName: string
+  ): Promise<Workspace> {
+    return await this.delete(
+      `/workspaces/${id}/security/secrets/${secretName}`
+    );
+  }
+
+  async createWorkspace(
+    newWorkspace: Partial<Prismeai.Workspace>
+  ): Promise<Workspace> {
+    return await this.post('/workspaces', newWorkspace);
   }
 
   async duplicateWorkspace({ id }: { id: string }): Promise<Workspace | null> {
     return await this.post(`/workspaces/${id}/versions/current/duplicate`, {});
   }
 
+  // @deprecated. Use api.workspaces(id).update() instead
   async updateWorkspace(
     workspace: Prismeai.DSULPatch
-  ): Promise<PrismeaiAPI.UpdateWorkspace.Responses.$200 | null> {
+  ): Promise<Fetched<PrismeaiAPI.UpdateWorkspace.Responses.$200> | null> {
     if (!workspace.id) return null;
     return await this.patch(
       `/workspaces/${workspace.id}`,
@@ -164,6 +344,7 @@ export class Api extends Fetcher {
     );
   }
 
+  // @deprecated. Use api.workspaces(id).delete() instead
   async deleteWorkspace(workspaceId: Workspace['id']): Promise<Workspace> {
     return await this.delete(`/workspaces/${workspaceId}`);
   }
@@ -223,16 +404,18 @@ export class Api extends Fetcher {
   async getAutomation(
     workspaceId: string,
     automationSlug: string
-  ): Promise<PrismeaiAPI.GetAutomation.Responses.$200> {
+  ): Promise<Fetched<PrismeaiAPI.GetAutomation.Responses.$200>> {
     return await this.get(
-      `/workspaces/${workspaceId}/automations/${automationSlug}`
+      `/workspaces/${workspaceId}/automations/${encodeURIComponent(
+        automationSlug
+      )}`
     );
   }
 
   async createAutomation(
     workspaceId: Workspace['id'],
     automation: Prismeai.Automation
-  ): Promise<Prismeai.Automation & { slug: string }> {
+  ): Promise<Fetched<Prismeai.Automation & { slug: string }>> {
     return await this.post(`/workspaces/${workspaceId}/automations`, {
       ...automation,
     });
@@ -242,15 +425,17 @@ export class Api extends Fetcher {
     workspaceId: string,
     slug: string,
     automation: Prismeai.Automation
-  ): Promise<Prismeai.Automation & { slug: string }> {
+  ): Promise<Fetched<Prismeai.Automation & { slug: string }>> {
     return await this.patch(
-      `/workspaces/${workspaceId}/automations/${slug}`,
+      `/workspaces/${workspaceId}/automations/${encodeURIComponent(slug)}`,
       await this.replaceAllImagesData(automation, workspaceId)
     );
   }
 
   async deleteAutomation(workspaceId: string, slug: string): Promise<string> {
-    return await this.delete(`/workspaces/${workspaceId}/automations/${slug}`);
+    return await this.delete(
+      `/workspaces/${workspaceId}/automations/${encodeURIComponent(slug)}`
+    );
   }
 
   // Pages
@@ -272,7 +457,7 @@ export class Api extends Fetcher {
   async getPage(
     workspaceId: PrismeaiAPI.GetPage.Parameters.WorkspaceId,
     pageSlug: PrismeaiAPI.GetPage.Parameters.Slug
-  ): Promise<Prismeai.DetailedPage> {
+  ): Promise<Fetched<Prismeai.DetailedPage>> {
     return await this.get(
       `/workspaces/${workspaceId}/pages/${encodeURIComponent(pageSlug)}`
     );
@@ -281,7 +466,7 @@ export class Api extends Fetcher {
   async getPageBySlug(
     workspaceSlug: PrismeaiAPI.GetPageBySlug.Parameters.WorkspaceSlug,
     pageSlug: PrismeaiAPI.GetPageBySlug.Parameters.PageSlug
-  ): Promise<Prismeai.DetailedPage> {
+  ): Promise<Fetched<Prismeai.DetailedPage>> {
     return await this.get(
       `/pages/${workspaceSlug}/${encodeURIComponent(pageSlug)}`
     );
@@ -316,7 +501,7 @@ export class Api extends Fetcher {
   async deletePage(
     workspaceId: PrismeaiAPI.DeletePage.Parameters.WorkspaceId,
     pageSlug: PrismeaiAPI.DeletePage.Parameters.Slug
-  ): Promise<PrismeaiAPI.DeletePage.Responses.$200> {
+  ): Promise<Fetched<PrismeaiAPI.DeletePage.Responses.$200>> {
     return await this.delete(
       `/workspaces/${workspaceId}/pages/${encodeURIComponent(pageSlug)}`
     );
@@ -330,6 +515,7 @@ export class Api extends Fetcher {
     if (filters && filters['source.sessionId'] === true) {
       if (this.sessionId) {
         filters['source.sessionId'] = this.sessionId;
+        filters['target.userTopic'] = ''; // We do not want to receive userTopics emitted by ourself for this session listener
       } else {
         delete filters['source.sessionId'];
       }
@@ -337,10 +523,12 @@ export class Api extends Fetcher {
     const events = new Events({
       workspaceId,
       token: this.token || '',
+      legacyToken: this.legacyToken || '',
       apiKey: this._apiKey ? this._apiKey : undefined,
       apiHost: this.host,
       filters,
       api: this,
+      transports: this.opts?.websockets?.transports,
     });
     return new Promise((resolve, reject) => {
       const off = events.once('connect_error', () => {
@@ -448,7 +636,6 @@ export class Api extends Fetcher {
           {
             error: 'CollaboratorNotFound',
             message: 'This user does not exist',
-            details: { email },
           },
           404
         );
@@ -474,7 +661,7 @@ export class Api extends Fetcher {
     subjectType: PrismeaiAPI.GetPermissions.Parameters.SubjectType,
     subjectId: string,
     id: string
-  ): Promise<PrismeaiAPI.RevokePermissions.Responses.$200> {
+  ): Promise<Fetched<PrismeaiAPI.RevokePermissions.Responses.$200>> {
     return await this.delete(`/${subjectType}/${subjectId}/permissions/${id}`);
   }
 
@@ -488,7 +675,7 @@ export class Api extends Fetcher {
     page?: PrismeaiAPI.SearchApps.QueryParameters['page'];
     limit?: PrismeaiAPI.SearchApps.QueryParameters['limit'];
     workspaceId?: PrismeaiAPI.SearchApps.QueryParameters['workspaceId'];
-  }): Promise<PrismeaiAPI.SearchApps.Responses.$200> {
+  }): Promise<Fetched<PrismeaiAPI.SearchApps.Responses.$200>> {
     const params = new URLSearchParams(
       removedUndefinedProperties(
         {
@@ -503,10 +690,18 @@ export class Api extends Fetcher {
     return await this.get(`/apps?${params.toString()}`);
   }
 
+  async getApp({
+    slug = '',
+  }: {
+    slug?: PrismeaiAPI.GetApp.PathParameters['appSlug'];
+  }): Promise<Fetched<PrismeaiAPI.GetApp.Responses.$200>> {
+    return await this.get(`/apps/${encodeURIComponent(slug)}`);
+  }
+
   async installApp(
     workspaceId: PrismeaiAPI.InstallAppInstance.PathParameters['workspaceId'],
     body: PrismeaiAPI.InstallAppInstance.RequestBody
-  ): Promise<PrismeaiAPI.InstallAppInstance.Responses.$200> {
+  ): Promise<Fetched<PrismeaiAPI.InstallAppInstance.Responses.$200>> {
     return await this.post(`/workspaces/${workspaceId}/apps`, body);
   }
 
@@ -514,26 +709,27 @@ export class Api extends Fetcher {
     workspaceId: PrismeaiAPI.ConfigureAppInstance.PathParameters['workspaceId'],
     slug: PrismeaiAPI.ConfigureAppInstance.PathParameters['slug'],
     body: PrismeaiAPI.ConfigureAppInstance.RequestBody
-  ): Promise<PrismeaiAPI.ConfigureAppInstance.Responses.$200> {
+  ): Promise<Fetched<PrismeaiAPI.ConfigureAppInstance.Responses.$200>> {
     return await this.patch(`/workspaces/${workspaceId}/apps/${slug}`, body);
   }
 
   async uninstallApp(
     workspaceId: PrismeaiAPI.UninstallAppInstance.PathParameters['workspaceId'],
     slug: PrismeaiAPI.ConfigureAppInstance.PathParameters['slug']
-  ): Promise<PrismeaiAPI.UninstallAppInstance.Responses.$200> {
+  ): Promise<Fetched<PrismeaiAPI.UninstallAppInstance.Responses.$200>> {
     return await this.delete(`/workspaces/${workspaceId}/apps/${slug}`);
   }
 
   async publishApp(
     body: PrismeaiAPI.PublishApp.RequestBody
-  ): Promise<PrismeaiAPI.PublishApp.Responses.$200> {
+  ): Promise<Fetched<PrismeaiAPI.PublishApp.Responses.$200>> {
     return await this.post(`/apps`, body);
   }
 
+  // @deprecated. Use api.workspaces(id).listAppInstances())
   async listAppInstances(
     workspaceId: PrismeaiAPI.ListAppInstances.PathParameters['workspaceId']
-  ): Promise<PrismeaiAPI.ListAppInstances.Responses.$200> {
+  ): Promise<Fetched<PrismeaiAPI.ListAppInstances.Responses.$200>> {
     return await this.get(`/workspaces/${workspaceId}/apps`);
   }
 
@@ -562,7 +758,7 @@ export class Api extends Fetcher {
   async getAppInstance(
     workspaceId: string,
     slug: string
-  ): Promise<PrismeaiAPI.GetAppInstance.Responses.$200> {
+  ): Promise<Fetched<PrismeaiAPI.GetAppInstance.Responses.$200>> {
     return this.get(`/workspaces/${workspaceId}/apps/${slug}`);
   }
 
@@ -570,7 +766,7 @@ export class Api extends Fetcher {
     workspaceId: PrismeaiAPI.ConfigureAppInstance.Parameters.WorkspaceId,
     slug: PrismeaiAPI.ConfigureAppInstance.Parameters.Slug,
     appInstance: PrismeaiAPI.ConfigureAppInstance.RequestBody
-  ): Promise<PrismeaiAPI.ConfigureAppInstance.Responses.$200> {
+  ): Promise<Fetched<PrismeaiAPI.ConfigureAppInstance.Responses.$200>> {
     const response = await this.patch<Prismeai.DetailedAppInstance>(
       `/workspaces/${workspaceId}/apps/${slug}`,
       { ...appInstance }
@@ -578,37 +774,31 @@ export class Api extends Fetcher {
     return response;
   }
 
-  async uploadFiles(files: string | string[], workspaceId: string) {
-    function dataURItoBlob(dataURI: string): [Blob, string] {
-      // convert base64/URLEncoded data component to raw binary data held in a string
-      let byteString;
-      if (dataURI.split(',')[0].indexOf('base64') >= 0)
-        byteString = atob(dataURI.split(',')[1]);
-      else byteString = unescape(dataURI.split(',')[1]);
-      // separate out the mime component
-      const metadata = dataURI
-        .split(';')
-        .filter((v, k, all) => k < all.length - 1)
-        .map((v) => v.split(/:/));
-      const [, mimeString = ''] = metadata.find(([k, v]) => k === 'data') || [];
-      const [, ext] = mimeString.split(/\//);
-      const [, fileName = `file.${ext}`] =
-        metadata.find(([k, v]) => k === 'filename') || [];
-
-      // write the bytes of the string to a typed array
-      let ia = new Uint8Array(byteString.length);
-      for (var i = 0; i < byteString.length; i++) {
-        ia[i] = byteString.charCodeAt(i);
-      }
-
-      return [new Blob([ia], { type: mimeString }), fileName];
+  // @deprecated. Use api.workspaces(id).uploadFiles()
+  async uploadFiles(
+    files: string | string[],
+    workspaceId: string,
+    opts?: {
+      expiresAfter?: number;
+      public?: boolean;
+      shareToken?: boolean;
     }
+  ) {
     const formData = new FormData();
     (Array.isArray(files) ? files : [files]).forEach((file) => {
       try {
         formData.append('file', ...dataURItoBlob(file));
       } catch {}
     });
+    if (opts?.expiresAfter) {
+      formData.append('expiresAfter', `${opts?.expiresAfter}`);
+    }
+    if (typeof opts?.public === 'boolean') {
+      formData.append('public', `${opts?.public}`);
+    }
+    if (typeof opts?.shareToken === 'boolean') {
+      formData.append('shareToken', `${opts?.shareToken}`);
+    }
     try {
       return await this._fetch<PrismeaiAPI.UploadFile.Responses.$200>(
         `/workspaces/${workspaceId}/files`,
@@ -665,17 +855,39 @@ export class Api extends Fetcher {
     return replaced;
   }
 
+  getAutomationFromUrl(workspaceId: string, url: string) {
+    const match = url.match(
+      `${this.host}/workspaces/${workspaceId}/webhooks\/(.*$)`
+    );
+    return match ? match[1] : false;
+  }
+
   async callAutomation(
     workspaceId: string,
     automation: string,
     params?: any
-  ): Promise<any> {
+  ): Promise<Fetched<any>> {
     return this.post(
       `/workspaces/${workspaceId}/webhooks/${automation}`,
       params
     );
   }
 
+  async testAutomation({
+    workspaceId,
+    automation,
+    payload,
+  }: {
+    workspaceId: string;
+    automation: string;
+    payload?: Record<string, any>;
+  }): Promise<Fetched<any>> {
+    return this.post(`/workspaces/${workspaceId}/test/${automation}`, {
+      payload,
+    });
+  }
+
+  // @deprecated. Use api.workspaces(id).getUsage())
   async getWorkspaceUsage(
     workspaceId: PrismeaiAPI.WorkspaceUsage.Parameters.WorkspaceId,
     {
@@ -687,7 +899,7 @@ export class Api extends Fetcher {
       beforeDate?: PrismeaiAPI.WorkspaceUsage.Parameters.BeforeDate;
       details?: PrismeaiAPI.WorkspaceUsage.Parameters.Details;
     } = {}
-  ): Promise<PrismeaiAPI.WorkspaceUsage.Responses.$200> {
+  ): Promise<Fetched<PrismeaiAPI.WorkspaceUsage.Responses.$200>> {
     const params = new URLSearchParams(
       removedUndefinedProperties(
         {
@@ -702,9 +914,36 @@ export class Api extends Fetcher {
     return this.get(`/workspaces/${workspaceId}/usage?${params.toString()}`);
   }
 
+  async importArchive(archive: File): Promise<ImportSuccess> {
+    return new Promise((resolve) => {
+      const fileReader = new FileReader();
+      fileReader.addEventListener('load', async ({ target }) => {
+        const file = target?.result as string;
+        const formData = new FormData();
+        formData.append('archive', ...dataURItoBlob(file));
+
+        const result = await this.post<ImportProcessing | ImportSuccess>(
+          `/workspaces/import`,
+          formData
+        );
+        if ((result as ImportProcessing).processing) {
+          throw new ImportProcessingError(result as ImportProcessing);
+        }
+        resolve(result as ImportSuccess);
+      });
+      fileReader.readAsDataURL(archive);
+    });
+  }
+
+  users(id: string = this.user?.id || '') {
+    if (!id) {
+      throw new Error();
+    }
+    return new UsersEndpoint(id, this);
+  }
   workspaces(id: string) {
     return new WorkspacesEndpoint(id, this);
   }
 }
 
-export default new Api('https://api.eda.prisme.ai');
+export default new Api({ host: 'https://api.eda.prisme.ai' });