@crewdle/web-sdk-types 1.0.0

package/dist/object-storage/FolderDescriptor.d.ts

@@ -0,0 +1,27 @@
+import { ObjectDescriptor, ObjectKind } from '.';
+/**
+ * The object store folder descriptor interface.
+ * @category Object Storage
+ */
+export interface IFolderDescriptor {
+    /**
+     * The object kind.
+     */
+    kind: ObjectKind.Folder;
+    /**
+     * The name of the folder.
+     */
+    name: string;
+    /**
+     * The path of the folder.
+     */
+    path: string;
+    /**
+     * The path name of the folder (a combination of the path and the name).
+     */
+    pathName: string;
+    /**
+     * The folder entries.
+     */
+    entries?: ObjectDescriptor[];
+}

package/dist/object-storage/FolderDescriptor.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/FolderPayload.d.ts

@@ -0,0 +1,15 @@
+import { PayloadAction } from '.';
+/**
+ * The object store folder payload interface.
+ * @category Object Storage
+ */
+export interface IFolderPayload {
+    /**
+     * The object store folder payload action.
+     */
+    action: PayloadAction.Folder;
+    /**
+     * The path of the folder.
+     */
+    path: string;
+}

package/dist/object-storage/FolderPayload.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/MovePayload.d.ts

@@ -0,0 +1,19 @@
+import { PayloadAction } from '.';
+/**
+ * The object store move payload interface.
+ * @category Object Storage
+ */
+export interface IMovePayload {
+    /**
+     * The object store payload action.
+     */
+    action: PayloadAction.Move;
+    /**
+     * The path of the object.
+     */
+    path: string;
+    /**
+     * The new path of the object.
+     */
+    newPath: string;
+}

package/dist/object-storage/MovePayload.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/ObjectDescriptor.d.ts

@@ -0,0 +1,6 @@
+import { IFileDescriptor, IFolderDescriptor } from '.';
+/**
+ * The object descriptor type.
+ * @category Object Storage
+ */
+export type ObjectDescriptor = IFileDescriptor | IFolderDescriptor;

package/dist/object-storage/ObjectDescriptor.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/ObjectKind.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The object kind enum.
+ * @category Object Storage
+ */
+export declare enum ObjectKind {
+    /**
+     * The file kind.
+     */
+    File = "file",
+    /**
+     * The folder kind.
+     */
+    Folder = "folder"
+}

package/dist/object-storage/ObjectKind.js

@@ -0,0 +1,15 @@
+/**
+ * The object kind enum.
+ * @category Object Storage
+ */
+export var ObjectKind;
+(function (ObjectKind) {
+    /**
+     * The file kind.
+     */
+    ObjectKind["File"] = "file";
+    /**
+     * The folder kind.
+     */
+    ObjectKind["Folder"] = "folder";
+})(ObjectKind || (ObjectKind = {}));

package/dist/object-storage/ObjectStoreBucket.d.ts

@@ -0,0 +1,55 @@
+import { IDataStream } from '../core/stream';
+import { ObjectDescriptor, Payload } from '.';
+import { StorageEvent } from './event';
+/**
+ * The object store bucket interface.
+ * @category Object Storage
+ */
+export interface IObjectStoreBucket extends IDataStream {
+    /**
+     * Get the name of the bucket.
+     */
+    getName(): string;
+    /**
+     * Get the owner ID of the bucket.
+     */
+    getOwnerId(): string;
+    /**
+     * Close the bucket.
+     */
+    close(): void;
+    /**
+     * Subscribe to the bucket events.
+     * @param callback The callback function.
+     */
+    subscribe(callback: (data: StorageEvent) => void): void;
+    /**
+     * Unsubscribe from the bucket.
+     */
+    unsubscribe(): void;
+    /**
+     * Publish an action to the bucket.
+     * @param payload The object store payload.
+     * @returns A promise that resolves when the action is published.
+     */
+    publish(payload: Payload): Promise<void>;
+    /**
+     * Unpublish an object from the bucket. It also permanently deletes the object.
+     * @param path The path of the object.
+     * @returns A promise that resolves when the object is unpublished.
+     */
+    unpublish(path: string): Promise<void>;
+    /**
+     * Get an object from the bucket.
+     * @param path The path of the object.
+     * @returns The object.
+     */
+    get(path: string): Promise<File>;
+    /**
+     * List the objects and folders of the bucket.
+     * @param path The path of the folder.
+     * @param recursive Whether to list the objects and folders recursively.
+     * @returns The list of objects and folders.
+     */
+    list(path: string, recursive?: boolean): Promise<ObjectDescriptor[]>;
+}

package/dist/object-storage/ObjectStoreBucket.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/ObjectStoreConnector.d.ts

