@api-client/core 0.9.16 → 0.9.18

package/src/models/Project.ts

@@ -1,5 +1,5 @@
 import { IFile, File, DefaultOwner } from "./store/File.js";
-import { Kind as ThingKind } from './Thing.js';
+import { Thing } from './Thing.js';
 import { HttpProject, IHttpProject } from './HttpProject.js';
 import v4 from '../lib/uuid.js';
 
@@ -20,7 +20,7 @@ export interface IProject extends IFile {
 export class Project extends File {
   override kind = Kind;
 
-  static fromProject(project: HttpProject | IHttpProject): Project {
+  static fromProject(project: HttpProject | IHttpProject, owner = DefaultOwner): Project {
     let final: IHttpProject;
     if (typeof (project as HttpProject).toJSON === 'function') {
       final = (project as HttpProject).toJSON();
@@ -29,10 +29,10 @@ export class Project extends File {
     }
     const init: IProject = {
       kind: Kind,
-      key: final.key,
+      key: project.key,
       info: { ...final.info },
-      lastModified: { user: '', time: 0, byMe: false },
-      owner: DefaultOwner,
+      lastModified: { user: owner, time: 0, byMe: false },
+      owner,
       parents: [],
       permissionIds: [],
       permissions: [],
@@ -51,10 +51,7 @@ export class Project extends File {
       init = {
         kind: Kind,
         key: v4(),
-        info: {
-          kind: ThingKind,
-          name: '',
-        },
+        info: Thing.fromName('').toJSON(),
         owner: DefaultOwner,
         parents: [],
         permissionIds: [],

package/src/models/Space.ts

@@ -1,4 +1,4 @@
-import { Kind as ThingKind } from "./Thing.js";
+import { Thing } from "./Thing.js";
 import v4 from '../lib/uuid.js';
 import { DefaultOwner, File, IFile } from "./store/File.js";
 
@@ -23,21 +23,8 @@ export interface ISpace extends IFile {
 export class Space extends File {
   override kind = Kind;
 
-  static fromName(name: string, owner = DefaultOwner): Space {
-    const init: ISpace = {
-      kind: Kind,
-      key: v4(),
-      info: {
-        kind: ThingKind,
-        name,
-      },
-      lastModified: { user: '', time: 0, byMe: false },
-      owner,
-      parents: [],
-      permissionIds: [],
-      permissions: [],
-    };
-    return new Space(init);
+  static override fromName(name: string, owner = DefaultOwner): Space {
+    return super.fromName(name, owner, Kind) as Space;
   }
 
   constructor(input?: string | ISpace) {
@@ -51,10 +38,7 @@ export class Space extends File {
       init = {
         kind: Kind,
         key: v4(),
-        info: {
-          kind: ThingKind,
-          name: '',
-        },
+        info: Thing.fromName('').toJSON(),
         owner: DefaultOwner,
         parents: [],
         permissionIds: [],

package/src/models/data/DataFile.ts

@@ -1,6 +1,6 @@
 import v4 from "../../lib/uuid.js";
 import { File, IFile, DefaultOwner } from "../store/File.js";
-import { Kind as ThingKind } from '../Thing.js';
+import { Thing } from '../Thing.js';
 import { DataNamespace, IDataNamespace } from "./DataNamespace.js";
 
 export const Kind = 'Core#DataFile';
@@ -21,7 +21,7 @@ export class DataFile extends File {
    * @param input The data namespace instance or schema.
    * @param owner Optional owner to set.
    */
-  static fromDataNamespace(input: DataNamespace | IDataNamespace, owner?: string): DataFile {
+  static fromDataNamespace(input: DataNamespace | IDataNamespace, owner = DefaultOwner): DataFile {
     let final: IDataNamespace;
     if (typeof (input as DataNamespace).toJSON === 'function') {
       final = (input as DataNamespace).toJSON();
@@ -32,8 +32,8 @@ export class DataFile extends File {
       kind: Kind,
       key: final.key,
       info: { ...final.info },
-      lastModified: { user: '', time: 0, byMe: false },
-      owner: owner || DefaultOwner,
+      lastModified: { user: owner, time: 0, byMe: false },
+      owner,
       parents: [],
       permissionIds: [],
       permissions: [],
@@ -52,10 +52,7 @@ export class DataFile extends File {
       init = {
         kind: Kind,
         key: v4(),
-        info: {
-          kind: ThingKind,
-          name: '',
-        },
+        info: Thing.fromName('').toJSON(),
         owner: DefaultOwner,
         parents: [],
         permissionIds: [],

package/src/models/store/Backend.ts

@@ -119,16 +119,26 @@ export interface BackendErrorEvent {
   time: number;
 }
 
+export interface ClearedBroadcastEvent {
+  type: 'event';
+  operation: 'cleared';
+  name: string;
+  space: string;
+  path: string;
+}
+
+export interface BroadcastFileData {
+  parent?: string;
+  alt: AltType;
+}
+
 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 FileCreatedBroadcastEvent extends BroadcastCreatedEvent, BroadcastFileData {
 }
 
 export interface FileMetaCreatedBroadcastEvent extends FileCreatedBroadcastEvent {
@@ -148,10 +158,9 @@ export interface HistoryCreatedBroadcastEvent extends BroadcastCreatedEvent {
   data: IHttpHistory;
 }
 
-export interface FileRevisionCreatedBroadcastEvent extends BroadcastCreatedEvent {
+export interface FileRevisionCreatedBroadcastEvent extends BroadcastCreatedEvent, BroadcastFileData {
   parent: string;
   data: IRevision;
-  alt: AltType;
 }
 
 export interface ProjectExecutionCreatedBroadcastEvent extends BroadcastCreatedEvent {
@@ -165,9 +174,7 @@ export interface BroadcastPatchEvent extends BroadcastEvent {
   // path: string; -> /files, /spaces
 }
 
-export interface FilePatchBroadcastEvent extends BroadcastPatchEvent {
-  parent?: string;
-  alt: AltType;
+export interface FilePatchBroadcastEvent extends BroadcastPatchEvent, BroadcastFileData {
 }
 
 export interface AccessBroadcastEvent extends BroadcastEvent {
@@ -185,9 +192,7 @@ export interface DeletedBroadcastEvent extends BroadcastEvent {
   // path: string; -> /files, /certificates, /history, /project/executions, /spaces, /trash
 }
 
-export interface FileDeletedBroadcastEvent extends DeletedBroadcastEvent {
-  parent?: string;
-  alt: AltType;
+export interface FileDeletedBroadcastEvent extends DeletedBroadcastEvent, BroadcastFileData {
 }
 
 export interface ProjectExecutionDeleteBroadcastEvent extends DeletedBroadcastEvent {
@@ -198,7 +203,3 @@ export interface HistoryDeletedBroadcastEvent extends DeletedBroadcastEvent {
   project: string;
   request: string;
 }
-
-export interface ClearedBroadcastEvent extends BroadcastEvent {
-  operation: 'cleared';
-}

package/src/models/store/File.ts

@@ -504,4 +504,26 @@ export class File extends StoredFile {
     };
     return result;
   }
+
+  /**
+   * Creates a new Space object from a name.
+   * 
+   * @param name The name to set.
+   * @param owner The user id that is the owner of the space.
+   */
+  static fromName(name: string, owner = DefaultOwner, kind = ''): File {
+    const key = v4();
+    const definition = new File();
+    definition.new({
+      key,
+      kind,
+      info: Thing.fromName(name).toJSON(),
+      owner,
+      parents: [],
+      permissionIds: [],
+      permissions: [],
+      lastModified: { user: owner, time: 0, byMe: false },
+    })
+    return definition;
+  }
 }

package/src/runtime/store/CertificatesSdk.ts

@@ -1,4 +1,3 @@
-import WebSocketNode from 'ws';
 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 { ContextChangeRecord, ContextDeleteRecord, ContextListResult, ContextSpaceListOptions, IBulkOperationResult } from '../../events/BaseEvents.js';
@@ -11,6 +10,7 @@ export class CertificatesSdk extends SdkBase {
    * 
    * @param value The value to insert.
    * @param space The parent space of the certificate.
+   * @deprecated Use the `files` to store certificates.
    */
   async add(value: HttpCertificate, space: string, request: ISdkRequestOptions = {}): Promise<ContextChangeRecord<HttpCertificate>> {
     const token = request.token || this.sdk.token;
@@ -49,6 +49,7 @@ export class CertificatesSdk extends SdkBase {
    * @param value The lits of certificates to add.
    * @param space The parent workspace
    * @returns The list of inserted certificates. `undefined` when there was an error inserting a certificate.
+   * @deprecated Use the `files` to store certificates.
    */
   async addBulk(values: HttpCertificate[], space: string, request: ISdkRequestOptions = {}): Promise<IBulkOperationResult<ContextChangeRecord<HttpCertificate>>> {
     const token = request.token || this.sdk.token;
@@ -84,6 +85,7 @@ export class CertificatesSdk extends SdkBase {
 
   /**
    * @param key The key of the certificate to read.
+   * @deprecated Use the `files` to store certificates.
    */
   async read(key: string, request: ISdkRequestOptions = {}): Promise<HttpCertificate> {
     const token = request.token || this.sdk.token;
@@ -120,6 +122,7 @@ export class CertificatesSdk extends SdkBase {
    * 
    * @param space The parent space of the certificate.
    * @param options The list query options.
+   * @deprecated Use the `files` to store certificates.
    */
   async list(options?: ContextSpaceListOptions, request: ISdkRequestOptions = {}): Promise<ContextListResult<HttpCertificate>> {
     const token = request.token || this.sdk.token;
@@ -156,6 +159,7 @@ export class CertificatesSdk extends SdkBase {
    * Marks the certificate as deleted.
    * 
    * @param key The key of the certificate to delete.
+   * @deprecated Use the `files` to store certificates.
    */
   async delete(key: string, request: ISdkRequestOptions = {}): Promise<void> {
     const token = request.token || this.sdk.token;
@@ -177,6 +181,7 @@ export class CertificatesSdk extends SdkBase {
   /**
    * Removed certificates in a bulk operation.
    * @param keys The list of certificate keys to delete.
+   * @deprecated Use the `files` to store certificates.
    */
   async deleteBulk(keys: string[], request: ISdkRequestOptions = {}): Promise<IBulkOperationResult<ContextDeleteRecord>> {
     const token = request.token || this.sdk.token;
@@ -212,6 +217,7 @@ export class CertificatesSdk extends SdkBase {
   /**
    * Removes all certificates from the store for the given workspace.
    * @param space The parent workspace key
+   * @deprecated Use the `files` to store certificates.
    */
   async empty(space: string, request: ISdkRequestOptions = {}): Promise<void> {
     const token = request.token || this.sdk.token;
@@ -229,16 +235,4 @@ export class CertificatesSdk extends SdkBase {
       throw e;
     }
   }
-
-  /**
-   * Creates a WS client that listens to the certificate events.
-   * @param space The parent space.
-   * @param request Optional request options.
-   */
-  async observe(space: string, request: ISdkRequestOptions = {}): Promise<WebSocketNode | WebSocket> {
-    const token = request.token || this.sdk.token;
-    const url = this.sdk.getUrl(RouteBuilder.certificates());
-    url.searchParams.set('space', space);
-    return this.sdk.ws.createAndConnect(url.toString(), token);
-  }
 }

package/src/runtime/store/FilesSdk.ts

@@ -1,4 +1,3 @@
-import WebSocketNode from 'ws';
 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 { IUser } from '../../models/store/User.js';
@@ -6,6 +5,7 @@ import { FileBreadcrumb, IFile } from '../../models/store/File.js';
 import { Kind as ProjectKind } from '../../models/Project.js';
 import { Kind as FolderKind } from '../../models/Folder.js';
 import { Kind as DataNamespaceKind } from '../../models/data/DataNamespace.js';
+import { Kind as CertificateFileKind } from '../../models/CertificateFile.js';
 import { SdkError } from './Errors.js';
 import { 
   ContextListResult, 
@@ -41,7 +41,7 @@ export interface IFileCreateOptions extends IMetaCreateOptions, IMediaCreateOpti
 
 }
 
-export type ListFileKind = typeof ProjectKind | typeof FolderKind | typeof DataNamespaceKind;
+export type ListFileKind = typeof ProjectKind | typeof FolderKind | typeof DataNamespaceKind | typeof CertificateFileKind;
 
 /**
  * In the store, the file is represented by the meta and the media.
@@ -493,35 +493,6 @@ export class FilesSdk extends SdkBase {
     return data;
   }
 
-  /**
-   * Creates a WS client that listens to the files events.
-   * @param space The parent space.
-   * @param request Optional request options.
-   */
-  async observeFiles(space: string, request: ISdkRequestOptions = {}): Promise<WebSocketNode | WebSocket> {
-    const token = request.token || this.sdk.token;
-    const url = this.sdk.getUrl(RouteBuilder.files());
-    url.searchParams.set('space', space);
-    return this.sdk.ws.createAndConnect(url.toString(), token);
-  }
-
-  /**
-   * Creates a WS client that listens to the file events.
-   * 
-   * @param key The file key to observe
-   * @param media Whether to observe changes to the file media instead of meta.
-   * @param request Optional request options.
-   */
-  async observeFile(space: string, key: string, media?: boolean, request: ISdkRequestOptions = {}): Promise<WebSocketNode | WebSocket> {
-    const token = request.token || this.sdk.token;
-    const url = this.sdk.getUrl(RouteBuilder.file(key));
-    url.searchParams.set('space', space);
-    if (media) {
-      url.searchParams.set('alt', 'media');
-    }
-    return this.sdk.ws.createAndConnect(url.toString(), token);
-  }
-
   /**
    * Lists breadcrumbs to the file.
    * @param key The lowest file in the hierarchy

package/src/runtime/store/HistorySdk.ts

@@ -1,4 +1,3 @@
-import WebSocketNode from 'ws';
 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 { IHttpHistory, IHttpHistoryBulkAdd, Kind as HttpHistoryKind } from '../../models/HttpHistory.js';
@@ -292,16 +291,4 @@ export class HistorySdk extends SdkBase {
       throw e;
     }
   }
-
-  /**
-   * Creates a WS client that listens to the certificate events.
-   * @param space The parent space.
-   * @param request Optional request options.
-   */
-  async observe(space: string, request: ISdkRequestOptions = {}): Promise<WebSocketNode | WebSocket> {
-    const token = request.token || this.sdk.token;
-    const url = this.sdk.getUrl(RouteBuilder.history());
-    url.searchParams.set('space', space);
-    return this.sdk.ws.createAndConnect(url.toString(), token);
-  }
 }

package/src/runtime/store/ProjectExecutionsSdk.ts

@@ -1,4 +1,3 @@
-import WebSocketNode from 'ws';
 import { SdkBase, E_RESPONSE_UNKNOWN, ISdkRequestOptions } from './SdkBase.js';
 import { RouteBuilder } from './RouteBuilder.js';
 import { ContextChangeRecord, ContextDeleteRecord, ContextListResult, IBulkOperationResult, IProjectExecutionListOptions } from '../../events/BaseEvents.js';
@@ -120,16 +119,4 @@ export class ProjectExecutionSdk extends SdkBase {
     url.searchParams.set('folder', folder);
     await this.genericDelete(url, request);
   }
-
-  /**
-   * Creates a WS client that listens to the certificate events.
-   * @param space The parent space.
-   * @param request Optional request options.
-   */
-  async observe(space: string, request: ISdkRequestOptions = {}): Promise<WebSocketNode | WebSocket> {
-    const token = request.token || this.sdk.token;
-    const url = this.sdk.getUrl(RouteBuilder.projectExecutions());
-    url.searchParams.set('space', space);
-    return this.sdk.ws.createAndConnect(url.toString(), token);
-  }
 }

package/src/runtime/store/Sdk.ts

@@ -56,6 +56,9 @@ export abstract class Sdk {
    */
   shared = new SharedSdk(this);
 
+  /**
+   * @deprecated Use the `files` to store certificates.
+   */
   certificates = new CertificatesSdk(this);
 
   revisions = new RevisionsSdk(this);
@@ -117,6 +120,9 @@ export abstract class Sdk {
    * @param path The path to the endpoint, without the base path.
    */
   getUrl(path='/'): URL {
+    if (path.startsWith('http:') || path.startsWith('https:')) {
+      return new URL(path);
+    }
     const { baseUri, basePath='' } = this;
     let userPath = path;
     if (basePath && userPath.startsWith(basePath)) {