@imbricate/core 2.5.0 → 2.6.1

package/collection/base.d.ts

@@ -3,6 +3,7 @@
  * @namespace Collection
  * @description Base
  */
+import { ImbricateAuthor } from "../author/definition";
 import { ImbricateCapabilityBuilder } from "../capability/builder";
 import { ImbricateCapability } from "../capability/definition";
 import { IImbricateCollectionOperationManager } from "../collection-operation-manager/interface";
@@ -20,7 +21,7 @@ export declare abstract class ImbricateCollectionBase implements IImbricateColle
     abstract readonly collectionName: string;
     abstract readonly uniqueIdentifier: string;
     abstract readonly capabilities: ImbricateCollectionCapability;
-    createPage(_directories: string[], _title: string, _variant: ImbricatePageVariant, _initialContent: string, _description?: string): PromiseOr<IImbricatePage>;
+    createPage(_directories: string[], _title: string, _variant: ImbricatePageVariant, _author: ImbricateAuthor, _initialContent: string, _description?: string): PromiseOr<IImbricatePage>;
     putPage(_pageMetadata: ImbricatePageMetadata, _content: string): PromiseOr<IImbricatePage>;
     retitlePage(_identifier: string, _newTitle: string): PromiseOr<void>;
     deletePage(_identifier: string): PromiseOr<void>;

package/collection/base.js