@@ -0,0 +1,49 @@
+import { ObjectDescriptor, ObjectKind } from '.';
+/**
+ * The object store connector interface.
+ * @category Object Storage
+ */
+export interface IObjectStoreConnector {
+    /**
+     * Gets a file.
+     * @param path The path to the file.
+     * @returns A promise that resolves with the file.
+     */
+    get(path: string): Promise<File>;
+    /**
+     * Lists the objects in a folder.
+     * @param path The path to the folder.
+     * @param recursive Whether to list the objects recursively.
+     * @returns A promise that resolves with an array of object descriptors.
+     */
+    list(path: string, recursive: boolean): Promise<ObjectDescriptor[]>;
+    /**
+     * Creates a folder.
+     * @param path The path to the folder.
+     * @returns A promise that resolves when the folder is created.
+     */
+    createFolder(path: string): Promise<void>;
+    /**
+     * Writes a file.
+     * @param file The file to write.
+     * @param path The path to write the file to.
+     */
+    writeFile(file: File, path?: string): Promise<void>;
+    /**
+     * Moves an object.
+     * @param path The path to the object.
+     * @param newPath The path to move the object to.
+     */
+    moveObject(path: string, newPath: string): Promise<ObjectKind>;
+    /**
+     * Deletes an object.
+     * @param path The path to the object.
+     */
+    deleteObject(path: string): Promise<ObjectKind>;
+    /**
+     * Calculates the size of an object.
+     * @param path The path to the object.
+     * @returns A promise that resolves with the size of the object.
+     */
+    calculateSize(path: string): Promise<number>;
+}

package/dist/object-storage/ObjectStoreConnector.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/ObjectStoreConnectorConstructor.d.ts

@@ -0,0 +1,6 @@
+import { IObjectStoreConnector } from '.';
+/**
+ * The object store connector constructor type.
+ * @category Object Storage
+ */
+export type ObjectStoreConnectorConstructor = new (storeKey: string) => IObjectStoreConnector;

package/dist/object-storage/ObjectStoreConnectorConstructor.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/Payload.d.ts

@@ -0,0 +1,6 @@
+import { IFilePayload, IFolderPayload, IMovePayload } from '.';
+/**
+ * The object store payload.
+ * @category Object Storage
+ */
+export type Payload = IFilePayload | IFolderPayload | IMovePayload;

package/dist/object-storage/Payload.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/PayloadAction.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The object store payload action enum.
+ * @category Object Storage
+ */
+export declare enum PayloadAction {
+    /**
+     * The action to write a file.
+     */
+    File = "file",
+    /**
+     * The action to create a folder.
+     */
+    Folder = "folder",
+    /**
+     * The action to move or rename an object.
+     */
+    Move = "move"
+}

package/dist/object-storage/PayloadAction.js

@@ -0,0 +1,19 @@
+/**
+ * The object store payload action enum.
+ * @category Object Storage
+ */
+export var PayloadAction;
+(function (PayloadAction) {
+    /**
+     * The action to write a file.
+     */
+    PayloadAction["File"] = "file";
+    /**
+     * The action to create a folder.
+     */
+    PayloadAction["Folder"] = "folder";
+    /**
+     * The action to move or rename an object.
+     */
+    PayloadAction["Move"] = "move";
+})(PayloadAction || (PayloadAction = {}));

package/dist/object-storage/event/FileDeleteEvent.d.ts

@@ -0,0 +1,15 @@
+import { IObjectDeleteEventPayload, StorageEventType } from '.';
+/**
+ * The file delete event interface.
+ * @category Object Storage
+ */
+export interface IFileDeleteEvent {
+    /**
+     * The file delete event type.
+     */
+    event: StorageEventType.FileDelete;
+    /**
+     * The file delete event payload.
+     */
+    payload: IObjectDeleteEventPayload;
+}

package/dist/object-storage/event/FileDeleteEvent.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/event/FileMoveEvent.d.ts

@@ -0,0 +1,15 @@
+import { IObjectMoveEventPayload, StorageEventType } from '.';
+/**
+ * The file move event interface.
+ * @category Object Storage
+ */
+export interface IFileMoveEvent {
+    /**
+     * The file move event type.
+     */
+    event: StorageEventType.FileMove;
+    /**
+     * The file move event payload.
+     */
+    payload: IObjectMoveEventPayload;
+}

package/dist/object-storage/event/FileMoveEvent.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/event/FileWriteEvent.d.ts

@@ -0,0 +1,15 @@
+import { IFileWriteEventPayload, StorageEventType } from '.';
+/**
+ * The file write event interface.
+ * @category Object Storage
+ */
+export interface IFileWriteEvent {
+    /**
+     * The file write event type.
+     */
+    event: StorageEventType.FileWrite;
+    /**
+     * The file write event payload.
+     */
+    payload: IFileWriteEventPayload;
+}

