@api-client/core 0.5.0 → 0.5.3

package/src/runtime/store/Sdk.ts

@@ -7,6 +7,7 @@ import { SpacesSdk } from './SpacesSdk.js';
 import { ProjectsSdk } from './ProjectsSdk.js';
 import { UsersSdk } from './UsersSdk.js';
 import { HistorySdk } from './HistorySdk.js';
+import { SharedSdk } from './SharedSdk.js';
 
 const baseUriSymbol = Symbol('baseUri');
 
@@ -50,6 +51,10 @@ export abstract class Sdk {
    * The history data.
    */
   history = new HistorySdk(this);
+  /**
+   * The shared data.
+   */
+  shared = new SharedSdk(this);
 
 
   [baseUriSymbol] = '';
@@ -126,6 +131,9 @@ export abstract class Sdk {
           searchParams.append('queryField', field);
         });
       }
+      if (options.parent) {
+        searchParams.set('parent', options.parent);
+      }
     }
   }
 }

package/src/runtime/store/SharedSdk.ts

@@ -0,0 +1,35 @@
+import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN } from './SdkBase.js';
+import { RouteBuilder } from './RouteBuilder.js';
+import { IListOptions, IListResponse } from '../../models/Backend.js';
+
+export class SharedSdk extends SdkBase {
+  /**
+   * Lists shared with the user spaces.
+   * @param options Optional query options.
+   */
+  async list(options?: IListOptions): Promise<IListResponse> {
+    const { token } = this.sdk;
+    const url = this.sdk.getUrl(RouteBuilder.sharedSpaces());
+    this.sdk.appendListOptions(url, options);
+    const result = await this.sdk.http.get(url.toString(), { token });
+    this.inspectCommonStatusCodes(result.status);
+    const E_PREFIX = 'Unable to list spaces. ';
+    if (result.status !== 200) {
+      this.logInvalidResponse(result);
+      throw new Error(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`);
+    }
+    if (!result.body) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
+    }
+    let data: IListResponse;
+    try {
+      data = JSON.parse(result.body);
+    } catch (e) {
+      throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
+    }
+    if (!Array.isArray(data.data)) {
+      throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
+    }
+    return data;
+  }
+}

package/src/runtime/store/SpacesSdk.ts

@@ -4,6 +4,15 @@ import { RouteBuilder } from './RouteBuilder.js';
 import { IListOptions, IListResponse } from '../../models/Backend.js';
 import { IWorkspace, Workspace, Kind as WorkspaceKind } from '../../models/Workspace.js';
 import { AccessOperation } from '../../models/store/Permission.js';
+import WebSocketNode from 'ws';
+
+export interface ISpaceCreateOptions {
+  /**
+   * Optional parent space id.
+   * When set it creates a space under this parent.
+   */
+  parent?: string;
+}
 
 export class SpacesSdk extends SdkBase {
   /**
@@ -41,9 +50,10 @@ export class SpacesSdk extends SdkBase {
    * @param space The workspace definition.
    * @returns The key of the creates space.
    */
-  async create(space: IWorkspace | Workspace): Promise<string> {
+  async create(space: IWorkspace | Workspace, opts: ISpaceCreateOptions = {}): Promise<string> {
     const { token } = this.sdk;
-    const url = this.sdk.getUrl(RouteBuilder.spaces());
+    const path = opts.parent ? RouteBuilder.space(opts.parent) : RouteBuilder.spaces();
+    const url = this.sdk.getUrl(path);
     const body = JSON.stringify(space);
     const result = await this.sdk.http.post(url.toString(), { token, body });
     this.inspectCommonStatusCodes(result.status);
@@ -187,4 +197,13 @@ export class SpacesSdk extends SdkBase {
     }
     return data;
   }
+
+  /**
+   * Creates a WS client that listens to the spaces events.
+   */
+  async observeSpaces(): Promise<WebSocketNode | WebSocket> {
+    const { token } = this.sdk;
+    const url = this.sdk.getUrl(RouteBuilder.spaces());
+    return this.sdk.ws.createAndConnect(url.toString(), token);
+  }
 }

package/src/runtime/store/StoreSdkNode.ts

@@ -4,6 +4,9 @@ import { Sdk } from './Sdk.js';
 import { Http } from './Http.js';
 import { WsClient } from './WsClient.js';
 
+export { IStoreTokenInfo, IStoreResponse, IStoreRequestOptions } from './SdkBase.js';
+export { ISpaceCreateOptions } from './SpacesSdk.js';
+
 /**
  * NodeJS API for API Client's net-store module.
  */

package/src/runtime/store/StoreSdkWeb.ts

@@ -4,6 +4,9 @@ import { Sdk } from './Sdk.js';
 import { Http } from './Http.js';
 import { WsClient } from './WsClient.js';
 
+export { IStoreTokenInfo, IStoreResponse, IStoreRequestOptions } from './SdkBase.js';
+export { ISpaceCreateOptions } from './SpacesSdk.js';
+
 /**
  * NodeJS API for API Client's net-store module.
  */

package/build/src/models/HttpProjectListItem.d.ts

@@ -1,23 +0,0 @@
-export declare const Kind = "Core#HttpProjectListItem";
-/**
- * The HTTP Project definition to be used in lists.
- */
-export interface IHttpProjectListItem {
-    /**
-     * The data store key of the project.
-     */
-    key: string;
-    /**
-     * Project's name
-     */
-    name: string;
-    /**
-     * Whether the project is one of the favourites.
-     * May be used by an UI to add projects to favourites.
-     */
-    favourite?: boolean;
-    /**
-     * The timestamp when the project was last updated.
-     */
-    updated: number;
-}

package/build/src/models/HttpProjectListItem.js

@@ -1,2 +0,0 @@
-export const Kind = 'Core#HttpProjectListItem';
-//# sourceMappingURL=HttpProjectListItem.js.map

package/build/src/models/HttpProjectListItem.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"HttpProjectListItem.js","sourceRoot":"","sources":["../../../src/models/HttpProjectListItem.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,0BAA0B,CAAC"}

package/src/models/HttpProjectListItem.ts

@@ -1,23 +0,0 @@
-export const Kind = 'Core#HttpProjectListItem';
-/**
- * The HTTP Project definition to be used in lists.
- */
-export interface IHttpProjectListItem {
-  /**
-   * The data store key of the project.
-   */
-  key: string;
-  /**
-   * Project's name
-   */
-  name: string;
-  /**
-   * Whether the project is one of the favourites.
-   * May be used by an UI to add projects to favourites.
-   */
-  favourite?: boolean;
-  /**
-   * The timestamp when the project was last updated.
-   */
-  updated: number;
-}