@api-client/core 0.5.12 → 0.5.16

package/src/models/ProjectParent.ts

@@ -3,8 +3,6 @@ import { ProjectFolder } from "./ProjectFolder.js";
 import { ProjectItem } from "./ProjectItem.js";
 import { Thing, Kind as ThingKind } from "./Thing.js";
 import { ProjectDefinitionProperty } from "./ProjectDefinitionProperty.js";
-import { Environment, IEnvironment } from "./Environment.js";
-import v4 from '../lib/uuid.js';
 
 /**
  * A class that contains a common properties and methods of an `HttpProject` and
@@ -14,12 +12,7 @@ export abstract class ProjectParent implements ProjectDefinitionProperty {
   kind: unknown;
   key: string = '';
   /**
-   * The environments defined for this project.
-   * If not set it is inherited from the parent.
-   */
-  environments: string[] = [];
-  /**
-   * The ordered list of HTTP requests / folders in the projects.
+   * The ordered list of HTTP requests, folders, or environments in the projects.
    * The UI uses this to manipulate the view without changing the definitions.
    */
   items: ProjectItem[] = [];
@@ -35,106 +28,4 @@ export abstract class ProjectParent implements ProjectDefinitionProperty {
   abstract getParent(): HttpProject | ProjectFolder | undefined;
 
   abstract getProject(): HttpProject;
-
-  /**
-   * Adds an environment to the project.
-   * 
-   * @param env The definition of the environment to use to create the environment
-   * @returns The same or created environment.
-   */
-  addEnvironment(env: IEnvironment): Environment;
-
-  /**
-   * Adds an environment to the project.
-   * 
-   * @param env The instance of the environment to add
-   * @returns The same or created environment.
-   */
-  addEnvironment(env: Environment): Environment;
-
-  /**
-   * Adds an environment to the project.
-   * 
-   * @param env The name of the environment to create
-   * @returns The same or created environment.
-   */
-  addEnvironment(env: string): Environment;
-
-  /**
-   * Adds an environment to the project.
-   * @returns The same or created environment.
-   */
-  addEnvironment(env: IEnvironment | Environment | string): Environment {
-    if (!Array.isArray(this.environments)) {
-      this.environments = [];
-    }
-    let finalEnv;
-    if (env instanceof Environment) {
-      finalEnv = env;
-    } else if (typeof env === 'string') {
-      finalEnv = Environment.fromName(env);
-    } else {
-      finalEnv = new Environment(env);
-    }
-    if (!finalEnv.key) {
-      finalEnv.key = v4();
-    }
-    const project = this.getProject();
-    if (!project.definitions.environments) {
-      project.definitions.environments = [];
-    }
-    project.definitions.environments.push(finalEnv);
-    this.environments.push(finalEnv.key);
-    return finalEnv;
-  }
-
-  /**
-   * 
-   * @returns The list of environments defined in this folder.
-   */
-  getEnvironments(): Environment[] {
-    const { environments } = this;
-    if (!environments.length) {
-      return [];
-    }
-    const project = this.getProject();
-    if (!project.definitions.environments) {
-      return [];
-    }
-    const result: Environment[] = [];
-    environments.forEach((key) => {
-      const env = project.definitions.environments.find(i => i.key === key);
-      if (env) {
-        result.push(env);
-      }
-    });
-    return result;
-  }
-
-  /**
-   * @param key The environment key to read.
-   */
-  getEnvironment(key: string): Environment | undefined {
-    const { environments } = this;
-    if (!environments.length) {
-      return undefined;
-    }
-    const has = environments.includes(key);
-    if (!has) {
-      return undefined;
-    }
-    const project = this.getProject();
-    if (!project.definitions.environments) {
-      return undefined;
-    }
-    return project.definitions.environments.find(i => i.key === key);
-  }
-
-  /**
-   * This is a link to the `getEnvironments()`. The difference is that on the 
-   * project level it won't return environments defined with the class initialization.
-   */
-  listEnvironments(): Environment[] {
-    return this.getEnvironments();
-  }
 }

package/src/models/{Backend.ts → store/Backend.ts}

@@ -1,4 +1,8 @@
 /* eslint-disable import/export */
