@api-client/core 0.9.14 → 0.9.16

package/build/src/models/store/Backend.d.ts

@@ -1,3 +1,9 @@
+import { IPatchRevision } from "../../events/BaseEvents.js";
+import { IHttpHistory, Kind as HttpHistoryKind } from "../HttpHistory.js";
+import { Kind as ProjectExecutionKind } from "../ProjectExecution.js";
+import { IFile } from "./File.js";
+import { IPermission } from "./Permission.js";
+import { IRevision } from "./Revision.js";
 export type BackendMode = 'single-user' | 'multi-user';
 export interface IBackendInfo {
     /**
@@ -73,58 +79,93 @@ export interface IBackendInfo {
         socket?: string;
     };
 }
+export type AltType = 'media' | 'meta';
+export declare enum BackendCommandType {
+    observe = 0,
+    unobserve = 1
+}
+export declare const BackendCommandKind = "Core#BackendCommand";
 export interface IBackendCommand {
-    /**
-     * Optional path. When not set the path is the URL of the web socket channel.
-     */
-    path?: string;
-    /**
-     * The operation to perform
-     */
-    operation: 'delete' | 'patch' | 'create';
-    /**
-     * The command data.
-     */
-    value?: unknown;
+    kind: typeof BackendCommandKind;
+    cmd: BackendCommandType;
 }