@@ -20,7 +20,7 @@ class ImbricateCollectionBase {
     static allDenyCapability() {
         return this.buildCapability((0, definition_1.createDenyImbricateCapability)()).build();
     }
-    createPage(_directories, _title, _variant, _initialContent, _description) {
+    createPage(_directories, _title, _variant, _author, _initialContent, _description) {
         throw not_implemented_1.ImbricateNotImplemented.create("CreatePage", definition_2.IMBRICATE_COLLECTION_CAPABILITY_KEY.CREATE_PAGE);
     }
     putPage(_pageMetadata, _content) {

package/collection/interface.d.ts

@@ -3,6 +3,7 @@
  * @namespace Collection
  * @description Interface
  */
+import { ImbricateAuthor } from "../author/definition";
 import { IImbricateCollectionOperationManager } from "../collection-operation-manager/interface";
 import type { PromiseOr } from "../definition/promise";
 import { ImbricatePageVariant } from "../page-variant/definition";
@@ -15,7 +16,19 @@ export interface IImbricateCollection {
     readonly uniqueIdentifier: string;
     readonly description?: string;
     readonly capabilities: ImbricateCollectionCapability;
-    createPage(directories: string[], title: string, variant: ImbricatePageVariant, initialContent: string, description?: string): PromiseOr<IImbricatePage>;
+    /**
+     * Create a page
+     *
+     * @param directories Directories
+     * @param title Title
+     * @param variant Variant
+     * @param author Author
+     * @param initialContent Initial content
+     * @param description Description
+     *
+     * @returns Created page
+     */
+    createPage(directories: string[], title: string, variant: ImbricatePageVariant, author: ImbricateAuthor, initialContent: string, description?: string): PromiseOr<IImbricatePage>;
     putPage(pageMetadata: ImbricatePageMetadata, content: string): PromiseOr<IImbricatePage>;
     retitlePage(identifier: string, newTitle: string): PromiseOr<void>;
     deletePage(identifier: string): PromiseOr<void>;

package/index.d.ts

@@ -39,6 +39,7 @@ export * from "./origin/base";
 export * from "./origin/definition";
 export * from "./origin/interface";
 export * from "./page-variant/definition";
+export * from "./page-variant/extension";
 export * from "./page/base";
 export * from "./page/definition";
 export * from "./page/interface";
@@ -49,7 +50,6 @@ export * from "./script-manager/base";
 export * from "./script-manager/definition";
 export * from "./script-manager/interface";
 export * from "./script-variant/definition";
-export * from "./script-variant/extension";
 export * from "./script/base";
 export * from "./script/definition";
 export * from "./script/interface";

package/index.js

@@ -55,6 +55,7 @@ __exportStar(require("./origin/base"), exports);
 __exportStar(require("./origin/definition"), exports);
 __exportStar(require("./origin/interface"), exports);
 __exportStar(require("./page-variant/definition"), exports);
+__exportStar(require("./page-variant/extension"), exports);
 __exportStar(require("./page/base"), exports);
 __exportStar(require("./page/definition"), exports);
 __exportStar(require("./page/interface"), exports);
@@ -65,7 +66,6 @@ __exportStar(require("./script-manager/base"), exports);
 __exportStar(require("./script-manager/definition"), exports);
 __exportStar(require("./script-manager/interface"), exports);
 __exportStar(require("./script-variant/definition"), exports);
-__exportStar(require("./script-variant/extension"), exports);
 __exportStar(require("./script/base"), exports);
 __exportStar(require("./script/definition"), exports);
 __exportStar(require("./script/interface"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imbricate/core",
   "main": "index.js",
-  "version": "2.5.0",
+  "version": "2.6.1",
   "description": "Imbricate Core, Notebook for Engineers",
   "repository": {
     "type": "git",

package/page/base.d.ts

@@ -3,6 +3,7 @@
  * @namespace Page
  * @description Base
  */
+import { ImbricateAuthor } from "../author/definition";
 import { ImbricateCapabilityBuilder } from "../capability/builder";
 import { ImbricateCapability } from "../capability/definition";
 import type { PromiseOr } from "../definition/promise";
@@ -27,7 +28,7 @@ export declare abstract class ImbricatePageBase implements IImbricatePage {
     writeContent(_content: string): PromiseOr<void>;
     readAttributes(): PromiseOr<Record<string, string>>;
     writeAttribute(_key: string, _value: string): PromiseOr<void>;
-    refreshUpdateMetadata(_updatedAt: Date, _digest: string): PromiseOr<void>;
+    refreshUpdateMetadata(_updatedAt: Date, _digest: string, _author: ImbricateAuthor): PromiseOr<void>;
     refreshUpdatedAt(_updatedAt: Date): PromiseOr<void>;
     refreshDigest(_digest: string): PromiseOr<void>;
     addHistoryRecord(_record: ImbricatePageHistoryRecord): PromiseOr<void>;

package/page/base.js

@@ -32,7 +32,7 @@ class ImbricatePageBase {
     writeAttribute(_key, _value) {
         throw not_implemented_1.ImbricateNotImplemented.create("WriteAttribute", definition_2.IMBRICATE_PAGE_CAPABILITY_KEY.WRITE_ATTRIBUTE);
     }
-    refreshUpdateMetadata(_updatedAt, _digest) {
+    refreshUpdateMetadata(_updatedAt, _digest, _author) {
         throw not_implemented_1.ImbricateNotImplemented.create("RefreshUpdateMetadata", definition_2.IMBRICATE_PAGE_CAPABILITY_KEY.UPDATE_METADATA);
     }
     refreshUpdatedAt(_updatedAt) {

package/page/interface.d.ts

@@ -3,6 +3,7 @@
  * @namespace Page
  * @description Interface
  */
+import { ImbricateAuthor } from "../author/definition";
 import { PromiseOr } from "../definition/promise";
 import { ImbricatePageVariant } from "../page-variant/definition";
 import { ImbricatePageAttributes, ImbricatePageCapability, ImbricatePageHistoryRecord } from "./definition";
@@ -27,8 +28,9 @@ export interface IImbricatePage {
      *
      * @param updatedAt Updated At
      * @param digest Content Digest
+     * @param author Author
      */
-    refreshUpdateMetadata(updatedAt: Date, digest: string): PromiseOr<void>;
+    refreshUpdateMetadata(updatedAt: Date, digest: string, author: ImbricateAuthor): PromiseOr<void>;
     /**
      * Refresh Updated At
      * Prefer `refreshUpdateMetadata` in most cases

package/page-variant/extension.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @author WMXPY
+ * @namespace PageVariant
+ * @description Extension
+ */
+import { IMBRICATE_PAGE_VARIANT_LANGUAGE } from "./definition";
+export declare const getImbricateScriptLanguageExtension: (language: IMBRICATE_PAGE_VARIANT_LANGUAGE, withDot?: boolean) => string;

package/page-variant/extension.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace PageVariant
+ * @description Extension
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getImbricateScriptLanguageExtension = void 0;
+const definition_1 = require("./definition");
+const fixExtension = (extension, withDot) => {
+    if (withDot) {
+        return `.${extension}`;
+    }
+    return extension;
+};
+const getImbricateScriptLanguageExtension = (language, withDot = true) => {
+    switch (language) {
+        case definition_1.IMBRICATE_PAGE_VARIANT_LANGUAGE.TEXT: return fixExtension("txt", withDot);
+        case definition_1.IMBRICATE_PAGE_VARIANT_LANGUAGE.MARKDOWN: return fixExtension("md", withDot);
+        case definition_1.IMBRICATE_PAGE_VARIANT_LANGUAGE.LATEX: return fixExtension("tex", withDot);
+    }
+    return fixExtension("unknown", withDot);
+};
+exports.getImbricateScriptLanguageExtension = getImbricateScriptLanguageExtension;

package/script/base.d.ts

@@ -3,6 +3,7 @@
  * @namespace Script
  * @description Base
  */
+import { ImbricateAuthor } from "../author/definition";
 import { ImbricateCapabilityBuilder } from "../capability/builder";
 import { ImbricateCapability } from "../capability/definition";
 import type { PromiseOr } from "../definition/promise";
@@ -26,7 +27,7 @@ export declare abstract class ImbricateScriptBase implements IImbricateScript {
     writeScript(_script: string): PromiseOr<void>;
     readAttributes(): PromiseOr<ImbricateScriptAttributes>;
     writeAttribute(_key: string, _value: string): PromiseOr<void>;
-    refreshUpdateMetadata(_updatedAt: Date, _digest: string): PromiseOr<void>;
+    refreshUpdateMetadata(_updatedAt: Date, _digest: string, _author: ImbricateAuthor): PromiseOr<void>;
     refreshUpdatedAt(_updatedAt: Date): PromiseOr<void>;
     refreshDigest(_digest: string): PromiseOr<void>;
     addHistoryRecord(_record: ImbricateScriptHistoryRecord): PromiseOr<void>;

package/script/base.js

@@ -32,7 +32,7 @@ class ImbricateScriptBase {
     writeAttribute(_key, _value) {
         throw not_implemented_1.ImbricateNotImplemented.create("WriteAttribute", definition_2.IMBRICATE_SCRIPT_CAPABILITY_KEY.WRITE_ATTRIBUTE);
     }
-    refreshUpdateMetadata(_updatedAt, _digest) {
+    refreshUpdateMetadata(_updatedAt, _digest, _author) {
         throw not_implemented_1.ImbricateNotImplemented.create("RefreshUpdateMetadata", definition_2.IMBRICATE_SCRIPT_CAPABILITY_KEY.UPDATE_METADATA);
     }
     refreshUpdatedAt(_updatedAt) {

package/script/interface.d.ts

@@ -3,6 +3,7 @@
  * @namespace Script
  * @description Interface
  */
+import { ImbricateAuthor } from "../author/definition";
 import { PromiseOr } from "../definition/promise";
 import { ImbricateScriptVariant } from "../script-variant/definition";
 import { ImbricateScriptAttributes, ImbricateScriptCapability, ImbricateScriptHistoryRecord } from "./definition";
@@ -26,8 +27,9 @@ export interface IImbricateScript {
      *
      * @param updatedAt Updated At
      * @param digest Content Digest
+     * @param author Author
      */
-    refreshUpdateMetadata(updatedAt: Date, digest: string): PromiseOr<void>;
+    refreshUpdateMetadata(updatedAt: Date, digest: string, author: ImbricateAuthor): PromiseOr<void>;
     /**
      * Refresh Updated At
      * Prefer `refreshUpdateMetadata` in most cases

package/script-manager/base.d.ts

@@ -3,6 +3,7 @@
  * @namespace ScriptManager
  * @description Base
  */
+import { ImbricateAuthor } from "../author/definition";
 import { ImbricateCapabilityBuilder } from "../capability/builder";
 import { ImbricateCapability } from "../capability/definition";
 import type { PromiseOr } from "../definition/promise";
@@ -17,7 +18,7 @@ export declare abstract class ImbricateScriptManagerBase implements IImbricateSc
     static allAllowCapability(): ImbricateScriptManagerCapability;
     static allDenyCapability(): ImbricateScriptManagerCapability;
     abstract readonly capabilities: ImbricateScriptManagerCapability;
-    createScript(_scriptName: string, _variant: ImbricateScriptVariant, _initialScript: string, _description?: string): PromiseOr<IImbricateScript>;
+    createScript(_scriptName: string, _variant: ImbricateScriptVariant, _author: ImbricateAuthor, _initialScript: string, _description?: string): PromiseOr<IImbricateScript>;
     putScript(_scriptMetadata: ImbricateScriptMetadata, _script: string): PromiseOr<IImbricateScript>;
     renameScript(_identifier: string, _newScriptName: string): PromiseOr<void>;
     deleteScript(_identifier: string): PromiseOr<void>;

package/script-manager/base.js

@@ -20,7 +20,7 @@ class ImbricateScriptManagerBase {
     static allDenyCapability() {
         return this.buildCapability((0, definition_1.createDenyImbricateCapability)()).build();
     }
-    createScript(_scriptName, _variant, _initialScript, _description) {
+    createScript(_scriptName, _variant, _author, _initialScript, _description) {
         throw not_implemented_1.ImbricateNotImplemented.create("CreateScript", definition_2.IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY.CREATE_SCRIPT);
     }
     putScript(_scriptMetadata, _script) {

package/script-manager/interface.d.ts

@@ -3,6 +3,7 @@
  * @namespace ScriptManager
  * @description Interface
  */
+import { ImbricateAuthor } from "../author/definition";
 import { PromiseOr } from "../definition/promise";
 import { ImbricateScriptQuery, ImbricateScriptQueryConfig, ImbricateSearchScriptConfig } from "../query/script";
 import { ImbricateScriptVariant } from "../script-variant/definition";
@@ -18,12 +19,14 @@ export interface IImbricateScriptManager {
      * Create a script
      *
      * @param scriptName Script name
+     * @param variant Script variant
+     * @param author Author
      * @param initialScript Initial script content
      * @param description Script description
      *
      * @returns Created script
      */
-    createScript(scriptName: string, variant: ImbricateScriptVariant, initialScript: string, description?: string): PromiseOr<IImbricateScript>;
+    createScript(scriptName: string, variant: ImbricateScriptVariant, author: ImbricateAuthor, initialScript: string, description?: string): PromiseOr<IImbricateScript>;
     /**
      * Put a script
      *