@api-client/core 0.5.2 → 0.5.3

package/src/models/store/File.ts

@@ -1,8 +1,25 @@
 import { IPermission } from './Permission.js';
+import { IModification } from './Modification.js';
+import { IDeletion } from './Deletion.js';
+import { IUser, Kind as UserKind } from './User.js';
+import { IThing, Thing } from '../Thing.js';
+import v4 from '../../lib/uuid.js';
 
 export const DefaultOwner = 'default';
 
 export interface IStoredFile {
+  /**
+   * The kind of the File
+   */
+  kind: string;
+  /**
+   * The identifier of the entity
+   */
+  key: string;
+  /**
+   * The projects's meta info.
+   */
+  info: IThing;
   /**
    * 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).
@@ -23,17 +40,22 @@ export interface IStoredFile {
    */
   deleted?: boolean;
   /**
-   * The timestamp of when the file was deleted.
-   */
-  deletedTime?: number;
-  /**
-   * The id of the user that has deleted the file.
+   * The information about the delete information.
+   * Always set when the `delete` is true.
    */
-  deletingUser?: string;
+  deletedInfo?: IDeletion;
   /**
    * The owner of this object. The id of the User object.
    */
   owner: string;
+  /**
+   * The last modification made to this file.
+   */
+  lastModified: IModification;
+  /**
+   * An arbitrary list of labels applied to the file.
+   */
+  labels?: string[];
 }
 
 /**
@@ -54,6 +76,18 @@ export interface IFile extends IStoredFile {
 }
 
 export class StoredFile {
+  /**
+   * The kind of the File
+   */
+  kind = '';
+  /**
+   * The identifier of the entity
+   */
+  key = '';
+  /**
+   * The name of the environment.
+   */
+  info: Thing = Thing.fromName('');
   /**
    * 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).
@@ -74,54 +108,140 @@ export class StoredFile {
    */
   deleted?: boolean;
   /**
-   * The timestamp of when the file was deleted.
+   * The information about the delete information.
+   * Always set when the `delete` is true.
    */
-  deletedTime?: number;
-  /**
-   * The id of the user that has deleted the file.
-   */
-  deletingUser?: string;
+  deletedInfo?: IDeletion;
   /**
    * 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 = '';
+  owner = DefaultOwner;
+  /**
+   * The last modification made to this file.
+   */
+  lastModified: IModification = { user: '', time: 0, byMe: false };
+  /**
+   * An arbitrary list of labels applied to the file.
+   */
+  labels?: string[];
 
   new(init: IStoredFile): void {
-    const { parents=[], permissionIds=[], deleted, deletedTime, deletingUser, owner = DefaultOwner } = init;
+    const { key = v4(), info, kind, parents=[], permissionIds=[], deleted, deletedInfo, owner = DefaultOwner, lastModified, labels } = init;
+    this.key = key;
+    this.kind = kind;
+    if (info) {
+      this.info = new Thing(info);
+    } else {
+      this.info = Thing.fromName('');
+    }
     this.parents = parents;
     this.permissionIds = permissionIds;
     this.owner = owner;
+    this.lastModified = lastModified || { user: '', time: 0, byMe: false };
     if (typeof deleted === 'boolean') {
       this.deleted = deleted;
-      this.deletedTime = deletedTime;
-      this.deletingUser = deletingUser;
+      this.deletedInfo = deletedInfo;
     } else {
       this.deleted = undefined;
-      this.deletedTime = undefined;
-      this.deletingUser = undefined;
+      this.deletedInfo = undefined;
+    }
+    if (Array.isArray(labels)) {
+      this.labels = labels;
+    } else {
+      this.labels = undefined; 
     }
   }
 
   toJSON(): IStoredFile {
     const { owner = DefaultOwner } = this;
     const result: IStoredFile = {
+      key: this.key,
+      kind: this.kind,
+      info: this.info.toJSON(),
       parents: this.parents,
       permissionIds: this.permissionIds,
+      lastModified: this.lastModified,
       owner,
     };
-    if (typeof this.deleted === 'boolean') {
+    if (this.deleted) {
       result.deleted = this.deleted;
-
-      if (this.deletedTime) {
-        result.deletedTime = this.deletedTime;
-      }
-      if (this.deletingUser) {
-        result.deletingUser = this.deletingUser;
-      }
+      result.deletedInfo = this.deletedInfo;
+    }
+    if (Array.isArray(this.labels)) {
+      result.labels = this.labels;
     }
     return result;
   }
+
+  /**
+   * Updates the "lastModified" value.
+   * A helper method for a common task.
+   * 
+   * @param user The user that modifies the entity.
+   */
+  setLastModified(user: IUser): void {
+    if (!user) {
+      throw new Error(`The user is required.`);
+    }
+    if (user.kind !== UserKind) {
+      throw new Error(`Invalid value for the user when setting "lastModified".`);
+    }
+    this.lastModified = {
+      byMe: false,
+      time: Date.now(),
+      user: user.key,
+      name: user.name,
+    };
+  }
+
+  /**
+   * Adds a label to the list of labels.
+   * 
+   * It makes sure the value is a valid, non-empty string and the `labels` array is set.
+   * 
+   * It does nothing when the label already exists.
+   * 
+   * @param label The label to set.
+   */
+  addLabel(label: string): void {
+    if (typeof label !== 'string') {
+      throw new Error(`The label must be a string.`);
+    }
+    if (!label.trim()) {
+      throw new Error(`The label is required.`);
+    }
+    if (!Array.isArray(this.labels)) {
+      this.labels = [];
+    }
+    if (this.labels.includes(label)) {
+      return;
+    }
+    this.labels.push(label);
+  }
+
+  /**
+   * Marks the entity as deleted.
+   * 
+   * A helper method for a common task.
+   * 
+   * @param user The user that deletes the entity.
+   */
+  setDeleted(user: IUser): void {
+    if (!user) {
+      throw new Error(`The user is required.`);
+    }
+    if (user.kind !== UserKind) {
+      throw new Error(`Invalid value for the user when setting "lastModified".`);
+    }
+    this.deleted = true;
+    this.deletedInfo = {
+      byMe: false,
+      time: Date.now(),
+      user: user.key,
+      name: user.name,
+    };
+  }
 }
 
 export class File extends StoredFile {

package/src/models/store/Modification.ts

@@ -0,0 +1,24 @@
+/**
+ * Information about a modification of a File.
+ */
+export interface IModification {
+  /**
+   * The key of the user modifying the record.
+   */
+  user: string;
+  /**
+   * User name modifying the record. May not be set when there's no actual user.
+   */
+  name?: string;
+  /**
+   * Whether the modification was performed by the requesting the data user.
+   * 
+   * Note for store implementers, this field should not be stored and populated every time the 
+   * record is requested.
+   */
+  byMe: boolean;
+  /**
+   * A timestamp when the object was modified.
+   */
+  time: number;
+}

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;
-}