-export interface IBackendMessage {
-    /**
-     * The message type. Usually it is an `event`, meaning, a data change notification.
-     */
-    type: 'event';
-    /**
-     * In most cases an event has data associated with it like the created object or
-     * the patch that has been applied to the object.
-     * Not set for events related to deleting an object.
-     */
-    data?: unknown;
+export interface IBackendObserveCommand extends IBackendCommand {
+    path: string;
 }
-export interface IBackendEvent extends IBackendMessage {
-    /**
-     * The operation that has been performed on the resource.
-     *
-     * Note, `updated` is when the entire object must be revalidated in the opposite
-     * to `patch` where the patch should be applied to the object.
-     *
-     * - created - when an entity was created
-     * - patch - when a patch operation was applied to an entity
-     * - deleted - when an entity was deleted
-     * - access-granted - when access to an entity was granted. This also includes when the access level change.
-     * - access-removed - when access to an entity was removed.
-     * - updated - used in special cases as most communication uses patch. Informs the whole object was updated.
-     * - cleared - when the data store was cleared and all entities destroyed.
-     */
-    operation: 'created' | 'patch' | 'deleted' | 'access-granted' | 'access-removed' | 'updated' | 'cleared';
-    /**
-     * The kind of data that has been changed.
-     */
+export interface BroadcastEvent {
+    type: 'event';
+    operation: string;
     kind: string;
-    /**
-     * For update events it is the key of the updated object.
-     */
-    id?: string;
-    /**
-     * When relevant, the parent of the changed object.
-     */
+    key: string;
+    path: string;
+    space: string;
+}
+export interface BackendErrorEvent {
+    type: 'error';
+    cause: string;
+    time: number;
+}
+export interface BroadcastCreatedEvent extends BroadcastEvent {
+    operation: 'created';
+    data: unknown;
+}
+export interface FileCreatedBroadcastEvent extends BroadcastCreatedEvent {
     parent?: string;
+    data: unknown;
+    alt: AltType;
+}
+export interface FileMetaCreatedBroadcastEvent extends FileCreatedBroadcastEvent {
+    data: IFile;
+    alt: 'meta';
+}
+export interface FileMediaCreatedBroadcastEvent extends FileCreatedBroadcastEvent {
+    alt: 'media';
+}
+export interface HistoryCreatedBroadcastEvent extends BroadcastCreatedEvent {
+    project: string;
+    request: string;
+    app: string;
+    kind: typeof HttpHistoryKind;
+    data: IHttpHistory;
+}
+export interface FileRevisionCreatedBroadcastEvent extends BroadcastCreatedEvent {
+    parent: string;
+    data: IRevision;
+    alt: AltType;
+}
+export interface ProjectExecutionCreatedBroadcastEvent extends BroadcastCreatedEvent {
+    project: string;
+    kind: typeof ProjectExecutionKind;
+}
+export interface BroadcastPatchEvent extends BroadcastEvent {
+    operation: 'patch';
+    data: IPatchRevision;
+}
+export interface FilePatchBroadcastEvent extends BroadcastPatchEvent {
+    parent?: string;
+    alt: AltType;
+}
+export interface AccessBroadcastEvent extends BroadcastEvent {
+    operation: 'access-granted' | 'access-removed';
+    data?: IPermission;
+}
+export interface FileAccessBroadcastEvent extends AccessBroadcastEvent {
+    parent?: string;
+}
+export interface DeletedBroadcastEvent extends BroadcastEvent {
+    operation: 'deleted';
+}
+export interface FileDeletedBroadcastEvent extends DeletedBroadcastEvent {
+    parent?: string;
+    alt: AltType;
+}
+export interface ProjectExecutionDeleteBroadcastEvent extends DeletedBroadcastEvent {
+    project: string;
+}
+export interface HistoryDeletedBroadcastEvent extends DeletedBroadcastEvent {
+    project: string;
+    request: string;
+}
+export interface ClearedBroadcastEvent extends BroadcastEvent {
+    operation: 'cleared';
 }

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

@@ -1,2 +1,7 @@
-export {};
+export var BackendCommandType;
+(function (BackendCommandType) {
+    BackendCommandType[BackendCommandType["observe"] = 0] = "observe";
+    BackendCommandType[BackendCommandType["unobserve"] = 1] = "unobserve";
+})(BackendCommandType || (BackendCommandType = {}));
+export const BackendCommandKind = 'Core#BackendCommand';
 //# sourceMappingURL=Backend.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"Backend.js","sourceRoot":"","sources":["../../../../src/models/store/Backend.ts"],"names":[],"mappings":""}
+{"version":3,"file":"Backend.js","sourceRoot":"","sources":["../../../../src/models/store/Backend.ts"],"names":[],"mappings":"AA0FA,MAAM,CAAN,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,iEAAO,CAAA;IACP,qEAAS,CAAA;AACX,CAAC,EAHW,kBAAkB,KAAlB,kBAAkB,QAG7B;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,qBAAqB,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.9.14",
+  "version": "0.9.16",
   "license": "Apache-2.0",
   "main": "build/index.js",
   "module": "build/index.js",

package/src/models/store/Backend.ts

@@ -1,3 +1,10 @@
+import { IPatchRevision } from "../../events/BaseEvents.js";
+import { IHttpHistory, Kind as HttpHistoryKind } from "../HttpHistory.js";
+import { Kind as ProjectExecutionKind } from "../ProjectExecution.js";
+import { IFile } from "./File.js";
+import { IPermission } from "./Permission.js";
+import { IRevision } from "./Revision.js";
+
 /* eslint-disable import/export */
 export type BackendMode = 'single-user' | 'multi-user';
 
@@ -79,60 +86,119 @@ export interface IBackendInfo {
   }
 }
 
+export type AltType = 'media' | 'meta';
+
+export enum BackendCommandType {
+  observe,
+  unobserve,
+}
+
+export const BackendCommandKind = 'Core#BackendCommand';
+
 export interface IBackendCommand {
-  /**
-   * Optional path. When not set the path is the URL of the web socket channel.
-   */
-  path?: string;
-  /**
-   * The operation to perform
-   */
-  operation: 'delete' | 'patch' | 'create';
-  /**
-   * The command data.
-   */
-  value?: unknown;
+  kind: typeof BackendCommandKind;
+  cmd: BackendCommandType;
 }
 
-export interface IBackendMessage {
-  /**
-   * The message type. Usually it is an `event`, meaning, a data change notification.
-   */
-  type: 'event';
-  /**
-   * In most cases an event has data associated with it like the created object or 
-   * the patch that has been applied to the object.
-   * Not set for events related to deleting an object.
-   */
-  data?: unknown;
+export interface IBackendObserveCommand extends IBackendCommand {
+  path: string; // includes query parameters
 }
 
-export interface IBackendEvent extends IBackendMessage {
-  /**
-   * The operation that has been performed on the resource.
-   * 
-   * Note, `updated` is when the entire object must be revalidated in the opposite
-   * to `patch` where the patch should be applied to the object.
-   * 
-   * - created - when an entity was created
-   * - patch - when a patch operation was applied to an entity
-   * - deleted - when an entity was deleted
-   * - access-granted - when access to an entity was granted. This also includes when the access level change.
-   * - access-removed - when access to an entity was removed.
-   * - updated - used in special cases as most communication uses patch. Informs the whole object was updated.
-   * - cleared - when the data store was cleared and all entities destroyed.
-   */
-  operation: 'created' | 'patch' | 'deleted' | 'access-granted' | 'access-removed' | 'updated' | 'cleared';
-  /**
-   * The kind of data that has been changed.
-   */
+export interface BroadcastEvent {
+  type: 'event';
+  operation: string;
   kind: string;
-  /**
-   * For update events it is the key of the updated object.
-   */
-  id?: string;
-  /**
-   * When relevant, the parent of the changed object.
-   */
+  key: string;
+  path: string;
+  space: string; // empty string for `/spaces`
+}
+
+export interface BackendErrorEvent {
+  type: 'error';
+  cause: string;
+  time: number;
+}
+
+export interface BroadcastCreatedEvent extends BroadcastEvent {
+  operation: 'created';
+  data: unknown;
+  // path: string; -> /files, /certificates, /history, /project/executions, /spaces, /trash
+}
+
+export interface FileCreatedBroadcastEvent extends BroadcastCreatedEvent {
+  parent?: string;
+  data: unknown;
+  alt: AltType;
+}
+
+export interface FileMetaCreatedBroadcastEvent extends FileCreatedBroadcastEvent {
+  data: IFile;
+  alt: 'meta';
+}
+
+export interface FileMediaCreatedBroadcastEvent extends FileCreatedBroadcastEvent {
+  alt: 'media';
+}
+
+export interface HistoryCreatedBroadcastEvent extends BroadcastCreatedEvent {
+  project: string;
+  request: string;
+  app: string;
+  kind: typeof HttpHistoryKind;
+  data: IHttpHistory;
+}
+
+export interface FileRevisionCreatedBroadcastEvent extends BroadcastCreatedEvent {
+  parent: string;
+  data: IRevision;
+  alt: AltType;
+}
+
+export interface ProjectExecutionCreatedBroadcastEvent extends BroadcastCreatedEvent {
+  project: string;
+  kind: typeof ProjectExecutionKind;
+}
+
+export interface BroadcastPatchEvent extends BroadcastEvent {
+  operation: 'patch';
+  data: IPatchRevision;
+  // path: string; -> /files, /spaces
+}
+
+export interface FilePatchBroadcastEvent extends BroadcastPatchEvent {
   parent?: string;
+  alt: AltType;
+}
+
+export interface AccessBroadcastEvent extends BroadcastEvent {
+  operation: 'access-granted' | 'access-removed';
+  data?: IPermission;
+  // path: string; -> /files, /spaces, /spaces
+}
+
+export interface FileAccessBroadcastEvent extends AccessBroadcastEvent {
+  parent?: string;
+}
+
+export interface DeletedBroadcastEvent extends BroadcastEvent {
+  operation: 'deleted',
+  // path: string; -> /files, /certificates, /history, /project/executions, /spaces, /trash
+}
+
+export interface FileDeletedBroadcastEvent extends DeletedBroadcastEvent {
+  parent?: string;
+  alt: AltType;
+}
+
+export interface ProjectExecutionDeleteBroadcastEvent extends DeletedBroadcastEvent {
+  project: string;
+}
+
+export interface HistoryDeletedBroadcastEvent extends DeletedBroadcastEvent {
+  project: string;
+  request: string;
+}
+
+export interface ClearedBroadcastEvent extends BroadcastEvent {
+  operation: 'cleared';
 }