@imbricate/core 3.7.0 → 3.7.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/database/interface.d.ts
CHANGED
|
@@ -3,10 +3,9 @@
|
|
|
3
3
|
* @namespace Database
|
|
4
4
|
* @description Interface
|
|
5
5
|
*/
|
|
6
|
-
import { ImbricateDocumentAuditOptions } from "../document/definition";
|
|
7
6
|
import { IImbricateDocument } from "../document/interface";
|
|
8
7
|
import { DocumentProperties } from "../document/property";
|
|
9
|
-
import { DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "./definition";
|
|
8
|
+
import { DatabaseAnnotationValue, DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "./definition";
|
|
10
9
|
import { ImbricateDatabaseSchema } from "./schema";
|
|
11
10
|
export interface IImbricateDatabase {
|
|
12
11
|
/**
|
|
@@ -46,7 +45,7 @@ export interface IImbricateDatabase {
|
|
|
46
45
|
*
|
|
47
46
|
* @returns a promise of the created document
|
|
48
47
|
*/
|
|
49
|
-
createDocument(properties: DocumentProperties, auditOptions?:
|
|
48
|
+
createDocument(properties: DocumentProperties, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<IImbricateDocument>;
|
|
50
49
|
/**
|
|
51
50
|
* Get one document from the database
|
|
52
51
|
*
|
|
@@ -77,7 +76,7 @@ export interface IImbricateDatabase {
|
|
|
77
76
|
* @param uniqueIdentifier unique identifier of the document
|
|
78
77
|
* @param auditOptions audit options of the document
|
|
79
78
|
*/
|
|
80
|
-
removeDocument(uniqueIdentifier: string, auditOptions?:
|
|
79
|
+
removeDocument(uniqueIdentifier: string, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<void>;
|
|
81
80
|
/**
|
|
82
81
|
* put annotation to the database
|
|
83
82
|
*
|
|
@@ -90,7 +89,7 @@ export interface IImbricateDatabase {
|
|
|
90
89
|
* Note: if the origin supports Document Edit Record, the edit record will be added by default
|
|
91
90
|
* If you do not want to add the edit record, set `noEditRecord` to true in audit options
|
|
92
91
|
*/
|
|
93
|
-
putAnnotation(namespace: string, identifier: string, value:
|
|
92
|
+
putAnnotation(namespace: string, identifier: string, value: DatabaseAnnotationValue, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<DatabaseEditRecord[]>;
|
|
94
93
|
/**
|
|
95
94
|
* Delete annotation from the database
|
|
96
95
|
*
|
package/document/interface.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* @namespace Document
|
|
4
4
|
* @description Interface
|
|
5
5
|
*/
|
|
6
|
-
import { DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "./definition";
|
|
6
|
+
import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "./definition";
|
|
7
7
|
import { DocumentProperties, DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "./property";
|
|
8
8
|
export interface IImbricateDocument {
|
|
9
9
|
/**
|
|
@@ -53,7 +53,7 @@ export interface IImbricateDocument {
|
|
|
53
53
|
* Note: if the origin supports Document Edit Record, the edit record will be added by default
|
|
54
54
|
* If you do not want to add the edit record, set `noEditRecord` to true in audit options
|
|
55
55
|
*/
|
|
56
|
-
putAnnotation(namespace: string, identifier: string, value:
|
|
56
|
+
putAnnotation(namespace: string, identifier: string, value: DocumentAnnotationValue, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<DocumentEditRecord[]>;
|
|
57
57
|
/**
|
|
58
58
|
* Delete annotation from the document
|
|
59
59
|
*
|