@imbricate/core 3.0.4 → 3.1.1

package/document/property.d.ts

@@ -15,11 +15,17 @@ export declare enum IMBRICATE_PROPERTY_TYPE {
 }
 /**
  * Document properties
+ *
+ * Key - Property key, which should match schema properties unique identifier
+ * Value - Property value, which should match schema properties type
  */
 export type DocumentProperties = Record<DocumentPropertyKey, DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>>;
+/**
+ * Document property key, which should match schema properties unique identifier
+ */
 export type DocumentPropertyKey = string;
 export type DocumentPropertyValue<T extends IMBRICATE_PROPERTY_TYPE> = {
-    readonly type: IMBRICATE_PROPERTY_TYPE;
+    readonly type: T;
     readonly value: DocumentPropertyValueObject<T>;
 };
 export type DocumentPropertyValueObject<T extends IMBRICATE_PROPERTY_TYPE> = T extends IMBRICATE_PROPERTY_TYPE.STRING ? string : T extends IMBRICATE_PROPERTY_TYPE.MARKDOWN ? string : never;

package/document/validate.js

@@ -23,7 +23,7 @@ const validateImbricateProperties = (properties, schema) => {
     const keys = Object.keys(properties);
     for (const key of keys) {
         const property = schema.properties.find((each) => {
-            return each.propertyName === key;
+            return each.propertyIdentifier === key;
         });
         if (!property) {
             return `Property ${key} not found in schema`;

package/index.d.ts

@@ -16,7 +16,7 @@ export * from "./document/property/triage-manager";
 export * from "./document/validate";
 export * from "./loader/definition";
 export * from "./loader/origin-loader";
-export * from "./loader/persistance";
+export * from "./loader/persistence";
 export * from "./origin/definition";
 export * from "./origin/interface";
 export * from "./static/interface";

package/index.js

@@ -32,7 +32,7 @@ __exportStar(require("./document/property/triage-manager"), exports);
 __exportStar(require("./document/validate"), exports);
 __exportStar(require("./loader/definition"), exports);
 __exportStar(require("./loader/origin-loader"), exports);
-__exportStar(require("./loader/persistance"), exports);
+__exportStar(require("./loader/persistence"), exports);
 __exportStar(require("./origin/definition"), exports);
 __exportStar(require("./origin/interface"), exports);
 __exportStar(require("./static/interface"), exports);

package/loader/origin-loader.d.ts

@@ -4,26 +4,26 @@
  * @description Origin Loader
  */
 import { IImbricateOrigin } from "../origin/interface";
-import { ImbricateOriginPersistance, ImbricateOriginPersistanceOrigin } from "./persistance";
+import { ImbricateOriginPersistence, ImbricateOriginPersistenceOrigin } from "./persistence";
 /**
- * Load imbricate origin from persistance origin
- *  This function will load the origin from the persistance origin
+ * Load imbricate origin from persistence origin
+ *  This function will load the origin from the persistence origin
  *  and initialize the origin with the payloads
  *
- * @param origin origin to persistance to load
+ * @param origin origin to persistence to load
  *
  * @returns a promise of the loaded origin
  *  if the origin is not found, return null
  */
-export declare const loadImbricateOriginFromPersistanceOrigin: (origin: ImbricateOriginPersistanceOrigin) => Promise<IImbricateOrigin | null>;
+export declare const loadImbricateOriginFromPersistenceOrigin: (origin: ImbricateOriginPersistenceOrigin) => Promise<IImbricateOrigin | null>;
 /**
- * Load imbricate origins from persistance
- *  This function will load all origins from the persistance
+ * Load imbricate origins from persistence
+ *  This function will load all origins from the persistence
  *  and initialize the origins with the payloads
  *  If the origin is not found, it will be ignored
  *
- * @param persistance persistance to load origins
+ * @param persistence persistence to load origins
  *
  * @returns a promise of the loaded origins, if the origin is not found, return empty array
  */
-export declare const loadImbricateOriginsFromPersistance: (persistance: ImbricateOriginPersistance) => Promise<IImbricateOrigin[]>;
+export declare const loadImbricateOriginsFromPersistence: (persistence: ImbricateOriginPersistence) => Promise<IImbricateOrigin[]>;

package/loader/origin-loader.js

@@ -37,21 +37,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadImbricateOriginsFromPersistance = exports.loadImbricateOriginFromPersistanceOrigin = void 0;
-const persistance_1 = require("./persistance");
+exports.loadImbricateOriginsFromPersistence = exports.loadImbricateOriginFromPersistenceOrigin = void 0;
+const persistence_1 = require("./persistence");
 /**
- * Load imbricate origin from persistance origin
- *  This function will load the origin from the persistance origin
+ * Load imbricate origin from persistence origin
+ *  This function will load the origin from the persistence origin
  *  and initialize the origin with the payloads
  *
- * @param origin origin to persistance to load
+ * @param origin origin to persistence to load
  *
  * @returns a promise of the loaded origin
  *  if the origin is not found, return null
  */
-const loadImbricateOriginFromPersistanceOrigin = (origin) => __awaiter(void 0, void 0, void 0, function* () {
+const loadImbricateOriginFromPersistenceOrigin = (origin) => __awaiter(void 0, void 0, void 0, function* () {
     switch (origin.originLoadType) {
-        case persistance_1.IMBRICATE_ORIGIN_LOAD_TYPE.NPM_PACKAGE: {
+        case persistence_1.IMBRICATE_ORIGIN_LOAD_TYPE.NPM_PACKAGE: {
             const originPackage = yield Promise.resolve(`${origin.originLoadValue}`).then(s => __importStar(require(s)));
             if (typeof originPackage.default === "function") {
                 const initialized = originPackage.default.call(null, origin.originPayloads);
@@ -59,7 +59,7 @@ const loadImbricateOriginFromPersistanceOrigin = (origin) => __awaiter(void 0, v
             }
             break;
         }
-        case persistance_1.IMBRICATE_ORIGIN_LOAD_TYPE.FILE_SYSTEM: {
+        case persistence_1.IMBRICATE_ORIGIN_LOAD_TYPE.FILE_SYSTEM: {
             const originPackage = yield Promise.resolve(`${origin.originLoadValue}`).then(s => __importStar(require(s)));
             if (typeof originPackage.default === "function") {
                 const initialized = originPackage.default.call(null, origin.originPayloads);
@@ -70,25 +70,25 @@ const loadImbricateOriginFromPersistanceOrigin = (origin) => __awaiter(void 0, v
     }
     return null;
 });
-exports.loadImbricateOriginFromPersistanceOrigin = loadImbricateOriginFromPersistanceOrigin;
+exports.loadImbricateOriginFromPersistenceOrigin = loadImbricateOriginFromPersistenceOrigin;
 /**
- * Load imbricate origins from persistance
- *  This function will load all origins from the persistance
+ * Load imbricate origins from persistence
+ *  This function will load all origins from the persistence
  *  and initialize the origins with the payloads
  *  If the origin is not found, it will be ignored
  *
- * @param persistance persistance to load origins
+ * @param persistence persistence to load origins
  *
  * @returns a promise of the loaded origins, if the origin is not found, return empty array
  */
-const loadImbricateOriginsFromPersistance = (persistance) => __awaiter(void 0, void 0, void 0, function* () {
+const loadImbricateOriginsFromPersistence = (persistence) => __awaiter(void 0, void 0, void 0, function* () {
     const origins = [];
-    for (const origin of persistance.origins) {
-        const originInstance = yield (0, exports.loadImbricateOriginFromPersistanceOrigin)(origin);
+    for (const origin of persistence.origins) {
+        const originInstance = yield (0, exports.loadImbricateOriginFromPersistenceOrigin)(origin);
         if (originInstance) {
             origins.push(originInstance);
         }
     }
     return origins;
 });
-exports.loadImbricateOriginsFromPersistance = loadImbricateOriginsFromPersistance;
+exports.loadImbricateOriginsFromPersistence = loadImbricateOriginsFromPersistence;

package/loader/{persistance.d.ts → persistence.d.ts}

@@ -1,7 +1,7 @@
 /**
  * @author WMXPY
  * @namespace Loader
- * @description Persistance
+ * @description Persistence
  */
 import { OriginPayload } from "../origin/definition";
 /**
@@ -14,12 +14,12 @@ export declare enum IMBRICATE_ORIGIN_LOAD_TYPE {
     NPM_PACKAGE = "NPM_PACKAGE",
     FILE_SYSTEM = "FILE_SYSTEM"
 }
-export type ImbricateOriginPersistanceOrigin = {
+export type ImbricateOriginPersistenceOrigin = {
     readonly originLoadType: IMBRICATE_ORIGIN_LOAD_TYPE;
     readonly originLoadValue: string;
     readonly originName: string;
     readonly originPayloads: OriginPayload;
 };
-export type ImbricateOriginPersistance = {
-    readonly origins: ImbricateOriginPersistanceOrigin[];
+export type ImbricateOriginPersistence = {
+    readonly origins: ImbricateOriginPersistenceOrigin[];
 };

package/loader/{persistance.js → persistence.js}

@@ -2,7 +2,7 @@
 /**
  * @author WMXPY
  * @namespace Loader
- * @description Persistance
+ * @description Persistence
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IMBRICATE_ORIGIN_LOAD_TYPE = void 0;

package/package.json

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