@imbricate/core 3.11.0 → 3.14.0

package/{static/manager.d.ts → static-manager/static-manager.d.ts}

@@ -1,17 +1,18 @@
 /**
  * @author WMXPY
- * @namespace Static
- * @description Manager
+ * @namespace StaticManager
+ * @description Static Manager
  */
-import { ImbricateStaticAuditOptions } from "./definition";
-import { IImbricateStatic } from "./interface";
+import { ImbricateStaticAuditOptions } from "../static/definition";
+import { ImbricateStaticManagerCreateStaticOutcome, ImbricateStaticManagerGetStaticOutcome } from "./outcome";
 export interface IImbricateStaticManager {
     /**
      * Get the static object from the origin
      *
      * @returns a promise of the static object, null if not found
+     *  Symbol: S_StaticManager_GetStatic_NotFound - if the static object is not found
      */
-    getStatic(uniqueIdentifier: string): PromiseLike<IImbricateStatic | null>;
+    getStatic(uniqueIdentifier: string): PromiseLike<ImbricateStaticManagerGetStaticOutcome>;
     /**
      * Create a new static object in the origin, encoded in base64
      *  Static object is immutable, once created, it cannot be changed
@@ -21,6 +22,7 @@ export interface IImbricateStaticManager {
      * @param auditOptions audit options of the static object
      *
      * @returns a promise of the created static object
+     *  Symbol: S_StaticManager_CreateStatic_IdentifierDuplicated - if the identifier is duplicated
      */
-    createInBase64(content: string, auditOptions?: ImbricateStaticAuditOptions): PromiseLike<IImbricateStatic>;
+    createInBase64(content: string, auditOptions?: ImbricateStaticAuditOptions): PromiseLike<ImbricateStaticManagerCreateStaticOutcome>;
 }

package/{database/manager.js → static-manager/static-manager.js}

@@ -1,7 +1,7 @@
 "use strict";
 /**
  * @author WMXPY
- * @namespace Database
- * @description Manager
+ * @namespace StaticManager
+ * @description Static Manager
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/text/base-class/author-only.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Author Only
+ */
+import { IMBRICATE_TEXT_FEATURE } from "../feature";
+import { IImbricateText } from "../interface";
+import { ImbricateTextGetContentOutcome } from "../outcome";
+import { ImbricateTextFullFeatureBase } from "./full-feature";
+export declare abstract class ImbricateTextAuthorOnlyBase extends ImbricateTextFullFeatureBase implements IImbricateText {
+    readonly features: IMBRICATE_TEXT_FEATURE[];
+    getContent(): PromiseLike<ImbricateTextGetContentOutcome>;
+}

package/text/base-class/author-only.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Author Only
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImbricateTextAuthorOnlyBase = void 0;
+const feature_not_supported_1 = require("../../error/text/feature-not-supported");
+const feature_1 = require("../feature");
+const full_feature_1 = require("./full-feature");
+class ImbricateTextAuthorOnlyBase extends full_feature_1.ImbricateTextFullFeatureBase {
+    constructor() {
+        super(...arguments);
+        this.features = [
+            feature_1.IMBRICATE_TEXT_FEATURE.TEXT_GET_AUTHOR,
+        ];
+    }
+    getContent() {
+        throw feature_not_supported_1.ImbricateTextFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_TEXT_FEATURE.TEXT_GET_CONTENT);
+    }
+}
+exports.ImbricateTextAuthorOnlyBase = ImbricateTextAuthorOnlyBase;

package/text/base-class/content-only.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Content Only
+ */
+import { ImbricateAuthor } from "../../author/definition";
+import { IMBRICATE_TEXT_FEATURE } from "../feature";
+import { ImbricateTextFullFeatureBase } from "./full-feature";
+export declare abstract class ImbricateTextContentOnlyBase extends ImbricateTextFullFeatureBase {
+    readonly features: IMBRICATE_TEXT_FEATURE[];
+    get author(): ImbricateAuthor;
+}

