@imbricate/core 1.19.2 → 1.20.1

package/binary-storage/interface.d.ts

@@ -5,5 +5,17 @@
  */
 import { PromiseOr } from "../definition/promise";
 export interface IImbricateBinaryStorage {
+    /**
+     * Store a binary file
+     *
+     * @param binary Base64 encoded binary
+     * @param fileName File name
+     */
     putBinaryBase64(binary: string, fileName: string): PromiseOr<string>;
+    /**
+     * Validate if the binary is a valid base64 to be stored
+     *
+     * @param binary Base64 encoded binary
+     */
+    validateBinaryBase64(binary: string): PromiseOr<boolean>;
 }

package/origin/interface.d.ts

@@ -12,20 +12,62 @@ import { ImbricateScriptMetadata, ImbricateScriptSearchResult, ImbricateScriptSn
 import { IImbricateScript } from "../script/interface";
 import { ImbricateOriginCapability, ImbricateOriginMetadata } from "./definition";
 export interface IImbricateOrigin {
+    /**
+     * Origin type
+     */
     readonly originType: string;
+    /**
+     * Unique identifier of the origin
+     */
     readonly uniqueIdentifier: string;
+    /**
+     * Metadata of the origin
+     */
     readonly metadata: ImbricateOriginMetadata;
+    /**
+     * Payloads of the origin
+     */
     readonly payloads: Record<string, any>;
+    /**
+     * Capabilities of the origin
+     */
     readonly capabilities: ImbricateOriginCapability;
+    /**
+     * Get function manager
+     *
+     * @returns Function manager
+     */
     getFunctionManger(): IImbricateFunctionManager;
+    /**
+     * Get binary storage
+     *
+     * @returns Binary storage
+     */
     getBinaryStorage(): IImbricateBinaryStorage;
-    createCollection(collectionName: string, description?: string): PromiseOr<void>;
+    /**
+     * Create a collection
+     *
+     * @param collectionName Collection name
+     * @param description Collection description
+     *
+     * @returns Created collection
+     */
+    createCollection(collectionName: string, description?: string): PromiseOr<IImbricateOriginCollection>;
     renameCollection(collectionUniqueIdentifier: string, newCollectionName: string): PromiseOr<void>;
     deleteCollection(collectionUniqueIdentifier: string): PromiseOr<void>;
     hasCollection(collectionName: string): PromiseOr<boolean>;
     findCollection(collectionName: string): PromiseOr<IImbricateOriginCollection | null>;
     getCollection(collectionUniqueIdentifier: string): PromiseOr<IImbricateOriginCollection | null>;
     listCollections(): PromiseOr<IImbricateOriginCollection[]>;
+    /**
+     * Create a script
+     *
+     * @param scriptName Script name
+     * @param initialScript Initial script content
+     * @param description Script description
+     *
+     * @returns Created script
+     */
     createScript(scriptName: string, initialScript: string, description?: string): PromiseOr<IImbricateScript>;
     putScript(scriptMetadata: ImbricateScriptMetadata, script: string): PromiseOr<IImbricateScript>;
     renameScript(identifier: string, newScriptName: string): PromiseOr<void>;
@@ -35,4 +77,9 @@ export interface IImbricateOrigin {
     listScripts(): PromiseOr<ImbricateScriptSnapshot[]>;
     searchScripts(keyword: string, config: ImbricateSearchScriptConfig): PromiseOr<ImbricateScriptSearchResult[]>;
     queryScripts(query: ImbricateScriptQuery, config: ImbricateScriptQueryConfig): PromiseOr<IImbricateScript[]>;
+    /**
+     * Dispose the origin, optional
+     * This method will be called when the origin is no longer needed
+     */
+    dispose?(): PromiseOr<void>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imbricate/core",
   "main": "index.js",
-  "version": "1.19.2",
+  "version": "1.20.1",
   "description": "Imbricate Core, Notebook for Engineers",
   "repository": {
     "type": "git",