@imbricate/core 3.25.1 → 3.27.0

package/common/action.d.ts

@@ -3,7 +3,7 @@
  * @namespace Common
  * @description Action
  */
-import { IETF_LOCALE } from "@sudoo/locale";
+import type { IETF_LOCALE } from "@sudoo/locale";
 import { CommonActionOutcomeSymbol, CommonOutcomeSymbol } from "./outcome";
 export declare enum IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE {
     STRING = "STRING"
@@ -26,8 +26,9 @@ export declare enum IMBRICATE_ORIGIN_ACTION_APPEARANCE {
 }
 export type ImbricateOriginAction = {
     readonly actionIdentifier: string;
-    readonly actionName: Record<IETF_LOCALE, string>;
-    readonly actionDescription: Record<IETF_LOCALE, string>;
+    readonly defaultLocale: IETF_LOCALE;
+    readonly actionName: Partial<Record<IETF_LOCALE, string>>;
+    readonly actionDescription: Partial<Record<IETF_LOCALE, string>>;
     readonly parameters: ImbricateOriginActionParameter[];
     readonly appearance?: IMBRICATE_ORIGIN_ACTION_APPEARANCE;
     readonly disabled?: boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imbricate/core",
   "main": "index.js",
-  "version": "3.25.1",
+  "version": "3.27.0",
   "description": "Imbricate Core, Notebook for Engineers",
   "repository": {
     "type": "git",
@@ -18,7 +18,7 @@
     "url": "https://github.com/Imbricate/Imbricate/issues"
   },
   "homepage": "https://imbricate.io",
-  "dependencies": {
+  "optionalDependencies": {
     "@sudoo/locale": "^2.0.0"
   }
 }

package/static-manager/base-class/full-feature-blob.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @author WMXPY
+ * @namespace StaticManager
+ * @description Full Feature Blob
+ */
+import { IMBRICATE_STATIC_MANAGER_FEATURE } from "../feature";
+import { ImbricateStaticManagerGetStaticUriOutcome } from "../outcome";
+import { IImbricateStaticManager } from "../static-manager";
+import { ImbricateStaticManagerFullFeatureBase } from "./full-feature";
+export declare abstract class ImbricateStaticManagerFullFeatureBlobBase extends ImbricateStaticManagerFullFeatureBase implements IImbricateStaticManager {
+    readonly supportedFeatures: IMBRICATE_STATIC_MANAGER_FEATURE[];
+    getStaticUri(_staticUniqueIdentifier: string): PromiseLike<ImbricateStaticManagerGetStaticUriOutcome>;
+}

package/static-manager/base-class/full-feature-blob.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace StaticManager
+ * @description Full Feature Blob
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImbricateStaticManagerFullFeatureBlobBase = void 0;
+const feature_not_supported_1 = require("../../error/static-manager/feature-not-supported");
+const feature_1 = require("../feature");
+const full_feature_1 = require("./full-feature");
+class ImbricateStaticManagerFullFeatureBlobBase extends full_feature_1.ImbricateStaticManagerFullFeatureBase {
+    constructor() {
+        super(...arguments);
+        this.supportedFeatures = [
+            feature_1.IMBRICATE_STATIC_MANAGER_FEATURE.STATIC_MANAGER_GET_STATIC,
+            feature_1.IMBRICATE_STATIC_MANAGER_FEATURE.STATIC_MANAGER_CREATE_STATIC,
+        ];
+    }
+    getStaticUri(_staticUniqueIdentifier) {
+        throw feature_not_supported_1.ImbricateStaticManagerFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_STATIC_MANAGER_FEATURE.STATIC_MANAGER_GET_STATIC_URI);
+    }
+}
+exports.ImbricateStaticManagerFullFeatureBlobBase = ImbricateStaticManagerFullFeatureBlobBase;

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

@@ -5,10 +5,11 @@
  */
 import { IMBRICATE_STATIC_MIME_TYPE, ImbricateStaticAuditOptions } from "../../static/definition";
 import { IMBRICATE_STATIC_MANAGER_FEATURE } from "../feature";
-import { ImbricateStaticManagerCreateStaticOutcome, ImbricateStaticManagerGetStaticOutcome } from "../outcome";
+import { ImbricateStaticManagerCreateStaticOutcome, ImbricateStaticManagerGetStaticOutcome, ImbricateStaticManagerGetStaticUriOutcome } from "../outcome";
 import { IImbricateStaticManager } from "../static-manager";
 export declare abstract class ImbricateStaticManagerFullFeatureBase implements IImbricateStaticManager {
     readonly supportedFeatures: IMBRICATE_STATIC_MANAGER_FEATURE[];
-    abstract getStatic(uniqueIdentifier: string): PromiseLike<ImbricateStaticManagerGetStaticOutcome>;
+    abstract getStatic(staticUniqueIdentifier: string): PromiseLike<ImbricateStaticManagerGetStaticOutcome>;
     abstract createInBase64(content: string, mimeType: IMBRICATE_STATIC_MIME_TYPE, auditOptions?: ImbricateStaticAuditOptions): PromiseLike<ImbricateStaticManagerCreateStaticOutcome>;
+    abstract getStaticUri(staticUniqueIdentifier: string): PromiseLike<ImbricateStaticManagerGetStaticUriOutcome>;
 }

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

@@ -12,6 +12,7 @@ class ImbricateStaticManagerFullFeatureBase {
         this.supportedFeatures = [
             feature_1.IMBRICATE_STATIC_MANAGER_FEATURE.STATIC_MANAGER_GET_STATIC,
             feature_1.IMBRICATE_STATIC_MANAGER_FEATURE.STATIC_MANAGER_CREATE_STATIC,
+            feature_1.IMBRICATE_STATIC_MANAGER_FEATURE.STATIC_MANAGER_GET_STATIC_URI,
         ];
     }
 }