package/text/base-class/content-only.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Content Only
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImbricateTextContentOnlyBase = void 0;
+const feature_not_supported_1 = require("../../error/text/feature-not-supported");
+const feature_1 = require("../feature");
+const full_feature_1 = require("./full-feature");
+class ImbricateTextContentOnlyBase extends full_feature_1.ImbricateTextFullFeatureBase {
+    constructor() {
+        super(...arguments);
+        this.features = [
+            feature_1.IMBRICATE_TEXT_FEATURE.TEXT_GET_CONTENT,
+        ];
+    }
+    get author() {
+        throw feature_not_supported_1.ImbricateTextFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_TEXT_FEATURE.TEXT_GET_AUTHOR);
+    }
+}
+exports.ImbricateTextContentOnlyBase = ImbricateTextContentOnlyBase;

package/text/base-class/full-feature.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Base Class
+ */
+import { ImbricateAuthor } from "../../author/definition";
+import { IMBRICATE_TEXT_FEATURE } from "../feature";
+import { IImbricateText } from "../interface";
+import { ImbricateTextGetContentOutcome } from "../outcome";
+export declare abstract class ImbricateTextFullFeatureBase implements IImbricateText {
+    abstract readonly uniqueIdentifier: string;
+    readonly features: IMBRICATE_TEXT_FEATURE[];
+    abstract readonly author: ImbricateAuthor;
+    abstract getContent(): PromiseLike<ImbricateTextGetContentOutcome>;
+}

package/text/base-class/full-feature.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Base Class
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImbricateTextFullFeatureBase = void 0;
+const feature_1 = require("../feature");
+class ImbricateTextFullFeatureBase {
+    constructor() {
+        this.features = [
+            feature_1.IMBRICATE_TEXT_FEATURE.TEXT_GET_AUTHOR,
+            feature_1.IMBRICATE_TEXT_FEATURE.TEXT_GET_CONTENT,
+        ];
+    }
+}
+exports.ImbricateTextFullFeatureBase = ImbricateTextFullFeatureBase;

package/text/export.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Export
+ */
+export * from "./base-class/author-only";
+export * from "./base-class/content-only";
+export * from "./base-class/full-feature";
+export * from "./definition";
+export * from "./feature";
+export * from "./interface";
+export * from "./outcome";

package/text/export.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Export
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./base-class/author-only"), exports);
+__exportStar(require("./base-class/content-only"), exports);
+__exportStar(require("./base-class/full-feature"), exports);
+__exportStar(require("./definition"), exports);
+__exportStar(require("./feature"), exports);
+__exportStar(require("./interface"), exports);
+__exportStar(require("./outcome"), exports);

package/text/feature.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Feature
+ */
+export declare enum IMBRICATE_TEXT_FEATURE {
+    TEXT_GET_AUTHOR = "TEXT_GET_AUTHOR",
+    TEXT_GET_CONTENT = "TEXT_GET_CONTENT"
+}
+export declare const checkImbricateTextFeatureSupported: (features: IMBRICATE_TEXT_FEATURE[], feature: IMBRICATE_TEXT_FEATURE) => boolean;

package/text/feature.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Feature
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkImbricateTextFeatureSupported = exports.IMBRICATE_TEXT_FEATURE = void 0;
+var IMBRICATE_TEXT_FEATURE;
+(function (IMBRICATE_TEXT_FEATURE) {
+    IMBRICATE_TEXT_FEATURE["TEXT_GET_AUTHOR"] = "TEXT_GET_AUTHOR";
+    IMBRICATE_TEXT_FEATURE["TEXT_GET_CONTENT"] = "TEXT_GET_CONTENT";
+})(IMBRICATE_TEXT_FEATURE || (exports.IMBRICATE_TEXT_FEATURE = IMBRICATE_TEXT_FEATURE = {}));
+const checkImbricateTextFeatureSupported = (features, feature) => {
+    return features.includes(feature);
+};
+exports.checkImbricateTextFeatureSupported = checkImbricateTextFeatureSupported;

package/text/interface.d.ts