package/dist/object-storage/event/FileWriteEvent.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/event/FileWriteEventPayload.d.ts

@@ -0,0 +1,11 @@
+import { IFileDescriptor } from '..';
+/**
+ * The file write event payload interface.
+ * @category Object Storage
+ */
+export interface IFileWriteEventPayload {
+    /**
+     * The file descriptor.
+     */
+    file: IFileDescriptor;
+}

package/dist/object-storage/event/FileWriteEventPayload.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/event/FolderCreateEvent.d.ts

@@ -0,0 +1,15 @@
+import { IFolderCreateEventPayload, StorageEventType } from '.';
+/**
+ * The folder create event interface.
+ * @category Object Storage
+ */
+export interface IFolderCreateEvent {
+    /**
+     * The folder create event type.
+     */
+    event: StorageEventType.FolderCreate;
+    /**
+     * The folder create event payload.
+     */
+    payload: IFolderCreateEventPayload;
+}

package/dist/object-storage/event/FolderCreateEvent.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/event/FolderCreateEventPayload.d.ts

@@ -0,0 +1,11 @@
+import { IFolderDescriptor } from '..';
+/**
+ * The folder create event payload interface.
+ * @category Object Storage
+ */
+export interface IFolderCreateEventPayload {
+    /**
+     * The folder descriptor.
+     */
+    folder: IFolderDescriptor;
+}

package/dist/object-storage/event/FolderCreateEventPayload.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/event/FolderDeleteEvent.d.ts

@@ -0,0 +1,15 @@
+import { IObjectDeleteEventPayload, StorageEventType } from '.';
+/**
+ * The folder delete event interface.
+ * @category Object Storage
+ */
+export interface IFolderDeleteEvent {
+    /**
+     * The folder delete event type.
+     */
+    event: StorageEventType.FolderDelete;
+    /**
+     * The folder delete event payload.
+     */
+    payload: IObjectDeleteEventPayload;
+}

package/dist/object-storage/event/FolderDeleteEvent.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/event/FolderMoveEvent.d.ts

@@ -0,0 +1,15 @@
+import { IObjectMoveEventPayload, StorageEventType } from '.';
+/**
+ * The folder move event interface.
+ * @category Object Storage
+ */
+export interface IFolderMoveEvent {
+    /**
+     * The folder move event type.
+     */
+    event: StorageEventType.FolderMove;
+    /**
+     * The folder move event payload.
+     */
+    payload: IObjectMoveEventPayload;
+}

package/dist/object-storage/event/FolderMoveEvent.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/event/ObjectDeleteEventPayload.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The object (file or folder) delete event payload interface.
+ * @category Object Storage
+ */
+export interface IObjectDeleteEventPayload {
+    /**
+     * The name of the object.
+     */
+    name: string;
+    /**
+     * The path of the object.
+     */
+    path: string;
+    /**
+     * The path name of the object (a combination of the path and the name).
+     */
+    pathName: string;
+}

package/dist/object-storage/event/ObjectDeleteEventPayload.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/event/ObjectMoveEventPayload.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The object (file or folder) move event payload interface.
+ * @category Object Storage
+ */
+export interface IObjectMoveEventPayload {
+    /**
+     * The name of the object.
+     */
+    name: string;
+    /**
+     * The path of the object.
+     */
+    path: string;
+    /**
+     * The path name of the object (a combination of the path and the name).
+     */
+    pathName: string;
+    /**
+     * The old name of the object.
+     */
+    oldName: string;
+    /**
+     * The old path of the object.
+     */
+    oldPath: string;
+    /**
+     * The old path name of the object (a combination of the old path and the old name).
+     */
+    oldPathName: string;
+}

package/dist/object-storage/event/ObjectMoveEventPayload.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/event/StorageEvent.d.ts

@@ -0,0 +1,6 @@
+import { IFileDeleteEvent, IFileMoveEvent, IFileWriteEvent, IFolderCreateEvent, IFolderDeleteEvent, IFolderMoveEvent } from '.';
+/**
+ * The object store event.
+ * @category Object Storage
+ */
+export type StorageEvent = IFileWriteEvent | IFileDeleteEvent | IFileMoveEvent | IFolderCreateEvent | IFolderDeleteEvent | IFolderMoveEvent;

package/dist/object-storage/event/StorageEvent.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/event/StorageEventType.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The file store event type enum.
+ * @category Object Storage
+ */
+export declare enum StorageEventType {
+    /**
+     * The file write event.
+     */
+    FileWrite = "file-write",
+    /**
+     * The file delete event.
+     */
+    FileDelete = "file-delete",
+    /**
+     * The file move event.
+     */
+    FileMove = "file-move",
+    /**
+     * The folder create event.
+     */
+    FolderCreate = "folder-create",
+    /**
+     * The folder delete event.
+     */
+    FolderDelete = "folder-delete",
+    /**
+     * The folder move event.
+     */
+    FolderMove = "folder-move"
+}

