@imbricate/core 3.6.2 → 3.6.4

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.
@@ -3,6 +3,7 @@
3
3
  * @namespace Database
4
4
  * @description Interface
5
5
  */
6
+ import { ImbricateDocumentAuditOptions } from "../document/definition";
6
7
  import { IImbricateDocument } from "../document/interface";
7
8
  import { DocumentProperties } from "../document/property";
8
9
  import { DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "./definition";
@@ -41,7 +42,7 @@ export interface IImbricateDatabase {
41
42
  *
42
43
  * @returns a promise of the created document
43
44
  */
44
- createDocument(properties: DocumentProperties, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<IImbricateDocument>;
45
+ createDocument(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<IImbricateDocument>;
45
46
  /**
46
47
  * Get one document from the database
47
48
  *
@@ -3,6 +3,7 @@
3
3
  * @namespace Database
4
4
  * @description Manager
5
5
  */
6
+ import { ImbricateDatabaseAuditOptions } from "./definition";
6
7
  import { IImbricateDatabase } from "./interface";
7
8
  import { ImbricateDatabaseSchemaForCreation } from "./schema";
8
9
  export interface IImbricateDatabaseManager {
@@ -25,10 +26,9 @@ export interface IImbricateDatabaseManager {
25
26
  *
26
27
  * @param databaseName name of the database
27
28
  * @param schema schema of the database
28
- * @param uniqueIdentifier unique identifier of the database, optional
29
- * if not provided, a unique identifier will be generated
29
+ * @param auditOptions audit options of the database
30
30
  *
31
31
  * @returns a promise of the created database
32
32
  */
33
- createDatabase(databaseName: string, schema: ImbricateDatabaseSchemaForCreation, uniqueIdentifier?: string): PromiseLike<IImbricateDatabase>;
33
+ createDatabase(databaseName: string, schema: ImbricateDatabaseSchemaForCreation, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<IImbricateDatabase>;
34
34
  }
package/index.d.ts CHANGED
@@ -22,7 +22,9 @@ export * from "./loader/persistence";
22
22
  export * from "./origin/definition";
23
23
  export * from "./origin/interface";
24
24
  export * from "./origin/search";
25
+ export * from "./static/definition";
25
26
  export * from "./static/interface";
26
27
  export * from "./static/manager";
28
+ export * from "./text/definition";
27
29
  export * from "./text/interface";
28
30
  export * from "./text/manager";
package/index.js CHANGED
@@ -38,7 +38,9 @@ __exportStar(require("./loader/persistence"), exports);
38
38
  __exportStar(require("./origin/definition"), exports);
39
39
  __exportStar(require("./origin/interface"), exports);
40
40
  __exportStar(require("./origin/search"), exports);
41
+ __exportStar(require("./static/definition"), exports);
41
42
  __exportStar(require("./static/interface"), exports);
42
43
  __exportStar(require("./static/manager"), exports);
44
+ __exportStar(require("./text/definition"), exports);
43
45
  __exportStar(require("./text/interface"), exports);
44
46
  __exportStar(require("./text/manager"), exports);
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@imbricate/core",
3
3
  "main": "index.js",
4
- "version": "3.6.2",
4
+ "version": "3.6.4",
5
5
  "description": "Imbricate Core, Notebook for Engineers",
6
6
  "repository": {
7
7
  "type": "git",
@@ -0,0 +1,12 @@
1
+ /**
2
+ * @author WMXPY
3
+ * @namespace Static
4
+ * @description Definition
5
+ */
6
+ import { ImbricateAuthor } from "../author/definition";
7
+ export type ImbricateStaticAuditOptions = {
8
+ /**
9
+ * Static author, this is controlled an function may vary by origin
10
+ */
11
+ readonly author?: ImbricateAuthor;
12
+ };
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ /**
3
+ * @author WMXPY
4
+ * @namespace Static
5
+ * @description Definition
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -3,11 +3,16 @@
3
3
  * @namespace Static
4
4
  * @description Interface
5
5
  */
6
+ import { ImbricateAuthor } from "../author/definition";
6
7
  export interface IImbricateStatic {
7
8
  /**
8
9
  * Unique identifier of the static object
9
10
  */
10
11
  readonly uniqueIdentifier: string;
12
+ /**
13
+ * Author of the text object
14
+ */
15
+ readonly author?: ImbricateAuthor;
11
16
  /**
12
17
  * Get the content of the static object
13
18
  *
@@ -3,6 +3,7 @@
3
3
  * @namespace Static
4
4
  * @description Manager
5
5
  */
6
+ import { ImbricateStaticAuditOptions } from "./definition";
6
7
  import { IImbricateStatic } from "./interface";
7
8
  export interface IImbricateStaticManager {
8
9
  /**
@@ -17,10 +18,9 @@ export interface IImbricateStaticManager {
17
18
  * Patch a new static object if you want to change the content
18
19
  *
19
20
  * @param content content of the static object, encoded in base64
20
- * @param uniqueIdentifier unique identifier of the static object, optional
21
- * if not provided, a unique identifier will be generated
21
+ * @param auditOptions audit options of the static object
22
22
  *
23
23
  * @returns a promise of the created static object
24
24
  */
25
- createInBase64(content: string, uniqueIdentifier?: string): PromiseLike<IImbricateStatic>;
25
+ createInBase64(content: string, auditOptions?: ImbricateStaticAuditOptions): PromiseLike<IImbricateStatic>;
26
26
  }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * @author WMXPY
3
+ * @namespace Text
4
+ * @description Definition
5
+ */
6
+ import { ImbricateAuthor } from "../author/definition";
7
+ export type ImbricateTextAuditOptions = {
8
+ /**
9
+ * Text author, this is controlled an function may vary by origin
10
+ */
11
+ readonly author?: ImbricateAuthor;
12
+ };
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ /**
3
+ * @author WMXPY
4
+ * @namespace Text
5
+ * @description Definition
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -3,11 +3,16 @@
3
3
  * @namespace Text
4
4
  * @description Interface
5
5
  */
6
+ import { ImbricateAuthor } from "../author/definition";
6
7
  export interface IImbricateText {
7
8
  /**
8
9
  * Unique identifier of the text object
9
10
  */
10
11
  readonly uniqueIdentifier: string;
12
+ /**
13
+ * Author of the text object
14
+ */
15
+ readonly author?: ImbricateAuthor;
11
16
  /**
12
17
  * Get the content of the text object
13
18
  *
package/text/manager.d.ts CHANGED
@@ -3,6 +3,7 @@
3
3
  * @namespace Text
4
4
  * @description Manager
5
5
  */
6
+ import { ImbricateTextAuditOptions } from "./definition";
6
7
  import { IImbricateText } from "./interface";
7
8
  export interface IImbricateTextManager {
8
9
  /**
@@ -17,10 +18,9 @@ export interface IImbricateTextManager {
17
18
  * Patch a new text object if you want to change the content
18
19
  *
19
20
  * @param content content of the text
20
- * @param uniqueIdentifier unique identifier of the text object, optional
21
- * if not provided, a unique identifier will be generated
21
+ * @param auditOptions audit options of the text
22
22
  *
23
23
  * @returns a promise of the text object
24
24
  */
25
- createText(content: string, uniqueIdentifier?: string): PromiseLike<IImbricateText>;
25
+ createText(content: string, auditOptions?: ImbricateTextAuditOptions): PromiseLike<IImbricateText>;
26
26
  }