package/static-manager/base-class/readonly-blob.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @author WMXPY
+ * @namespace StaticManager
+ * @description Readonly Blob
+ */
+import { IMBRICATE_STATIC_MIME_TYPE, ImbricateStaticAuditOptions } from "../../static/definition";
+import { IMBRICATE_STATIC_MANAGER_FEATURE } from "../feature";
+import { ImbricateStaticManagerCreateStaticOutcome } from "../outcome";
+import { IImbricateStaticManager } from "../static-manager";
+import { ImbricateStaticManagerFullFeatureBlobBase } from "./full-feature-blob";
+export declare abstract class ImbricateStaticManagerReadonlyBlobBase extends ImbricateStaticManagerFullFeatureBlobBase implements IImbricateStaticManager {
+    readonly supportedFeatures: IMBRICATE_STATIC_MANAGER_FEATURE[];
+    createInBase64(_content: string, _mimeType: IMBRICATE_STATIC_MIME_TYPE, _auditOptions?: ImbricateStaticAuditOptions): PromiseLike<ImbricateStaticManagerCreateStaticOutcome>;
+}

package/static-manager/base-class/readonly-blob.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace StaticManager
+ * @description Readonly Blob
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImbricateStaticManagerReadonlyBlobBase = void 0;
+const feature_not_supported_1 = require("../../error/static-manager/feature-not-supported");
+const feature_1 = require("../feature");
+const full_feature_blob_1 = require("./full-feature-blob");
+class ImbricateStaticManagerReadonlyBlobBase extends full_feature_blob_1.ImbricateStaticManagerFullFeatureBlobBase {
+    constructor() {
+        super(...arguments);
+        this.supportedFeatures = [
+            feature_1.IMBRICATE_STATIC_MANAGER_FEATURE.STATIC_MANAGER_GET_STATIC,
+        ];
+    }
+    createInBase64(_content, _mimeType, _auditOptions) {
+        throw feature_not_supported_1.ImbricateStaticManagerFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_STATIC_MANAGER_FEATURE.STATIC_MANAGER_CREATE_STATIC);
+    }
+}
+exports.ImbricateStaticManagerReadonlyBlobBase = ImbricateStaticManagerReadonlyBlobBase;

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