@@ -4,19 +4,26 @@
  * @description Interface
  */
 import { ImbricateAuthor } from "../author/definition";
+import { IMBRICATE_TEXT_FEATURE } from "./feature";
+import { ImbricateTextGetContentOutcome } from "./outcome";
 export interface IImbricateText {
     /**
      * Unique identifier of the text object
      */
     readonly uniqueIdentifier: string;
+    /**
+     * Features supported by the text object
+     */
+    readonly features: IMBRICATE_TEXT_FEATURE[];
     /**
      * Author of the text object
      */
-    readonly author?: ImbricateAuthor;
+    readonly author: ImbricateAuthor;
     /**
      * Get the content of the text object
      *
      * @returns a promise of the content of the text object
+     *  Symbol: S_Text_GetContent_NotFound - if the content is not found
      */
-    getContent(): PromiseLike<string>;
+    getContent(): PromiseLike<ImbricateTextGetContentOutcome>;
 }

package/text/outcome.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Outcome
+ */
+export declare const S_Text_GetContent_NotFound: unique symbol;
+export type ImbricateTextGetContentOutcomeSymbol = typeof S_Text_GetContent_NotFound;
+export type ImbricateTextGetContentOutcome = {
+    readonly content: string;
+} | ImbricateTextGetContentOutcomeSymbol;

package/text/outcome.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Outcome
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.S_Text_GetContent_NotFound = void 0;
+// Get Content
+exports.S_Text_GetContent_NotFound = Symbol("Text_GetContent_NotFound");

package/text-manager/base-class/full-feature.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @author WMXPY
+ * @namespace TextManager
+ * @description Full Feature
+ */
+import { ImbricateTextAuditOptions } from "../../text/definition";
+import { IMBRICATE_TEXT_MANAGER_FEATURE } from "../feature";
+import { ImbricateTextManagerCreateTextOutcome, ImbricateTextManagerGetTextOutcome } from "../outcome";
+import { IImbricateTextManager } from "../text-manager";
+export declare abstract class ImbricateTextManagerFullFeatureBase implements IImbricateTextManager {
+    readonly supportedFeatures: IMBRICATE_TEXT_MANAGER_FEATURE[];
+    abstract getText(uniqueIdentifier: string): PromiseLike<ImbricateTextManagerGetTextOutcome>;
+    abstract createText(content: string, auditOptions?: ImbricateTextAuditOptions): PromiseLike<ImbricateTextManagerCreateTextOutcome>;
+}

package/text-manager/base-class/full-feature.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace TextManager
+ * @description Full Feature
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImbricateTextManagerFullFeatureBase = void 0;
+const feature_1 = require("../feature");
+class ImbricateTextManagerFullFeatureBase {
+    constructor() {
+        this.supportedFeatures = [
+            feature_1.IMBRICATE_TEXT_MANAGER_FEATURE.TEXT_MANAGER_GET_TEXT,
+            feature_1.IMBRICATE_TEXT_MANAGER_FEATURE.TEXT_MANAGER_CREATE_TEXT,
+        ];
+    }
+}
+exports.ImbricateTextManagerFullFeatureBase = ImbricateTextManagerFullFeatureBase;

package/text-manager/base-class/readonly.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @author WMXPY
+ * @namespace TextManager
+ * @description Readonly
+ */
+import { ImbricateTextAuditOptions } from "../../text/definition";
+import { IMBRICATE_TEXT_MANAGER_FEATURE } from "../feature";
+import { ImbricateTextManagerCreateTextOutcome } from "../outcome";
+import { IImbricateTextManager } from "../text-manager";
+import { ImbricateTextManagerFullFeatureBase } from "./full-feature";
+export declare abstract class ImbricateTextManagerReadonlyBase extends ImbricateTextManagerFullFeatureBase implements IImbricateTextManager {
+    readonly supportedFeatures: IMBRICATE_TEXT_MANAGER_FEATURE[];
+    createInBase64(_content: string, _auditOptions?: ImbricateTextAuditOptions): PromiseLike<ImbricateTextManagerCreateTextOutcome>;
+}

