@api-client/core 0.4.2 → 0.5.0

package/src/mocking/ProjectMock.ts

@@ -6,7 +6,7 @@ import { History } from './lib/History.js';
 
 export { IRequestLogInit } from './lib/Request.js';
 export { IResponseInit } from './lib/Response.js';
-export { ISpaceUserInit, IUserInit } from './lib/User.js';
+export { IUserInit } from './lib/User.js';
 export { IHttpHistoryInit, IHttpHistoryListInit } from './lib/History.js';
 
 export class ProjectMock extends DataMock {

package/src/mocking/legacy/Http.ts

@@ -1,5 +1,5 @@
 import { Http as Base, Types, Lorem, Time, HttpRequestInit } from '@pawel-up/data-mock';
-import { randomValue } from '@pawel-up/data-mock/src/lib/Http.js';
+import { randomValue } from '@pawel-up/data-mock/build/src/lib/Http.js';
 import { ArcDataMockInit } from '../LegacyInterfaces.js';
 import { HttpResponse } from './HttpResponse.js';
 import { ARCHistoryRequest, ARCSavedRequest, TransportRequest } from '../../models/legacy/request/ArcRequest.js';

package/src/mocking/legacy/HttpResponse.ts

@@ -1,4 +1,4 @@
-import { HttpResponse as Base, headersValue, payloadValue, typesValue, loremValue } from '@pawel-up/data-mock/src/lib/http/HttpResponse.js';
+import { HttpResponse as Base, headersValue, payloadValue, typesValue, loremValue } from '@pawel-up/data-mock/build/src/lib/http/HttpResponse.js';
 import { Har, DataMockLocale } from '@pawel-up/data-mock';
 import { ArcDataMockInit, HttpResponseArcInit, HttpResponseRedirectInit } from '../LegacyInterfaces.js';
 import { ResponseRedirect, Response, ErrorResponse } from '../../models/legacy/request/ArcResponse.js';

package/src/mocking/lib/User.ts

@@ -1,7 +1,6 @@
 import { Internet, Types, DataMockInit, Person, Random } from '@pawel-up/data-mock';
 // import { randomValue } from '@pawel-up/data-mock/src/lib/Http.js';
-import { IUser, ISpaceUser, AccessControlLevel, Kind as UserKind } from '../../models/User.js';
-
+import { IUser, Kind as UserKind } from '../../models/store/User.js';
 
 export interface IUserInit {
   noEmail?: boolean;
@@ -9,13 +8,6 @@ export interface IUserInit {
   noProvider?: boolean;
 }
 
-export interface ISpaceUserInit extends IUserInit {
-  level?: AccessControlLevel;
-  levelPool?: AccessControlLevel[];
-}
-
-const accessPool: AccessControlLevel[] = ['read', 'comment', 'write', 'admin', 'owner'];
-
 export class User {
   person: Person;
   types: Types;
@@ -53,16 +45,4 @@ export class User {
     }
     return result;
   }
-
-  spaceUser(init: ISpaceUserInit = {}): ISpaceUser {
-    const user = this.user(init) as ISpaceUser;
-    if (init.level) {
-      user.level = init.level;
-    } else if (Array.isArray(init.levelPool)) {
-      user.level = this.random.pickOne(init.levelPool);
-    } else {
-      user.level = this.random.pickOne(accessPool);
-    }
-    return user;
-  }
 }

package/src/models/Backend.ts

@@ -72,7 +72,7 @@ export interface IBackendEvent extends IBackendMessage {
   id?: string;
 }
 
-export interface IListResponse {
+export interface IListResponse<T = unknown> {
   /**
    * The cursor to use with the next query.
    * Not set when no more results.
@@ -81,7 +81,7 @@ export interface IListResponse {
   /**
    * The list of objects returned from the store.
    */
-  data: unknown[];
+  data: T[];
 }
 
 export interface IListOptions {
@@ -105,7 +105,15 @@ export interface IListOptions {
    * Only with the `query` property. Tells the system in which fields to search for the query term.
    */
   queryField?: string[];
+  /**
+   * @deprecated Not sure what this is.
+   */
   type?: string;
+  /**
+   * Whether the list should contain children of a parent.
+   * This is a key of the parent.
+   */
+  parent?: string;
 }
 
 export interface ICursorOptions {

package/src/models/HttpProject.ts

@@ -1358,7 +1358,7 @@ export class HttpProject extends ProjectParent {
           parent: folder.key,
           recursive,
           ignore,
-        }, indent += 1);
+        }, indent + 1);
         for (const f of it) {
           yield f;
         }

package/src/models/Workspace.ts

@@ -1,4 +1,4 @@
-import { AccessControlLevel } from "./User.js";
+import { IFile, File } from "./store/File.js";
 import { IThing, Thing, Kind as ThingKind } from './Thing.js';
 import v4 from '../lib/uuid.js';
 
@@ -9,7 +9,7 @@ export const Kind = 'Core#Space';
  * A working space is a logical container in the data store
  * created by the system users, where they can store their projects and other data.
  */
-export interface IWorkspace {
+export interface IWorkspace extends IFile {
   kind: typeof Kind;
   /**
    * The space identifier.
@@ -19,27 +19,11 @@ export interface IWorkspace {
    * The environment's meta info.
    */
   info: IThing;
-  /**
-   * The list of users added to this space. May not be set when owner did not add anyone to the space.
-   */
-  users?: string[];
   /**
    * The owner of this space. The id of the User object.
    * Set to `default` when there are no users in the system (no authentication).
    */
   owner: string;
-  /**
-   * The list of project keys added to the workspace.
-   * @deprecated This is not actually used.
-   */
-  projects: string[];
-}
-
-/**
- * The workspace information set to a specific client what contains user specific data.
- */
-export interface IUserWorkspace extends IWorkspace {
-  access: AccessControlLevel;
 }
 
 export const DefaultOwner = 'default';
@@ -50,7 +34,7 @@ export const DefaultOwner = 'default';
  * A working space is a logical container in the data store
  * created by the system users, where they can store their projects and other data.
  */
-export class Workspace {
+export class Workspace extends File {
   kind = Kind;
   /**
    * The space identifier.
@@ -60,26 +44,11 @@ export class Workspace {
    * The name of the environment.
    */
   info: Thing = new Thing({ kind: ThingKind });
-  /**
-   * The list of users added to this space. May not be set when owner did not add anyone to the space.
-   */
-  users?: string[];
   /**
    * The owner of this space. The id of the User object.
    * Set to `default` when there are no users in the system (no authentication).
    */
   owner = '';
-  /**
-   * The list of keys of projects added to the workspace.
-   * @deprecated This is not actually used.
-   */
-  projects: string[] = [];
-  /**
-   * Only set when the object was created from the data received by the API Client backend.
-   * Level access of the current user to the space.
-   * Note, this information is never serialized with the object.
-   */
-  access?: AccessControlLevel;
 
   /**
    * Creates a new Space object from a name.
@@ -95,7 +64,9 @@ export class Workspace {
       kind: Kind,
       info: info.toJSON(),
       owner,
-      projects: [],
+      parents: [],
+      permissionIds: [],
+      permissions: [],
     });
     return definition;
   }
@@ -103,7 +74,8 @@ export class Workspace {
   /**
    * @param input The environment definition used to restore the state.
    */
-  constructor(input?: string | IWorkspace | IUserWorkspace) {
+  constructor(input?: string | IWorkspace) {
+    super();
     let init: IWorkspace;
     if (typeof input === 'string') {
       init = JSON.parse(input);
@@ -118,7 +90,9 @@ export class Workspace {
           name: '',
         },
         owner: DefaultOwner,
-        projects: [],
+        parents: [],
+        permissionIds: [],
+        permissions: [],
       };
     }
     this.new(init);
@@ -129,29 +103,20 @@ export class Workspace {
    * 
    * Note, this throws an error when the environment is not a space. 
    */
-  new(init: IWorkspace | IUserWorkspace): void {
+  new(init: IWorkspace): void {
     if (!Workspace.isWorkspace(init)) {
       throw new Error(`Not a space.`);
     }
-    const { key = v4(), projects = [], info, owner = DefaultOwner, users } = init;
+    super.new(init);
+    const { key = v4(), info, owner = DefaultOwner } = init;
     this.kind = Kind;
     this.key = key;
-    this.projects = projects;
     this.owner = owner;
     if (info) {
       this.info = new Thing(info);
     } else {
       this.info = new Thing({ kind: ThingKind, name: '' });
     }
-    if (Array.isArray(users)) {
-      this.users = [...users];
-    } else {
-      this.users = [];
-    }
-    const typed = init as IUserWorkspace;
-    if (typed.access) {
-      this.access = typed.access;
-    }
   }
 
   /**
@@ -166,17 +131,14 @@ export class Workspace {
   }
 
   toJSON(): IWorkspace {
-    const { projects = [], owner = DefaultOwner, users } = this;
+    const { owner = DefaultOwner } = this;
     const result: IWorkspace = {
       kind: Kind,
       key: this.key,
       info: this.info.toJSON(),
-      projects,
       owner,
+      ...super.toJSON(),
     };
-    if (Array.isArray(users) && users.length) {
-      result.users = [...users];
-    }
     return result;
   }
 }

package/src/models/store/File.ts

@@ -0,0 +1,135 @@
+import { IPermission } from './Permission.js';
+
+export interface IStoredFile {
+  /**
+   * The list of parents of the object. It is an ordered list of parents
+   * from the top (first element) to the lowest parent in the tree (last element).
+   * 
+   * After creating the object, this property cannot be manipulated directly by the client. 
+   * Should be treated as opaque value.
+   */
+  parents: string[];
+  /**
+   * The list of permissions to this file object.
+   * 
+   * This property cannot be manipulated directly by the client. Should be treated as 
+   * opaque value.
+   */
+  permissionIds: string[];
+  /**
+   * Whether the file object is deleted.
+   */
+  deleted?: boolean;
+  /**
+   * The timestamp of when the file was deleted.
+   */
+  deletedTime?: number;
+  /**
+   * The id of the user that has deleted the file.
+   */
+  deletingUser?: string;
+}
+
+/**
+ * An interface describing an object in the data store that
+ * describes a file or an object that can be treated as a file or a folder.
+ */
+export interface IFile extends IStoredFile {
+  /**
+   * Populated by the server when reading the file. The list of permissions to the object.
+   * 
+   * This property cannot be manipulated directly by the client. Should be treated as 
+   * opaque value.
+   * 
+   * Data store implementation note, this is not stored in the store but it is populated
+   * when reading the object.
+   */
+  permissions: IPermission[];
+}
+
+export class StoredFile {
+  /**
+   * The list of parents of the object. It is an ordered list of parents
+   * from the top (first element) to the lowest parent in the tree (last element).
+   * 
+   * This property cannot be manipulated directly by the client. Should be treated as 
+   * opaque value.
+   */
+  parents: string[] = [];
+  /**
+   * The list of permissions to this file object.
+   * 
+   * This property cannot be manipulated directly by the client. Should be treated as 
+   * opaque value.
+   */
+  permissionIds: string[] = [];
+  /**
+   * Whether the file object is deleted.
+   */
+  deleted?: boolean;
+  /**
+   * The timestamp of when the file was deleted.
+   */
+  deletedTime?: number;
+  /**
+   * The id of the user that has deleted the file.
+   */
+  deletingUser?: string;
+
+  new(init: IStoredFile): void {
+    const { parents=[], permissionIds=[], deleted, deletedTime, deletingUser } = init;
+    this.parents = parents;
+    this.permissionIds = permissionIds;
+    if (typeof deleted === 'boolean') {
+      this.deleted = deleted;
+      this.deletedTime = deletedTime;
+      this.deletingUser = deletingUser;
+    } else {
+      this.deleted = undefined;
+      this.deletedTime = undefined;
+      this.deletingUser = undefined;
+    }
+  }
+
+  toJSON(): IStoredFile {
+    const result: IStoredFile = {
+      parents: this.parents,
+      permissionIds: this.permissionIds,
+    };
+    if (typeof this.deleted === 'boolean') {
+      result.deleted = this.deleted;
+
+      if (this.deletedTime) {
+        result.deletedTime = this.deletedTime;
+      }
+      if (this.deletingUser) {
+        result.deletingUser = this.deletingUser;
+      }
+    }
+    return result;
+  }
+}
+
+export class File extends StoredFile {
+  /**
+   * Populated by the server when reading the file. The list of permissions to the object.
+   * 
+   * This property cannot be manipulated directly by the client. Should be treated as 
+   * opaque value.
+   */
+  permissions: IPermission[] = [];
+  
+  new(init: IFile): void {
+    super.new(init);
+    const { permissions=[] } = init;
+    this.permissions = permissions;
+  }
+
+  toJSON(): IFile {
+    const result: IFile = {
+      ...super.toJSON(),
+      permissions: this.permissions,
+    };
+    return result;
+  }
+}

package/src/models/store/Group.ts

@@ -0,0 +1,21 @@
+/**
+ * An object representing a user group.
+ */
+export interface IGroup {
+  /**
+   * The key of the group.
+   */
+  key: string;
+  /**
+   * The name of the group
+   */
+  name: string;
+  /**
+   * The id of the user that created this group.
+   */
+  owner: string;
+  /**
+   * The list of users in this group.
+   */
+  users: string[];
+}