@@ -14,6 +14,7 @@ class ImbricateStaticManagerReadonlyBase extends full_feature_1.ImbricateStaticM
         super(...arguments);
         this.supportedFeatures = [
             feature_1.IMBRICATE_STATIC_MANAGER_FEATURE.STATIC_MANAGER_GET_STATIC,
+            feature_1.IMBRICATE_STATIC_MANAGER_FEATURE.STATIC_MANAGER_GET_STATIC_URI,
         ];
     }
     createInBase64(_content, _mimeType, _auditOptions) {

package/static-manager/export.d.ts

@@ -4,7 +4,9 @@
  * @description Export
  */
 export * from "./base-class/full-feature";
+export * from "./base-class/full-feature-blob";
 export * from "./base-class/readonly";
+export * from "./base-class/readonly-blob";
 export * from "./feature";
 export * from "./outcome";
 export * from "./static-manager";

package/static-manager/export.js

@@ -20,7 +20,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./base-class/full-feature"), exports);
+__exportStar(require("./base-class/full-feature-blob"), exports);
 __exportStar(require("./base-class/readonly"), exports);
+__exportStar(require("./base-class/readonly-blob"), exports);
 __exportStar(require("./feature"), exports);
 __exportStar(require("./outcome"), exports);
 __exportStar(require("./static-manager"), exports);

package/static-manager/feature.d.ts

@@ -5,6 +5,7 @@
  */
 export declare enum IMBRICATE_STATIC_MANAGER_FEATURE {
     STATIC_MANAGER_GET_STATIC = "STATIC_MANAGER_GET_STATIC",
-    STATIC_MANAGER_CREATE_STATIC = "STATIC_MANAGER_CREATE_STATIC"
+    STATIC_MANAGER_CREATE_STATIC = "STATIC_MANAGER_CREATE_STATIC",
+    STATIC_MANAGER_GET_STATIC_URI = "STATIC_MANAGER_GET_STATIC_URI"
 }
 export declare const checkImbricateStaticManagerFeatureSupported: (features: IMBRICATE_STATIC_MANAGER_FEATURE[], feature: IMBRICATE_STATIC_MANAGER_FEATURE) => boolean;

package/static-manager/feature.js

@@ -10,6 +10,7 @@ var IMBRICATE_STATIC_MANAGER_FEATURE;
 (function (IMBRICATE_STATIC_MANAGER_FEATURE) {
     IMBRICATE_STATIC_MANAGER_FEATURE["STATIC_MANAGER_GET_STATIC"] = "STATIC_MANAGER_GET_STATIC";
     IMBRICATE_STATIC_MANAGER_FEATURE["STATIC_MANAGER_CREATE_STATIC"] = "STATIC_MANAGER_CREATE_STATIC";
+    IMBRICATE_STATIC_MANAGER_FEATURE["STATIC_MANAGER_GET_STATIC_URI"] = "STATIC_MANAGER_GET_STATIC_URI";
 })(IMBRICATE_STATIC_MANAGER_FEATURE || (exports.IMBRICATE_STATIC_MANAGER_FEATURE = IMBRICATE_STATIC_MANAGER_FEATURE = {}));
 const checkImbricateStaticManagerFeatureSupported = (features, feature) => {
     return features.includes(feature);

package/static-manager/outcome.d.ts

@@ -21,3 +21,11 @@ export declare const rebuildImbricateStaticManagerCreateStaticSymbol: (symbolDes
 export type ImbricateStaticManagerCreateStaticOutcome = {
     readonly static: IImbricateStatic;
 } | CommonOutcomeSymbol | ImbricateStaticManagerCreateStaticOutcomeSymbol;
+export declare const S_StaticManager_GetStaticUri_NotFound: unique symbol;
+export declare const S_StaticManager_GetStaticUri_Unknown: unique symbol;
+export type ImbricateStaticManagerGetStaticUriOutcomeSymbol = typeof S_StaticManager_GetStaticUri_NotFound | typeof S_StaticManager_GetStaticUri_Unknown;
+export declare const ImbricateStaticManagerGetStaticUriOutcomeSymbolList: ImbricateStaticManagerGetStaticUriOutcomeSymbol[];
+export declare const rebuildImbricateStaticManagerGetStaticUri: (symbolDescription: string) => CommonOutcomeSymbol | ImbricateStaticManagerGetStaticUriOutcomeSymbol;
+export type ImbricateStaticManagerGetStaticUriOutcome = {
+    readonly uri: string;
+} | CommonOutcomeSymbol | ImbricateStaticManagerGetStaticUriOutcomeSymbol;

package/static-manager/outcome.js

@@ -5,7 +5,7 @@
  * @description Outcome
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rebuildImbricateStaticManagerCreateStaticSymbol = exports.ImbricateStaticManagerCreateStaticOutcomeSymbolList = exports.S_StaticManager_CreateStatic_Unknown = exports.S_StaticManager_CreateStatic_IdentifierDuplicated = exports.rebuildImbricateStaticManagerGetStaticSymbol = exports.ImbricateStaticManagerGetStaticOutcomeSymbolList = exports.S_StaticManager_GetStatic_Unknown = exports.S_StaticManager_GetStatic_NotFound = void 0;
+exports.rebuildImbricateStaticManagerGetStaticUri = exports.ImbricateStaticManagerGetStaticUriOutcomeSymbolList = exports.S_StaticManager_GetStaticUri_Unknown = exports.S_StaticManager_GetStaticUri_NotFound = exports.rebuildImbricateStaticManagerCreateStaticSymbol = exports.ImbricateStaticManagerCreateStaticOutcomeSymbolList = exports.S_StaticManager_CreateStatic_Unknown = exports.S_StaticManager_CreateStatic_IdentifierDuplicated = exports.rebuildImbricateStaticManagerGetStaticSymbol = exports.ImbricateStaticManagerGetStaticOutcomeSymbolList = exports.S_StaticManager_GetStatic_Unknown = exports.S_StaticManager_GetStatic_NotFound = void 0;
 const rebuild_symbol_1 = require("../util/rebuild-symbol");
 // Manager Get Static
 exports.S_StaticManager_GetStatic_NotFound = Symbol("StaticManager_GetStatic_NotFound");
@@ -23,3 +23,11 @@ exports.ImbricateStaticManagerCreateStaticOutcomeSymbolList = [
     exports.S_StaticManager_CreateStatic_Unknown,
 ];
 exports.rebuildImbricateStaticManagerCreateStaticSymbol = (0, rebuild_symbol_1.createRebuildImbricateSymbolFunction)(exports.ImbricateStaticManagerCreateStaticOutcomeSymbolList, exports.S_StaticManager_CreateStatic_Unknown);
+// Manager Get Static URI
+exports.S_StaticManager_GetStaticUri_NotFound = Symbol("StaticManager_GetStaticUri_NotFound");
+exports.S_StaticManager_GetStaticUri_Unknown = Symbol("StaticManager_GetStaticUri_Unknown");
+exports.ImbricateStaticManagerGetStaticUriOutcomeSymbolList = [
+    exports.S_StaticManager_GetStaticUri_NotFound,
+    exports.S_StaticManager_GetStaticUri_Unknown,
+];
+exports.rebuildImbricateStaticManagerGetStaticUri = (0, rebuild_symbol_1.createRebuildImbricateSymbolFunction)(exports.ImbricateStaticManagerGetStaticUriOutcomeSymbolList, exports.S_StaticManager_GetStaticUri_Unknown);

package/static-manager/static-manager.d.ts

@@ -4,15 +4,22 @@
  * @description Static Manager
  */
 import { IMBRICATE_STATIC_MIME_TYPE, ImbricateStaticAuditOptions } from "../static/definition";
-import { ImbricateStaticManagerCreateStaticOutcome, ImbricateStaticManagerGetStaticOutcome } from "./outcome";
+import { IMBRICATE_STATIC_MANAGER_FEATURE } from "./feature";
+import { ImbricateStaticManagerCreateStaticOutcome, ImbricateStaticManagerGetStaticOutcome, ImbricateStaticManagerGetStaticUriOutcome } from "./outcome";
 export interface IImbricateStaticManager {
+    /**
+     * Supported features of the static manager
+     */
+    readonly supportedFeatures: IMBRICATE_STATIC_MANAGER_FEATURE[];
     /**
      * Get the static object from the origin
      *
+     * @param staticUniqueIdentifier unique identifier of the static object
+     *
      * @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<ImbricateStaticManagerGetStaticOutcome>;
+    getStatic(staticUniqueIdentifier: string): PromiseLike<ImbricateStaticManagerGetStaticOutcome>;
     /**
      * Create a new static object in the origin, encoded in base64
      *  Static object is immutable, once created, it cannot be changed
@@ -26,4 +33,13 @@ export interface IImbricateStaticManager {
      *  Symbol: S_StaticManager_CreateStatic_IdentifierDuplicated - if the identifier is duplicated
      */
     createInBase64(content: string, mimeType: IMBRICATE_STATIC_MIME_TYPE, auditOptions?: ImbricateStaticAuditOptions): PromiseLike<ImbricateStaticManagerCreateStaticOutcome>;
+    /**
+     * Get the Uri of the static object
+     *
+     * @param staticUniqueIdentifier unique identifier of the static object
+     *
+     * @returns a promise of the Uri of the static object
+     *  Symbol: S_StaticManager_GetStaticUri_NotFound - if the static object is not found
+     */
+    getStaticUri(staticUniqueIdentifier: string): PromiseLike<ImbricateStaticManagerGetStaticUriOutcome>;
 }

package/text-manager/text-manager.d.ts

@@ -4,15 +4,22 @@
  * @description Text Manager
  */
 import { ImbricateTextAuditOptions } from "../text/definition";
+import { IMBRICATE_TEXT_MANAGER_FEATURE } from "./feature";
 import { ImbricateTextManagerCreateTextOutcome, ImbricateTextManagerGetTextOutcome } from "./outcome";
 export interface IImbricateTextManager {
+    /**
+     * Supported features of the text manager
+     */
+    readonly supportedFeatures: IMBRICATE_TEXT_MANAGER_FEATURE[];
     /**
      * Get the text object from the origin
      *
+     * @param uniqueIdentifier unique identifier of the text
+     *
      * @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<ImbricateTextManagerGetTextOutcome>;
+    getText(textUniqueIdentifier: string): PromiseLike<ImbricateTextManagerGetTextOutcome>;
     /**
      * Create a new text object in the origin
      *  Text object is immutable, once created, it cannot be changed