package/text-manager/base-class/readonly.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace TextManager
+ * @description Readonly
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImbricateTextManagerReadonlyBase = void 0;
+const feature_not_supported_1 = require("../../error/text-manager/feature-not-supported");
+const feature_1 = require("../feature");
+const full_feature_1 = require("./full-feature");
+class ImbricateTextManagerReadonlyBase extends full_feature_1.ImbricateTextManagerFullFeatureBase {
+    constructor() {
+        super(...arguments);
+        this.supportedFeatures = [
+            feature_1.IMBRICATE_TEXT_MANAGER_FEATURE.TEXT_MANAGER_GET_TEXT,
+        ];
+    }
+    createInBase64(_content, _auditOptions) {
+        throw feature_not_supported_1.ImbricateTextManagerFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_TEXT_MANAGER_FEATURE.TEXT_MANAGER_CREATE_TEXT);
+    }
+}
+exports.ImbricateTextManagerReadonlyBase = ImbricateTextManagerReadonlyBase;

package/text-manager/export.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @author WMXPY
+ * @namespace TextManager
+ * @description Export
+ */
+export * from "./base-class/full-feature";
+export * from "./base-class/readonly";
+export * from "./feature";
+export * from "./outcome";
+export * from "./text-manager";

package/text-manager/export.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace TextManager
+ * @description Export
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./base-class/full-feature"), exports);
+__exportStar(require("./base-class/readonly"), exports);
+__exportStar(require("./feature"), exports);
+__exportStar(require("./outcome"), exports);
+__exportStar(require("./text-manager"), exports);

package/text-manager/feature.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @author WMXPY
+ * @namespace TextManager
+ * @description Feature
+ */
+export declare enum IMBRICATE_TEXT_MANAGER_FEATURE {
+    TEXT_MANAGER_GET_TEXT = "TEXT_MANAGER_GET_TEXT",
+    TEXT_MANAGER_CREATE_TEXT = "TEXT_MANAGER_CREATE_TEXT"
+}
+export declare const checkImbricateTextManagerFeatureSupported: (features: IMBRICATE_TEXT_MANAGER_FEATURE[], feature: IMBRICATE_TEXT_MANAGER_FEATURE) => boolean;

package/text-manager/feature.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace TextManager
+ * @description Feature
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkImbricateTextManagerFeatureSupported = exports.IMBRICATE_TEXT_MANAGER_FEATURE = void 0;
+var IMBRICATE_TEXT_MANAGER_FEATURE;
+(function (IMBRICATE_TEXT_MANAGER_FEATURE) {
+    IMBRICATE_TEXT_MANAGER_FEATURE["TEXT_MANAGER_GET_TEXT"] = "TEXT_MANAGER_GET_TEXT";
+    IMBRICATE_TEXT_MANAGER_FEATURE["TEXT_MANAGER_CREATE_TEXT"] = "TEXT_MANAGER_CREATE_TEXT";
+})(IMBRICATE_TEXT_MANAGER_FEATURE || (exports.IMBRICATE_TEXT_MANAGER_FEATURE = IMBRICATE_TEXT_MANAGER_FEATURE = {}));
+const checkImbricateTextManagerFeatureSupported = (features, feature) => {
+    return features.includes(feature);
+};
+exports.checkImbricateTextManagerFeatureSupported = checkImbricateTextManagerFeatureSupported;

package/text-manager/outcome.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @author WMXPY
+ * @namespace TextManager
+ * @description Outcome
+ */
+import { IImbricateText } from "../text/interface";
+export declare const S_TextManager_GetText_NotFound: unique symbol;
+export type ImbricateTextManagerGetTextOutcomeSymbol = typeof S_TextManager_GetText_NotFound;
+export type ImbricateTextManagerGetTextOutcome = {
+    readonly text: IImbricateText;
+} | ImbricateTextManagerGetTextOutcomeSymbol;
+export declare const S_TextManager_CreateText_IdentifierDuplicated: unique symbol;
+export type ImbricateTextManagerCreateTextOutcomeSymbol = typeof S_TextManager_CreateText_IdentifierDuplicated;
+export type ImbricateTextManagerCreateTextOutcome = {
+    readonly text: IImbricateText;
+} | ImbricateTextManagerCreateTextOutcomeSymbol;

