@imbricate/core 1.20.0 → 1.20.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/origin/interface.d.ts +37 -1
- package/package.json +1 -1
package/origin/interface.d.ts
CHANGED
|
@@ -12,26 +12,62 @@ import { ImbricateScriptMetadata, ImbricateScriptSearchResult, ImbricateScriptSn
|
|
|
12
12
|
import { IImbricateScript } from "../script/interface";
|
|
13
13
|
import { ImbricateOriginCapability, ImbricateOriginMetadata } from "./definition";
|
|
14
14
|
export interface IImbricateOrigin {
|
|
15
|
+
/**
|
|
16
|
+
* Origin type
|
|
17
|
+
*/
|
|
15
18
|
readonly originType: string;
|
|
19
|
+
/**
|
|
20
|
+
* Unique identifier of the origin
|
|
21
|
+
*/
|
|
16
22
|
readonly uniqueIdentifier: string;
|
|
23
|
+
/**
|
|
24
|
+
* Metadata of the origin
|
|
25
|
+
*/
|
|
17
26
|
readonly metadata: ImbricateOriginMetadata;
|
|
27
|
+
/**
|
|
28
|
+
* Payloads of the origin
|
|
29
|
+
*/
|
|
18
30
|
readonly payloads: Record<string, any>;
|
|
31
|
+
/**
|
|
32
|
+
* Capabilities of the origin
|
|
33
|
+
*/
|
|
19
34
|
readonly capabilities: ImbricateOriginCapability;
|
|
35
|
+
/**
|
|
36
|
+
* Get function manager
|
|
37
|
+
*
|
|
38
|
+
* @returns Function manager
|
|
39
|
+
*/
|
|
20
40
|
getFunctionManger(): IImbricateFunctionManager;
|
|
41
|
+
/**
|
|
42
|
+
* Get binary storage
|
|
43
|
+
*
|
|
44
|
+
* @returns Binary storage
|
|
45
|
+
*/
|
|
21
46
|
getBinaryStorage(): IImbricateBinaryStorage;
|
|
22
47
|
/**
|
|
23
48
|
* Create a collection
|
|
24
49
|
*
|
|
25
50
|
* @param collectionName Collection name
|
|
26
51
|
* @param description Collection description
|
|
52
|
+
*
|
|
53
|
+
* @returns Created collection
|
|
27
54
|
*/
|
|
28
|
-
createCollection(collectionName: string, description?: string): PromiseOr<
|
|
55
|
+
createCollection(collectionName: string, description?: string): PromiseOr<IImbricateOriginCollection>;
|
|
29
56
|
renameCollection(collectionUniqueIdentifier: string, newCollectionName: string): PromiseOr<void>;
|
|
30
57
|
deleteCollection(collectionUniqueIdentifier: string): PromiseOr<void>;
|
|
31
58
|
hasCollection(collectionName: string): PromiseOr<boolean>;
|
|
32
59
|
findCollection(collectionName: string): PromiseOr<IImbricateOriginCollection | null>;
|
|
33
60
|
getCollection(collectionUniqueIdentifier: string): PromiseOr<IImbricateOriginCollection | null>;
|
|
34
61
|
listCollections(): PromiseOr<IImbricateOriginCollection[]>;
|
|
62
|
+
/**
|
|
63
|
+
* Create a script
|
|
64
|
+
*
|
|
65
|
+
* @param scriptName Script name
|
|
66
|
+
* @param initialScript Initial script content
|
|
67
|
+
* @param description Script description
|
|
68
|
+
*
|
|
69
|
+
* @returns Created script
|
|
70
|
+
*/
|
|
35
71
|
createScript(scriptName: string, initialScript: string, description?: string): PromiseOr<IImbricateScript>;
|
|
36
72
|
putScript(scriptMetadata: ImbricateScriptMetadata, script: string): PromiseOr<IImbricateScript>;
|
|
37
73
|
renameScript(identifier: string, newScriptName: string): PromiseOr<void>;
|