+
+import { JsonPatch } from '@api-client/json'
+import { AccessOperation } from './Permission.js';
+
 export type BackendMode = 'single-user' | 'multi-user';
 
 export interface IBackendInfo {
@@ -16,14 +20,49 @@ export interface IBackendInfo {
    * @default single-user
    */
   mode: BackendMode;
+  
   /**
-   * Optional, the store base path when set on the configuration.
+   * Client authentication configuration
    */
-  prefix?: string;
+  auth: {
+    /**
+     * The path to the authentication endpoint.
+     * This is always populated whether the store is in the single- or multi-user mode.
+     */
+    path: string;
+    /**
+     * When configured, the OAuth2 redirect URI.
+     */
+    redirect?: string;
+    /**
+     * When configured the type of the authentication protocol.
+     */
+    type?: string;
+  }
+
   /**
-   * The path to the authentication endpoint.
+   * The information about hosting.
    */
-  authPath: string;
+  hosting: {
+    /**
+     * Optional, the store base path when set on the configuration.
+     */
+    prefix?: string;
+    /**
+     * When configured with the host information, this is the public host name of the store.
+     * When using udp to discover the store in the local network, this is the ip address of the machine the store
+     * is running on.
+     */
+    host?: string;
+    /**
+     * The port number the store operates on, if the store was initialized on a port.
+     */
+    port?: number;
+    /**
+     * The socket path, if the server was initialized on a socket.
+     */
+    socket?: string;
+  }
 }
 
 export interface IBackendCommand {
@@ -205,3 +244,59 @@ export interface IHistoryAppListOptions extends IListOptions {
    */
   id: string;
 }
+
+export interface IPatchBase {
+  /**
+   * Auto generated by the client sending the PATCH.
+   */
+  id: string;
+  /**
+   * The application id that generated the patch.
+   * This is a string that is assigned to each application in the suite.
+   * External applications need to use a constant string for their apps.
+   */
+  app: string;
+  /**
+   * The version of the application that generated the patch.
+   * This can and will be used to handle potential differences between suite applications.
+   */
+  appVersion: string;
+  /**
+   * The patch generated by the client.
+   */
+  patch: unknown;
+}
+
+/**
+ * An interface describing a schema to be sent to the server
+ * when making a patch of a file.
+ */
+export interface IPatchInfo extends IPatchBase {
+  /**
+   * The patch generated by the client.
+   */
+  patch: JsonPatch;
+}
+
+/**
+ * An interface describing a schema to be sent to the server
+ * when making a patch with user access to a file.
+ */
+export interface IAccessPatchInfo extends IPatchBase {
+  /**
+   * The patch generated by the client.
+   */
+  patch: AccessOperation[];
+}
+
+/**
+ * A schema sent by the store server in a response to the patch request.
+ * It contains an information about the applied patch, the reverse operation associated with it,
+ * application information, and the generated by the client patch id.
+ */
+export interface IPatchRevision extends IPatchInfo {
+  /**
+   * The patch to apply to the object to revert the changes.
+   */
+  revert: JsonPatch;
+}

package/src/models/transformers/PostmanBackupTransformer.ts

@@ -146,7 +146,6 @@ export class PostmanBackupTransformer extends PostmanTransformer {
     const init: IHttpProject = {
       kind: ProjectKind,
       definitions: {},
-      environments: [],
       info: {
         kind: ThingKind,
         name,

package/src/models/transformers/PostmanV21Transformer.ts

@@ -133,7 +133,6 @@ export class PostmanV21Transformer extends PostmanTransformer {
     const init: IHttpProject = {
       kind: ProjectKind,
       definitions: {},
-      environments: [],
       info: {
         kind: ThingKind,
         name: info.name || 'Unnamed Postman project',

package/src/models/transformers/PostmanV2Transformer.ts

@@ -130,7 +130,6 @@ export class PostmanV2Transformer extends PostmanTransformer {
     const init: IHttpProject = {
       kind: ProjectKind,
       definitions: {},
-      environments: [],
       info: {
         kind: ThingKind,
         name: info.name || 'Unnamed Postman project',

package/src/runtime/node/ProjectRequestRunner.ts

@@ -205,7 +205,7 @@ export class ProjectRequestRunner extends EventEmitter {
    */
   protected async readEnvironments(parent: HttpProject | ProjectFolder): Promise<Environment[]> {
     const folderKey = parent.kind === ProjectFolderKind ? (parent as ProjectFolder).key : undefined;
-    return this.project.readEnvironments({ folderKey });
+    return this.project.readEnvironments({ parent: folderKey });
   }
 
   /**

package/src/runtime/store/BackendSdk.ts

@@ -1,6 +1,6 @@
 import { SdkBase } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
-import { IBackendInfo } from '../../models/Backend.js';
+import { IBackendInfo } from '../../models/store/Backend.js';
 
 export class BackendSdk extends SdkBase {
   /**

package/src/runtime/store/FilesSdk.ts

@@ -1,9 +1,7 @@
 import WebSocketNode from 'ws';
-import { Patch } from '@api-client/json';
 import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, E_RESPONSE_LOCATION, ISdkRequestOptions } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
-import { IListOptions, IListResponse } from '../../models/Backend.js';
-import { AccessOperation } from '../../models/store/Permission.js';
+import { IListOptions, IListResponse, IPatchInfo, IPatchRevision, IAccessPatchInfo } from '../../models/store/Backend.js';
 import { IUser } from '../../models/store/User.js';
 import { IFile } from '../../models/store/File.js';
 import { Kind as ProjectKind } from '../../models/Project.js';
@@ -193,7 +191,7 @@ export class FilesSdk extends SdkBase {
    * @param value The patch to apply.
    * @param request Optional request options.
    */
-  patch(key: string, value: Patch.JsonPatch, media: false, request?: ISdkRequestOptions): Promise<Patch.JsonPatch>;
+  patch(key: string, value: IPatchInfo, media: false, request?: ISdkRequestOptions): Promise<IPatchRevision>;
 
   /**
    * Patches file's content in the store.
@@ -202,7 +200,7 @@ export class FilesSdk extends SdkBase {
    * @param value The patch to apply.
    * @param request Optional request options.
    */
-  patch(key: string, value: Patch.JsonPatch, media: true, request?: ISdkRequestOptions): Promise<Patch.JsonPatch>;
+  patch(key: string, value: IPatchInfo, media: true, request?: ISdkRequestOptions): Promise<IPatchRevision>;
 
   /**
    * Patches a file in the store.
@@ -211,7 +209,7 @@ 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: Patch.JsonPatch, media?: boolean, request: ISdkRequestOptions = {}): Promise<Patch.JsonPatch> {
+  async patch(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));
     if (media) {
@@ -233,16 +231,17 @@ export class FilesSdk extends SdkBase {
     if (!result.body) {
       throw new Error(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`);
     }
-    let data: any;
+    let data: IPatchRevision;
     try {
       data = JSON.parse(result.body);
     } catch (e) {
       throw new Error(`${E_PREFIX}${E_INVALID_JSON}.`);
     }
+    // revert is added to the response
     if (!data.revert) {
       throw new Error(`${E_PREFIX}${E_RESPONSE_UNKNOWN}.`);
     }
-    return data.revert as Patch.JsonPatch;
+    return data;
   }
 
   /**
@@ -275,7 +274,7 @@ 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: AccessOperation[], request: ISdkRequestOptions = {}): Promise<void> {
+  async patchUsers(key: string, value: IAccessPatchInfo, request: ISdkRequestOptions = {}): Promise<void> {
     const token = request.token || this.sdk.token;
     const url = this.sdk.getUrl(RouteBuilder.fileUsers(key));
     const body = JSON.stringify(value);

package/src/runtime/store/HistorySdk.ts

@@ -1,6 +1,6 @@
 import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, E_RESPONSE_LOCATION, ISdkRequestOptions } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
-import { IListResponse, HistoryListOptions, IHistoryRequestListOptions } from '../../models/Backend.js';
+import { IListResponse, HistoryListOptions, IHistoryRequestListOptions } from '../../models/store/Backend.js';
 import { IHttpHistory, IHttpHistoryBulkAdd, Kind as HttpHistoryKind } from '../../models/HttpHistory.js';
 
 export class HistorySdk extends SdkBase {

package/src/runtime/store/Sdk.ts

@@ -1,4 +1,4 @@
-import { IListOptions } from '../../models/Backend.js';
+import { IListOptions } from '../../models/store/Backend.js';
 import { Http } from './Http.js';
 import { WsClient } from './WsClient.js';
 import { AuthSdk } from './AuthSdk.js';

package/src/runtime/store/SharedSdk.ts

@@ -1,6 +1,6 @@
 import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, ISdkRequestOptions } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
-import { IListOptions, IListResponse } from '../../models/Backend.js';
+import { IListOptions, IListResponse } from '../../models/store/Backend.js';
 import { Kind as ProjectKind } from '../../models/Project.js';
 import { Kind as WorkspaceKind } from '../../models/Workspace.js';
 import { IFile } from '../../models/store/File.js';

package/src/runtime/store/UsersSdk.ts

@@ -1,6 +1,6 @@
 import { SdkBase, E_RESPONSE_STATUS, E_RESPONSE_NO_VALUE, E_INVALID_JSON, E_RESPONSE_UNKNOWN, ISdkRequestOptions } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
-import { IListOptions, IListResponse } from '../../models/Backend.js';
+import { IListOptions, IListResponse } from '../../models/store/Backend.js';
 import { IUser } from '../../models/store/User.js';
 
 export class UsersSdk extends SdkBase {

package/build/src/models/Backend.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=Backend.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Backend.js","sourceRoot":"","sources":["../../../src/models/Backend.ts"],"names":[],"mappings":""}