package/text-manager/outcome.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace TextManager
+ * @description Outcome
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.S_TextManager_CreateText_IdentifierDuplicated = exports.S_TextManager_GetText_NotFound = void 0;
+// Manager Get Text
+exports.S_TextManager_GetText_NotFound = Symbol("TextManager_GetText_NotFound");
+// Manager Create Text
+exports.S_TextManager_CreateText_IdentifierDuplicated = Symbol("TextManager_CreateText_IdentifierDuplicated");

package/{text/manager.d.ts → text-manager/text-manager.d.ts}

@@ -1,17 +1,18 @@
 /**
  * @author WMXPY
- * @namespace Text
- * @description Manager
+ * @namespace TextManager
+ * @description Text Manager
  */
-import { ImbricateTextAuditOptions } from "./definition";
-import { IImbricateText } from "./interface";
+import { ImbricateTextAuditOptions } from "../text/definition";
+import { ImbricateTextManagerCreateTextOutcome, ImbricateTextManagerGetTextOutcome } from "./outcome";
 export interface IImbricateTextManager {
     /**
      * Get the text object from the origin
      *
      * @returns a promise of the text object, null if not found
+     *  Symbol: S_TextManager_GetText_NotFound - if the text is not found
      */
-    getText(uniqueIdentifier: string): PromiseLike<IImbricateText | null>;
+    getText(uniqueIdentifier: string): PromiseLike<ImbricateTextManagerGetTextOutcome>;
     /**
      * Create a new text object in the origin
      *  Text object is immutable, once created, it cannot be changed
@@ -21,6 +22,7 @@ export interface IImbricateTextManager {
      * @param auditOptions audit options of the text
      *
      * @returns a promise of the text object
+     *  Symbol: S_TextManager_CreateText_IdentifierDuplicated - if the identifier is duplicated
      */
-    createText(content: string, auditOptions?: ImbricateTextAuditOptions): PromiseLike<IImbricateText>;
+    createText(content: string, auditOptions?: ImbricateTextAuditOptions): PromiseLike<ImbricateTextManagerCreateTextOutcome>;
 }

package/{text/manager.js → text-manager/text-manager.js}

@@ -1,7 +1,7 @@
 "use strict";
 /**
  * @author WMXPY
- * @namespace Text
- * @description Manager
+ * @namespace TextManager
+ * @description Text Manager
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/database/manager.d.ts

@@ -1,41 +0,0 @@
-/**
- * @author WMXPY
- * @namespace Database
- * @description Manager
- */
-import { ImbricateDatabaseAuditOptions } from "./definition";
-import { IImbricateDatabase } from "./interface";
-import { ImbricateDatabaseSchemaForCreation } from "./schema";
-export interface IImbricateDatabaseManager {
-    /**
-     * List all databases in the origin
-     *
-     * @returns a promise of the databases in the origin
-     */
-    listDatabases(): PromiseLike<IImbricateDatabase[]>;
-    /**
-     * Get one database from the origin
-     *
-     * @param uniqueIdentifier unique identifier of the database
-     *
-     * @returns a promise of the database, null if not found
-     */
-    getDatabase(uniqueIdentifier: string): PromiseLike<IImbricateDatabase | null>;
-    /**
-     * Create a new database
-     *
-     * @param databaseName name of the database
-     * @param schema schema of the database
-     * @param auditOptions audit options of the database
-     *
-     * @returns a promise of the created database
-     */
-    createDatabase(databaseName: string, schema: ImbricateDatabaseSchemaForCreation, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<IImbricateDatabase>;
-    /**
-     * Remove a database from the origin
-     *
-     * @param uniqueIdentifier unique identifier of the database
-     * @param auditOptions audit options of deletion
-     */
-    removeDatabase(uniqueIdentifier: string, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<void>;
-}