@api-client/core 0.9.0 → 0.9.3

package/src/runtime/store/FilesSdk.ts

@@ -7,7 +7,7 @@ import { Kind as ProjectKind } from '../../models/Project.js';
 import { Kind as FolderKind } from '../../models/Folder.js';
 import { Kind as DataNamespaceKind } from '../../models/data/DataNamespace.js';
 import { SdkError } from './Errors.js';
-import { ContextListResult, IPatchInfo, IPatchRevision, IAccessPatchInfo, ContextSpaceListOptions, ContextChangeRecord, IBulkOperationResult } from '../../events/BaseEvents.js';
+import { ContextListResult, IPatchInfo, IPatchRevision, IAccessPatchInfo, ContextChangeRecord, IBulkOperationResult, ContextListOptions } from '../../events/BaseEvents.js';
 
 export interface IMetaCreateOptions {
   /**
@@ -41,17 +41,19 @@ export class FilesSdk extends SdkBase {
   /**
    * Lists files (spaces, projects, etc) in the store.
    * 
+   * @param space the parent space for files.
    * @param kinds Optional list of kinds to limit the file types in the result. Spaces are always included.
    * @param options Optional query options.
    * @param request Optional request options.
    */
-  async list(kinds?: ListFileKind[], options?: ContextSpaceListOptions, request: ISdkRequestOptions = {}): Promise<ContextListResult<IFile>> {
+  async list(space: string, kinds?: ListFileKind[], options?: ContextListOptions, request: ISdkRequestOptions = {}): Promise<ContextListResult<IFile>> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.files());
     this.sdk.appendListOptions(url, options);
     if (Array.isArray(kinds)) {
       kinds.forEach(k => url.searchParams.append('kind', k));
     }
+    url.searchParams.set('space', space);
     const result = await this.sdk.http.get(url.toString(), { token });
     this.inspectCommonStatusCodes(result.status, result.body);
     const E_PREFIX = 'Unable to list files. ';
@@ -90,7 +92,7 @@ export class FilesSdk extends SdkBase {
    */
   async create(meta: IFile, contents: unknown, space: string, opts: IFileCreateOptions = {}, request: ISdkRequestOptions = {}): Promise<ContextChangeRecord<IFile>> {
     const result = await this.createMeta(meta, space, opts, request);
-    await this.createMedia(contents, result.key, opts, request);
+    await this.createMedia(contents, result.key, space, opts, request);
     return result;
   }
 
@@ -152,10 +154,11 @@ export class FilesSdk extends SdkBase {
    * @param opts Contents create options. You can define content's mime type here.
    * @param request Optional request.
    */
-  async createMedia(contents: unknown, key: string, opts: IMediaCreateOptions = {}, request: ISdkRequestOptions = {}): Promise<void> {
+  async createMedia(contents: unknown, space: string, key: string, opts: IMediaCreateOptions = {}, request: ISdkRequestOptions = {}): Promise<void> {
     const token = request.token || this.sdk.token;
     const path = RouteBuilder.file(key);
     const url = this.sdk.getUrl(path);
+    url.searchParams.set('space', space);
     url.searchParams.set('alt', 'media');
     const mime = opts.mime || 'application/json';
     let body: string;
@@ -191,7 +194,7 @@ export class FilesSdk extends SdkBase {
    * @param request Optional request options.
    * @returns THe file metadata
    */
-  read(key: string, media: false, request?: ISdkRequestOptions): Promise<IFile>;
+  read(space: string, key: string, media: false, request?: ISdkRequestOptions): Promise<IFile>;
 
   /**
    * Reads file contents from the store.
@@ -200,7 +203,7 @@ export class FilesSdk extends SdkBase {
    * @param request Optional request options.
    * @returns THe file contents
    */
-  read(key: string, media: true, request?: ISdkRequestOptions): Promise<unknown>;
+  read(space: string, key: string, media: true, request?: ISdkRequestOptions): Promise<unknown>;
 
   /**
    * Reads a user file definition from the store.
@@ -208,9 +211,10 @@ export class FilesSdk extends SdkBase {
    * @param media When true it reads file contents rather than metadata.
    * @param request Optional request options.
    */
-  async read(key: string, media?: boolean, request: ISdkRequestOptions = {}): Promise<IFile | unknown> {
+  async read(space: string, key: string, media?: boolean, request: ISdkRequestOptions = {}): Promise<IFile | unknown> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.file(key));
+    url.searchParams.set('space', space);
     if (media) {
       url.searchParams.set('alt', 'media');
     }
@@ -250,9 +254,10 @@ export class FilesSdk extends SdkBase {
    * in that place. It also inserts `undefined` in place of a file that doesn't exist.
    * @param request Optional request options.
    */
-  async readBulk(keys: string[], request: ISdkRequestOptions = {}): Promise<IBulkOperationResult<IFile>> {
+  async readBulk(space: string, keys: string[], request: ISdkRequestOptions = {}): Promise<IBulkOperationResult<IFile>> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.filesBatch());
+    url.searchParams.set('space', space);
     const body = JSON.stringify(keys);
     const result = await this.sdk.http.post(url.toString(), { token, body });
     this.inspectCommonStatusCodes(result.status, result.body);
@@ -288,7 +293,7 @@ export class FilesSdk extends SdkBase {
    * @param value The patch to apply.
    * @param request Optional request options.
    */
-  patch(key: string, value: IPatchInfo, media: false, request?: ISdkRequestOptions): Promise<IPatchRevision>;
+  patch(space: string, key: string, value: IPatchInfo, media: false, request?: ISdkRequestOptions): Promise<IPatchRevision>;
 
   /**
    * Patches file's content in the store.
@@ -297,7 +302,7 @@ export class FilesSdk extends SdkBase {
    * @param value The patch to apply.
    * @param request Optional request options.
    */
-  patch(key: string, value: IPatchInfo, media: true, request?: ISdkRequestOptions): Promise<IPatchRevision>;
+  patch(space: string, key: string, value: IPatchInfo, media: true, request?: ISdkRequestOptions): Promise<IPatchRevision>;
 
   /**
    * Patches a file in the store.
@@ -306,9 +311,10 @@ export class FilesSdk extends SdkBase {
    * @param request Optional request options.
    * @returns The JSON patch to revert the change using the `@api-client/json` library
    */
-  async patch(key: string, value: IPatchInfo, media?: boolean, request: ISdkRequestOptions = {}): Promise<IPatchRevision> {
+  async patch(space: string, key: string, value: IPatchInfo, media?: boolean, request: ISdkRequestOptions = {}): Promise<IPatchRevision> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.file(key));
+    url.searchParams.set('space', space);
     if (media) {
       url.searchParams.set('alt', 'media');
     }
@@ -347,9 +353,10 @@ export class FilesSdk extends SdkBase {
    * @param key The key of the file to delete.
    * @param request Optional request options.
    */
-  async delete(key: string, request: ISdkRequestOptions = {}): Promise<void> {
+  async delete(space: string, key: string, request: ISdkRequestOptions = {}): Promise<void> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.file(key));
+    url.searchParams.set('space', space);
     const result = await this.sdk.http.delete(url.toString(), { token });
     this.inspectCommonStatusCodes(result.status, result.body);
     const E_PREFIX = 'Unable to delete a file. ';
@@ -371,9 +378,10 @@ export class FilesSdk extends SdkBase {
    * @param value The patch operation on the file's ACL
    * @param request Optional request options.
    */
-  async patchUsers(key: string, value: IAccessPatchInfo, request: ISdkRequestOptions = {}): Promise<void> {
+  async patchUsers(space: string, key: string, value: IAccessPatchInfo, request: ISdkRequestOptions = {}): Promise<void> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.fileUsers(key));
+    url.searchParams.set('space', space);
     const body = JSON.stringify(value);
     const result = await this.sdk.http.patch(url.toString(), { token, body });
     this.inspectCommonStatusCodes(result.status, result.body);
@@ -395,9 +403,10 @@ export class FilesSdk extends SdkBase {
    * @param key The file key
    * @param request Optional request options.
    */
-  async listUsers(key: string, request: ISdkRequestOptions = {}): Promise<ContextListResult<IUser>> {
+  async listUsers(space: string, key: string, request: ISdkRequestOptions = {}): Promise<ContextListResult<IUser>> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.fileUsers(key));
+    url.searchParams.set('space', space);
     const result = await this.sdk.http.get(url.toString(), { token });
     this.inspectCommonStatusCodes(result.status, result.body);
     const E_PREFIX = 'Unable to list users in the file. ';
@@ -442,9 +451,10 @@ export class FilesSdk extends SdkBase {
    * @param media Whether to observe changes to the file media instead of meta.
    * @param request Optional request options.
    */
-  async observeFile(key: string, media?: boolean, request: ISdkRequestOptions = {}): Promise<WebSocketNode | WebSocket> {
+  async observeFile(space: string, key: string, media?: boolean, request: ISdkRequestOptions = {}): Promise<WebSocketNode | WebSocket> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.file(key));
+    url.searchParams.set('space', space);
     if (media) {
       url.searchParams.set('alt', 'media');
     }
@@ -455,9 +465,10 @@ export class FilesSdk extends SdkBase {
    * Lists breadcrumbs to the file.
    * @param key The lowest file in the hierarchy
    */
-  async breadcrumbs(key: string, request: ISdkRequestOptions = {}): Promise<ContextListResult<FileBreadcrumb>> {
+  async breadcrumbs(space: string, key: string, request: ISdkRequestOptions = {}): Promise<ContextListResult<FileBreadcrumb>> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.fileBreadcrumbs(key));
+    url.searchParams.set('space', space);
     const result = await this.sdk.http.get(url.toString(), { token });
     this.inspectCommonStatusCodes(result.status, result.body);
     const E_PREFIX = 'Unable to read a file. ';

package/src/runtime/store/HistorySdk.ts

@@ -76,12 +76,12 @@ export class HistorySdk extends SdkBase {
     }
     let data: IBulkOperationResult<ContextChangeRecord<IHttpHistory>>;
     try {
-      data = JSON.parse(result.body).items;
+      data = JSON.parse(result.body);
     } catch (e) {
-      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}`);
     }
     if (!data.items) {
-      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`);
     }
     return data;
   }
@@ -153,7 +153,7 @@ export class HistorySdk extends SdkBase {
     const path =  RouteBuilder.historyItem(key);
     const url = this.sdk.getUrl(path);
 
-    const result = await this.sdk.http.post(url.toString(), { token });
+    const result = await this.sdk.http.delete(url.toString(), { token });
     this.inspectCommonStatusCodes(result.status);
     const E_PREFIX = 'Unable to delete history. ';
     if (result.status !== 204) {
@@ -258,9 +258,9 @@ export class HistorySdk extends SdkBase {
     }
   }
 
-  async clearProject(projectKey: string, request: ISdkRequestOptions = {}): Promise<void> {
+  async clearProject(spaceKey: string, projectKey: string, request: ISdkRequestOptions = {}): Promise<void> {
     const token = request.token || this.sdk.token;
-    const url = this.sdk.getUrl(RouteBuilder.historyClear('project', projectKey));
+    const url = this.sdk.getUrl(RouteBuilder.historyClear('project', spaceKey, projectKey));
     const result = await this.sdk.http.delete(url.toString(), { token });
     this.inspectCommonStatusCodes(result.status, result.body);
     const E_PREFIX = 'Unable to clear history for the project. ';
@@ -275,9 +275,9 @@ export class HistorySdk extends SdkBase {
     }
   }
 
-  async clearRequest(projectKey: string, requestKey: string, request: ISdkRequestOptions = {}): Promise<void> {
+  async clearRequest(spaceKey: string, projectKey: string, requestKey: string, request: ISdkRequestOptions = {}): Promise<void> {
     const token = request.token || this.sdk.token;
-    const url = this.sdk.getUrl(RouteBuilder.historyClear('request', projectKey, requestKey));
+    const url = this.sdk.getUrl(RouteBuilder.historyClear('request', spaceKey, projectKey, requestKey));
     const result = await this.sdk.http.delete(url.toString(), { token });
     this.inspectCommonStatusCodes(result.status, result.body);
     const E_PREFIX = 'Unable to clear history for the request. ';

package/src/runtime/store/SharedSdk.ts

@@ -3,7 +3,7 @@ import { RouteBuilder } from './RouteBuilder.js';
 import { IFile } from '../../models/store/File.js';
 import { SdkError } from './Errors.js';
 import { ListFileKind } from './FilesSdk.js';
-import { ContextListResult, ContextSpaceListOptions } from '../../events/BaseEvents.js';
+import { ContextListOptions, ContextListResult } from '../../events/BaseEvents.js';
 
 export class SharedSdk extends SdkBase {
   /**
@@ -13,13 +13,14 @@ export class SharedSdk extends SdkBase {
    * @param options Optional query options.
    * @param request Optional request options.
    */
-  async list(kinds?: ListFileKind[], options?: ContextSpaceListOptions, request: ISdkRequestOptions = {}): Promise<ContextListResult<IFile>> {
+  async list(space: string, kinds?: ListFileKind[], options?: ContextListOptions, request: ISdkRequestOptions = {}): Promise<ContextListResult<IFile>> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.shared());
     this.sdk.appendListOptions(url, options);
     if (Array.isArray(kinds)) {
       kinds.forEach(k => url.searchParams.append('kind', k));
     }
+    url.searchParams.set('space', space);
     const result = await this.sdk.http.get(url.toString(), { token });
     this.inspectCommonStatusCodes(result.status, result.body);
     const E_PREFIX = 'Unable to list spaces. ';

package/src/runtime/store/interfaces/Files.ts

@@ -29,7 +29,7 @@ export interface Files {
    * 
    * @param key The id of the file to read the metadata for.
    */
-  read(key: string): Promise<IFile>;
+  read(space: string, key: string): Promise<IFile>;
 
   /**
    * Reads multiple files in a single call.
@@ -42,7 +42,7 @@ export interface Files {
    * 
    * @param keys The list of keys to read
    */
-  readBulk(keys: string[]): Promise<IBulkOperationResult<IFile>>;
+  readBulk(space: string, keys: string[]): Promise<IBulkOperationResult<IFile>>;
 
   /**
    * Marks file as deleted.
@@ -51,7 +51,7 @@ export interface Files {
    * 
    * @param key The database id of the file to remove.
    */
-  delete(key: string): Promise<ContextDeleteRecord>;
+  delete(space: string, key: string): Promise<ContextDeleteRecord>;
 
   /**
    * This is the preferred way to update a file metadata. It allows to apply a reversible patch 
@@ -60,11 +60,11 @@ export interface Files {
    * @param key The datastore id of the file to patch
    * @param info The patch to apply.
    */
-  patch(key: string, info: IPatchInfo): Promise<IPatchRevision>;
+  patch(space: string, key: string, info: IPatchInfo): Promise<IPatchRevision>;
 
   /**
    * Lists breadcrumbs to the file.
    * @param key The lowest file in the hierarchy
    */
-  breadcrumbs(key: string): Promise<ContextListResult<FileBreadcrumb>>;
+  breadcrumbs(space: string, key: string): Promise<ContextListResult<FileBreadcrumb>>;
 }

package/src/runtime/store/interfaces/History.ts

@@ -53,12 +53,12 @@ export interface History {
    * 
    * @param project The parent project key
    */
-  clearProject(project: string): Promise<void>;
+  clearProject(space: string, project: string): Promise<void>;
   /**
    * Clears all history from a request
    * 
    * @param project The parent project key
    * @param request The parent request key
    */
-  clearRequest(project: string, request: string): Promise<void>;
+  clearRequest(space: string, project: string, request: string): Promise<void>;
 }