package/dist/object-storage/event/StorageEventType.js

@@ -0,0 +1,31 @@
+/**
+ * The file store event type enum.
+ * @category Object Storage
+ */
+export var StorageEventType;
+(function (StorageEventType) {
+    /**
+     * The file write event.
+     */
+    StorageEventType["FileWrite"] = "file-write";
+    /**
+     * The file delete event.
+     */
+    StorageEventType["FileDelete"] = "file-delete";
+    /**
+     * The file move event.
+     */
+    StorageEventType["FileMove"] = "file-move";
+    /**
+     * The folder create event.
+     */
+    StorageEventType["FolderCreate"] = "folder-create";
+    /**
+     * The folder delete event.
+     */
+    StorageEventType["FolderDelete"] = "folder-delete";
+    /**
+     * The folder move event.
+     */
+    StorageEventType["FolderMove"] = "folder-move";
+})(StorageEventType || (StorageEventType = {}));

package/dist/object-storage/event/index.d.ts

@@ -0,0 +1,12 @@
+export { IFileDeleteEvent } from './FileDeleteEvent';
+export { IFileMoveEvent } from './FileMoveEvent';
+export { IFileWriteEvent } from './FileWriteEvent';
+export { IFileWriteEventPayload } from './FileWriteEventPayload';
+export { IFolderCreateEvent } from './FolderCreateEvent';
+export { IFolderCreateEventPayload } from './FolderCreateEventPayload';
+export { IFolderDeleteEvent } from './FolderDeleteEvent';
+export { IFolderMoveEvent } from './FolderMoveEvent';
+export { IObjectDeleteEventPayload } from './ObjectDeleteEventPayload';
+export { IObjectMoveEventPayload } from './ObjectMoveEventPayload';
+export { StorageEvent } from './StorageEvent';
+export { StorageEventType } from './StorageEventType';

package/dist/object-storage/event/index.js

@@ -0,0 +1 @@
+export { StorageEventType } from './StorageEventType';

package/dist/object-storage/index.d.ts

@@ -0,0 +1,13 @@
+export * from './event';
+export { IFileDescriptor } from './FileDescriptor';
+export { IFilePayload } from './FilePayload';
+export { IFolderDescriptor } from './FolderDescriptor';
+export { IFolderPayload } from './FolderPayload';
+export { IMovePayload } from './MovePayload';
+export { ObjectDescriptor } from './ObjectDescriptor';
+export { ObjectKind } from './ObjectKind';
+export { IObjectStoreBucket } from './ObjectStoreBucket';
+export { IObjectStoreConnector } from './ObjectStoreConnector';
+export { ObjectStoreConnectorConstructor } from './ObjectStoreConnectorConstructor';
+export { Payload } from './Payload';
+export { PayloadAction } from './PayloadAction';

package/dist/object-storage/index.js

@@ -0,0 +1,3 @@
+export * from './event';
+export { ObjectKind } from './ObjectKind';
+export { PayloadAction } from './PayloadAction';

package/dist/pubsub/PubSubTopic.d.ts

@@ -0,0 +1,37 @@
+import { IDataStream } from '../core/stream';
+import { SubscribeFunction, SubscriptionKeys } from '.';
+/**
+ * The pub/sub topic interface.
+ * @category Pub/Sub
+ */
+export interface IPubSubTopic<T> extends IDataStream {
+    /**
+     * Get the name of the topic.
+     */
+    getName(): string;
+    /**
+     * Get the owner ID of the topic.
+     */
+    getOwnerId(): string;
+    /**
+     * Publish content to the topic.
+     * @param content The content to publish. Content needs to be a valid JSON.stringify argument.
+     * @param nodeIds The node IDs to publish to.
+     */
+    publish(content: T | File, nodeIds?: string[]): void;
+    /**
+     * Subscribe to the topic.
+     * @typeParam U - Any of the content types defined in {@link ISubscriptions}.
+     * @param contentType - One of the content type defined in {@link ISubscriptions}.
+     * @param callback - The callback when the content is received. callbacks' payload are defined in {@link ISubscriptions}.
+     */
+    subscribe: SubscribeFunction<T>;
+    /**
+     * Unsubscribe from the topic.
+     */
+    unsubscribe(contentType: SubscriptionKeys<T>): void;
+    /**
+     * Close the topic.
+     */
+    close(): void;
+}

package/dist/pubsub/PubSubTopic.js

@@ -0,0 +1 @@
+export {};