@api-client/core 0.8.22 → 0.9.1

package/src/events/BaseEvents.ts

@@ -1,5 +1,6 @@
+import { JsonPatch } from '@api-client/json'
 import CustomEvent from './CustomEvent.js';
-import { IQueryResponse } from '../models/store/Backend.js';
+import { AccessOperation } from '../models/store/Permission.js';
 
 /**
  * Base event detail definition for the events that returns a `result`
@@ -48,7 +49,7 @@ export interface ContextReadEventDetail {
 /**
  * An event to be used to read a state from a context provider.
  */
-export class ContextReadEvent<T> extends ContextEvent<ContextReadEventDetail, T> {
+export class ContextReadEvent<T> extends ContextEvent<ContextReadEventDetail, T | null | undefined> {
   /**
    * @param type The type of the event
    * @param key The domain key of the object to read
@@ -73,7 +74,7 @@ export interface ContextReadBulkEventDetail {
 /**
  * An event to be used to read a list of object from the API store.
  */
-export class ContextReadBulkEvent<T> extends ContextEvent<ContextReadBulkEventDetail, T[]> {
+export class ContextReadBulkEvent<T> extends ContextEvent<ContextReadBulkEventDetail, IBulkOperationResult<(T | null | undefined)>> {
   /**
    * @param type The type of the event
    * @param keys The list of domain keys to read. These must be of the same domain type.
@@ -105,6 +106,10 @@ export interface ContextChangeRecord<T> {
    * Optionally, when relevant, the key of the parent of the changed object.
    */
   parent?: string;
+  /**
+   * The parent space.
+   */
+  space?: string;
 }
 
 export interface ContextDeleteEventDetail {
@@ -116,6 +121,10 @@ export interface ContextDeleteEventDetail {
    * The key of the parent object, if applicable.
    */
   parent?: string;
+  /**
+   * The parent space.
+   */
+  space?: string;
 }
 
 export interface ContextDeleteBulkEventDetail {
@@ -127,6 +136,10 @@ export interface ContextDeleteBulkEventDetail {
    * The key of the parent object, if applicable.
    */
   parent?: string;
+  /**
+   * The parent space.
+   */
+  space?: string;
 }
 
 /**
@@ -144,10 +157,23 @@ export class ContextDeleteEvent extends ContextEvent<ContextDeleteEventDetail, C
   }
 }
 
+/**
+ * Describes a result of the batch delete operation.
+ */
+export interface IBulkOperationResult<T> {
+  /**
+   * The ordered list of delete result for each item.
+   * 
+   * The batch operation does not return specific errors. Use the direct delete operation
+   * for the detailed error.
+   */
+  items: (T | undefined | null)[];
+}
+
 /**
  * An event to be used to delete a number of entities in the context provider.
  */
-export class ContextDeleteBulkEvent extends ContextEvent<ContextDeleteBulkEventDetail, ContextDeleteRecord[]> {
+export class ContextDeleteBulkEvent extends ContextEvent<ContextDeleteBulkEventDetail, IBulkOperationResult<ContextDeleteRecord>> {
   /**
    * An event to be used to delete a number of entities in the context provider.
    * @param type The type of the event to dispatch.
@@ -178,7 +204,7 @@ export interface ContextDeleteRecord {
 /**
  * An event dispatched to the context store to restore previously deleted items.
  */
-export class ContextRestoreEvent<T> extends ContextEvent<{ records: ContextDeleteRecord[] }, (ContextChangeRecord<T> | undefined)[]> {
+export class ContextRestoreEvent<T> extends ContextEvent<{ records: ContextDeleteRecord[] }, IBulkOperationResult<ContextChangeRecord<T>>> {
   /**
    * An event dispatched to the context store to restore previously deleted items.
    * 
@@ -242,7 +268,7 @@ export interface ContextUpdateEventDetail<T> {
   parent?: string;
 }
 
-export interface ContextUpdateBulkEventDetail<T> {
+export interface ContextUpdateBulkEventDetail<T = unknown> {
   /**
    * The list of context store objects to be updated by the context provider.
    */
@@ -282,7 +308,7 @@ export class ContextUpdateEvent<T extends object, U = T> extends ContextEvent<Co
  * @template T The object that is being updated.
  * @template U The object that is returned by the context store after updating. By default it is the `T`.
  */
-export class ContextUpdateBulkEvent<T extends object, U = T> extends ContextEvent<ContextUpdateBulkEventDetail<T>, ContextChangeRecord<U>[]> {
+export class ContextUpdateBulkEvent<T extends object, U = T> extends ContextEvent<ContextUpdateBulkEventDetail<T>, IBulkOperationResult<ContextChangeRecord<U>>> {
   /**
    * An event that is dispatched to update the entire object in the store.
    * This is equivalent to PUT operation in REST HTTP.
@@ -299,12 +325,6 @@ export class ContextUpdateBulkEvent<T extends object, U = T> extends ContextEven
  * Data store query result object.
  */
 export interface ContextListResult<T> {
-  /**
-   * Next page token to be used with pagination.
-   * It is not set when the query has not returned any results.
-   * @deprecated Use `cursor` instead.
-   */
-  nextPageToken?: string;
   /**
    * The cursor to use with the next query. It has the list state encoded in it.
    */
@@ -324,11 +344,6 @@ export interface ContextListOptions {
    * The number of results per the page.
    */
   limit?: number;
-  /**
-   * A string that should be used with the pagination.
-   * @deprecated Use `cursor` instead.
-   */
-  nextPageToken?: string;
   /**
    * Page cursor to use with the query. This is returned by the 
    */
@@ -349,6 +364,10 @@ export interface ContextListOptions {
    * Whether to use the `descending` order.
    */
   descending?: boolean;
+  /**
+   * The name of the field to order then results.
+   */
+  orderField?: string;
   /**
    * General purpose type property to filer the results.
    * This is used, for example, by the history store to list history for a specific type of requests,
@@ -362,6 +381,13 @@ export interface ContextListOptions {
   since?: number;
 }
 
+export interface ContextSpaceListOptions extends ContextListOptions {
+  /**
+   * The identifier of the parent space (or organization).
+   */
+  space: string;
+}
+
 export class ContextListEvent<T> extends ContextEvent<ContextListOptions, ContextListResult<T>> {
   /**
    * @param type The type of the event
@@ -397,6 +423,24 @@ export interface IQueryDetail {
   detailed?: boolean;
 }
 
+export interface IQueryResponse<T = unknown> {
+  /**
+   * An ordered list of results.
+   */
+  items: IQueryResult<T>[];
+}
+
+export interface IQueryResult<T = unknown> {
+  /**
+   * The document.
+   */
+  doc: T;
+  /**
+   * The list of indexes where this document was found.
+   */
+  index: string[];
+}
+
 /**
  * An event dispatched to the context store to perform a query operation.
  * If the context store supports the query operation, it should use the definition of `IQueryDetail` to perform the query.
@@ -421,3 +465,89 @@ export class ContextQueryEvent<T = unknown> extends ContextEvent<IQueryDetail, I
     super(type, opts);
   }
 }
+
+/**
+ * Query options to list history for a request in a project.
+ * The user has to have access to the parent user space to read / create / delete the history.
+ */
+export interface IHistoryRequestListOptions extends ContextListOptions {
+  type: 'request';
+  /**
+   * The key of the parent space.
+   */
+  space: string;
+  /**
+   * The id of the project that contains the request.
+   */
+  project: string;
+  /**
+   * The id of the request.
+   */
+  id: string;
+  /**
+   * Whether to limit the list of results to the history that belongs to the current user.
+   */
+  user?: boolean;
+}
+
+/**
+ * Listing options for the HTTP history.
+ */
+export type HistoryListOptions = IHistoryRequestListOptions;
+
+
+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/events/EventTypes.ts

@@ -1,4 +1,3 @@
-import { ModelEventTypes } from './models/ModelEventTypes.js';
 import { CookieEventTypes } from './cookies/CookieEventTypes.js';
 import { AuthorizationEventTypes } from './authorization/AuthorizationEventTypes.js';
 import { EncryptionEventTypes } from './encryption/EncryptionEventTypes.js';
@@ -14,7 +13,6 @@ export const EventTypes = Object.freeze({
   Authorization: AuthorizationEventTypes,
   Cookie: CookieEventTypes,
   Encryption: EncryptionEventTypes,
-  Model: ModelEventTypes,
   Process: ProcessEventTypes,
   Reporting: ReportingEventTypes,
   Telemetry: TelemetryEventTypes,

package/src/events/Events.ts

@@ -1,4 +1,3 @@
-import { ModelEvents } from './models/ModelEvents.js';
 import { CookieEvents } from './cookies/CookieEvents.js';
 import { AuthorizationEvents } from './authorization/AuthorizationEvents.js';
 import { EncryptionEvents } from './encryption/EncryptionEvents.js';
@@ -14,7 +13,6 @@ export const Events = Object.freeze({
   Authorization: AuthorizationEvents,
   Cookie: CookieEvents,
   Encryption: EncryptionEvents,
-  Model: ModelEvents,
   Process: ProcessEvents,
   Reporting: ReportingEvents, 
   Telemetry: TelemetryEvents,

package/src/events/transport/TransportEventTypes.ts

@@ -5,7 +5,6 @@ export const TransportEventTypes = Object.freeze({
   Core: Object.freeze({
     request: 'transportcorerequest',
     httpProject: 'transportcorehttpproject',
-    appProject: 'transportcoreappproject',
   }),
   
   /** 

package/src/events/transport/TransportEvents.ts

@@ -7,7 +7,6 @@ import { TransportEventTypes } from "./TransportEventTypes.js";
 import { IProjectExecutionLog } from "../../runtime/reporters/Reporter.js";
 import { IRequestProxyInit } from "../../proxy/RequestProxy.js";
 import { IHttpProjectProxyInit, IHttpProjectStoreProxyInit } from "../../proxy/HttpProjectProxy.js";
-import { IAppProjectProxyInit } from "../../proxy/AppProjectProxy.js";
 import { IProxyResult } from "../../proxy/Proxy.js";
 
 export interface IHttpRequestDetail {
@@ -45,18 +44,6 @@ export const TransportEvent = Object.freeze({
       target.dispatchEvent(e);
       return e.detail.result;
     },
-
-    /**
-     * For both the project or a folder (since it's all single configuration.)
-     * 
-     * @param target The events target
-     * @param init The project execution configuration
-     */
-    appProject: async (init: IAppProjectProxyInit, target: EventTarget = window): Promise<IProxyResult<IProjectExecutionLog> | undefined> => {
-      const e = new ContextEvent<IAppProjectProxyInit, IProxyResult<IProjectExecutionLog>>(TransportEventTypes.Core.appProject, init);
-      target.dispatchEvent(e);
-      return e.detail.result;
-    },
   }),
   /** 
    * Transport via the native platform's bindings.

package/src/mocking/ProjectMock.ts

@@ -6,13 +6,11 @@ import { History } from './lib/History.js';
 import { Url } from './lib/Url.js';
 import { Certificates } from './lib/Certificates.js';
 import { HostRules } from './lib/HostRules.js';
-import { App } from './lib/App.js';
 
 export { IRequestLogInit } from './lib/Request.js';
 export { IResponseInit } from './lib/Response.js';
 export { IUserInit } from './lib/User.js';
 export { IHttpHistoryInit, IHttpHistoryListInit } from './lib/History.js';
-export { IAppRequestInit } from './lib/App.js';
 
 export class ProjectMock extends DataMock {
   projectRequest: Request;
@@ -22,7 +20,6 @@ export class ProjectMock extends DataMock {
   url: Url;
   certificates: Certificates;
   hostRules: HostRules;
-  app: App;
   
   /**
    * @param init The library init options.
@@ -36,6 +33,5 @@ export class ProjectMock extends DataMock {
     this.url = new Url(init);
     this.certificates = new Certificates(init);
     this.hostRules = new HostRules(init);
-    this.app = new App(init);
   }
 }

package/src/mocking/lib/History.ts

@@ -85,6 +85,11 @@ export class History {
       created: date.getTime(),
       log: await this.request.log(init.log),
       user: '',
+      app: '',
+      key: '',
+      project: '',
+      request: '',
+      space: '',
     }
     date.setHours(0, 0, 0, 0);
     result.midnight = date.getTime();

package/src/models/{Workspace.ts → Folder.ts}

@@ -2,14 +2,14 @@ import { IFile, File, DefaultOwner } from "./store/File.js";
 import { Thing, Kind as ThingKind } from './Thing.js';
 import v4 from '../lib/uuid.js';
 
-export const Kind = 'Core#Space';
+export const Kind = 'Core#Folder';
 /**
  * A definition of the working space for users.
  * 
  * 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 extends IFile {
+export interface IFolder extends IFile {
   kind: typeof Kind;
 }
 
@@ -19,7 +19,7 @@ export interface IWorkspace extends IFile {
  * 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 extends File {
+export class Folder extends File {
   override kind = Kind;
   
   /**
@@ -28,10 +28,10 @@ export class Workspace extends File {
    * @param name The name to set.
    * @param owner The user id that is the owner of the space.
    */
-  static fromName(name: string, owner = DefaultOwner): Workspace {
+  static fromName(name: string, owner = DefaultOwner): Folder {
     const key = v4();
     const info = new Thing({ kind: ThingKind, name });
-    const definition = new Workspace({
+    const definition = new Folder({
       key,
       kind: Kind,
       info: info.toJSON(),
@@ -47,9 +47,9 @@ export class Workspace extends File {
   /**
    * @param input The environment definition used to restore the state.
    */
-  constructor(input?: string | IWorkspace) {
+  constructor(input?: string | IFolder) {
     super();
-    let init: IWorkspace;
+    let init: IFolder;
     if (typeof input === 'string') {
       init = JSON.parse(input);
     } else if (typeof input === 'object') {
@@ -77,8 +77,8 @@ export class Workspace extends File {
    * 
    * Note, this throws an error when the environment is not a space. 
    */
-  override new(init: IWorkspace): void {
-    if (!Workspace.isWorkspace(init)) {
+  override new(init: IFolder): void {
+    if (!Folder.isWorkspace(init)) {
       throw new Error(`Not a space.`);
     }
     super.new(init);
@@ -89,15 +89,15 @@ export class Workspace extends File {
    * Checks whether the input is a definition of an user space.
    */
   static isWorkspace(input: unknown): boolean {
-    const typed = input as IWorkspace;
+    const typed = input as IFolder;
     if (!input || typed.kind !== Kind) {
       return false;
     }
     return true;
   }
 
-  override toJSON(): IWorkspace {
-    const result: IWorkspace = {
+  override toJSON(): IFolder {
+    const result: IFolder = {
       ...super.toJSON(),
       kind: Kind,
     };

package/src/models/HttpHistory.ts

@@ -4,41 +4,38 @@ export const Kind = 'Core#HttpHistory';
 export const createdSymbol = Symbol('created');
 export const midnightSymbol = Symbol('midnight');
 
+/**
+ * An HTTP history log.
+ * It's a definition of a HTTP requests history made in an app.
+ */
 export interface IHttpHistory {
   kind: typeof Kind;
   /**
-   * The data store key. Only present when the object was already inserted into the data store.
-   * In majority of cases this value is set. It is not set when generating the history object before sending it to the store.
-   * 
-   * Note for data store implementations. This must be a URL-safe value so the id should be encoded if needed.
-   * 
-   * @readonly
+   * The key of the history entry. The application must 
+   * revalidate the local copy of the record as the store may change the key.
    */
-  key?: string;
+  key: string;
   /**
-   * Optional user space id. When set the history will become available to all space users.
+   * The key of the parent workspace.
    */
-  space?: string;
+  space: string;
   /**
-   * Optional project id. When set the history will become available to all project users.
+   * The key of the project the request belongs to.
    */
-  project?: string;
+  project: string;
   /**
-   * Optional application id. Must be set when the application that created this record does not use the concept of a user space.
+   * The application id that generated the history entry.
    */
-  app?: string;
+  app: string;
   /**
-   * The user id that made that request.
-   * Note, the default API Client's store automatically adds the user information to the record overriding any pre-set user id, making it a read-only
-   * value.
-   * 
-   * @readonly
+   * The key of the request that generated the history entry.
    */
-  user?: string;
+  request: string;
   /**
-   * The optional request id in the project that generated this log.
+   * The user id that made that request.
+   * This is only available when the store support multi-user environment.
    */
-  request?: string;
+  user?: string;
   /**
    * The request log.
    */
@@ -62,21 +59,21 @@ export interface IHttpHistory {
  */
 export interface IHttpHistoryBulkAdd {
   /**
-   * Optional user space id. Must be set when the originating request belongs to a user space.
+   * The key of the parent workspace.
    */
-  space?: string;
+  space: string;
   /**
-   * Optional project id. Must be set when the originating request belongs to a user space.
+   * The key of the project the request belongs to.
    */
-  project?: string;
+  project: string;
   /**
-   * Optional application id. Must be set when the application that created this record does not use the concept of a user space.
+   * The application id that generated the history entry.
    */
-  app?: string;
+  app: string;
   /**
-   * The optional request id in the project that generated this log.
+   * The key of the request that generated the history entry.
    */
-  request?: string;
+  request: string;
   /**
    * The list of request logs.
    */
@@ -96,33 +93,31 @@ export class HttpHistory {
   
   kind = Kind;
   /**
-   * The data store key. Only present when the object was already inserted into the data store.
-   * In majority of cases this value is set. It is not set when generating the history object before sending it to the store.
-   * 
-   * Note for data store implementations. This must be a URL-safe value so the id should be encoded if needed.
+   * The key of the history entry. The application must 
+   * revalidate the local copy of the record as the store may change the key.
    */
-  key?: string;
+  key = '';
   /**
-   * Optional user space id. Must be set when the originating request belongs to a user space.
+   * The key of the parent workspace.
    */
-  space?: string;
+  space = '';
   /**
-   * Optional project id. Must be set when the originating request belongs to a user space.
+   * The key of the project the request belongs to.
    */
-  project?: string;
+  project = '';
   /**
-   * Optional application id. Must be set when the application that created this record does not use the concept of a user space.
+   * The application id that generated the history entry.
    */
-  app?: string;
+  app = '';
   /**
    * The user id that made that request.
-   * Note, the default API Client's store automatically adds the user information to the record overriding any pre-set user id.
+   * This is only available when the store support multi-user environment.
    */
   user = '';
   /**
-   * The optional request id in the project that generated this log.
+   * The key of the request that generated the history entry.
    */
-  request?: string;
+  request = '';
   /**
    * The execution log of the HTTP request with a response.
    */
@@ -182,6 +177,11 @@ export class HttpHistory {
         kind: Kind,
         created: now,
         user: '',
+        app: '',
+        key: '',
+        project: '',
+        request: '',
+        space: '',
         log: {
           kind: RequestLogKind,
         },
@@ -197,12 +197,12 @@ export class HttpHistory {
     if (key) {
       this.key = key;
     } else {
-      this.key = undefined;
+      this.key = '';
     }
     if (app) {
       this.app = app;
     } else {
-      this.app = undefined;
+      this.app = '';
     }
     if (midnight) {
       this.midnight = midnight;
@@ -210,17 +210,17 @@ export class HttpHistory {
     if (space) {
       this.space = space;
     } else {
-      this.space = undefined;
+      this.space = '';
     }
     if (project) {
       this.project = project;
     } else {
-      this.project = undefined;
+      this.project = '';
     }
     if (request) {
       this.request = request;
     } else {
-      this.request = undefined;
+      this.request = '';
     }
     if (user) {
       this.user = user;
@@ -236,22 +236,12 @@ export class HttpHistory {
       midnight: this.midnight,
       log: this.log.toJSON(),
       user: this.user,
+      key: this.key,
+      space: this.space,
+      project: this.project,
+      request: this.request,
+      app: this.app,
     };
-    if (this.key) {
-      result.key = this.key;
-    }
-    if (this.space) {
-      result.space = this.space;
-    }
-    if (this.project) {
-      result.project = this.project;
-    }
-    if (this.request) {
-      result.request = this.request;
-    }
-    if (this.app) {
-      result.app = this.app;
-    }
     return result;
   }