@imbricate/core 3.19.0 → 3.20.0

package/common/action.d.ts

@@ -14,7 +14,8 @@ export type ImbricateOriginActionParameterType = {
 };
 export type ImbricateOriginActionParameter = {
     readonly parameterKey: string;
-    readonly getParameterName: (locale: IETF_LOCALE) => string;
+    readonly parameterName: Record<IETF_LOCALE, string>;
+    readonly parameterDescription: Record<IETF_LOCALE, string>;
     readonly parameterType: ImbricateOriginActionParameterType;
 };
 export declare enum IMBRICATE_ORIGIN_ACTION_APPEARANCE {
@@ -26,7 +27,8 @@ export declare enum IMBRICATE_ORIGIN_ACTION_APPEARANCE {
 }
 export type ImbricateOriginAction = {
     readonly actionIdentifier: string;
-    readonly getActionName: (locale: IETF_LOCALE) => string;
+    readonly actionName: Record<IETF_LOCALE, string>;
+    readonly actionDescription: Record<IETF_LOCALE, string>;
     readonly parameters: ImbricateOriginActionParameter[];
     readonly appearance?: IMBRICATE_ORIGIN_ACTION_APPEARANCE;
     readonly disabled?: boolean;

package/database/base-class/essential-readonly.d.ts

@@ -3,7 +3,7 @@
  * @namespace Database
  * @description Essential Readonly
  */
-import { DocumentProperties } from "../../document/property";
+import { ImbricatePropertyRecord } from "../../property/map";
 import { ImbricateDatabaseAuditOptions } from "../definition";
 import { IMBRICATE_DATABASE_FEATURE } from "../feature";
 import { IImbricateDatabase } from "../interface";
@@ -13,6 +13,6 @@ import { ImbricateDatabaseEssentialBase } from "./essential";
 export declare abstract class ImbricateDatabaseEssentialReadOnlyBase extends ImbricateDatabaseEssentialBase implements IImbricateDatabase {
     readonly supportedFeatures: IMBRICATE_DATABASE_FEATURE[];
     putSchema(_schema: ImbricateDatabaseSchema, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabasePutSchemaOutcome>;
-    createDocument(_properties: DocumentProperties, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
+    createDocument(_properties: ImbricatePropertyRecord, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
     removeDocument(_uniqueIdentifier: string, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseRemoveDocumentOutcome>;
 }

package/database/base-class/full-feature-readonly.d.ts

@@ -3,7 +3,7 @@
  * @namespace Database_BaseClass
  * @description Full Feature Readonly
  */
-import { DocumentProperties } from "../../document/property";
+import { ImbricatePropertyRecord } from "../../property/map";
 import { DatabaseAnnotationValue, DatabaseEditRecord, ImbricateDatabaseAuditOptions } from "../definition";
 import { IMBRICATE_DATABASE_FEATURE } from "../feature";
 import { IImbricateDatabase } from "../interface";
@@ -13,7 +13,7 @@ import { ImbricateDatabaseFullFeatureBase } from "./full-feature";
 export declare abstract class ImbricateDatabaseFullFeatureReadOnlyBase extends ImbricateDatabaseFullFeatureBase implements IImbricateDatabase {
     readonly supportedFeatures: IMBRICATE_DATABASE_FEATURE[];
     putSchema(_schema: ImbricateDatabaseSchema, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabasePutSchemaOutcome>;
-    createDocument(_properties: DocumentProperties, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
+    createDocument(_properties: ImbricatePropertyRecord, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
     removeDocument(_uniqueIdentifier: string, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseRemoveDocumentOutcome>;
     putAnnotation(_namespace: string, _identifier: string, _value: DatabaseAnnotationValue, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabasePutAnnotationOutcome>;
     deleteAnnotation(_namespace: string, _identifier: string, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseDeleteAnnotationOutcome>;

package/database/base-class/full-feature-with-action.d.ts

@@ -4,7 +4,7 @@
  * @description Full Feature With Action
  */
 import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
-import { DocumentProperties } from "../../document/property";
+import { ImbricatePropertyRecord } from "../../property/map";
 import { DatabaseAnnotationValue, DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "../definition";
 import { IMBRICATE_DATABASE_FEATURE } from "../feature";
 import { IImbricateDatabase } from "../interface";
@@ -18,7 +18,7 @@ export declare abstract class ImbricateDatabaseFullFeatureWithActionBase impleme
     abstract readonly annotations: DatabaseAnnotations;
     readonly supportedFeatures: IMBRICATE_DATABASE_FEATURE[];
     abstract putSchema(schema: ImbricateDatabaseSchema, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabasePutSchemaOutcome>;
-    abstract createDocument(properties: DocumentProperties, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
+    abstract createDocument(properties: ImbricatePropertyRecord, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
     abstract getDocument(uniqueIdentifier: string): PromiseLike<ImbricateDatabaseGetDocumentOutcome>;
     abstract queryDocuments(query: ImbricateDocumentQuery): PromiseLike<ImbricateDatabaseQueryDocumentsOutcome>;
     abstract countDocuments(query: ImbricateDocumentQuery): PromiseLike<ImbricateDatabaseCountDocumentsOutcome>;

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

@@ -4,7 +4,7 @@
  * @description Full Feature
  */
 import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
-import { DocumentProperties } from "../../document/property";
+import { ImbricatePropertyRecord } from "../../property/map";
 import { DatabaseAnnotationValue, DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "../definition";
 import { IMBRICATE_DATABASE_FEATURE } from "../feature";
 import { IImbricateDatabase } from "../interface";
@@ -19,7 +19,7 @@ export declare abstract class ImbricateDatabaseFullFeatureBase extends Imbricate
     abstract readonly annotations: DatabaseAnnotations;
     readonly supportedFeatures: IMBRICATE_DATABASE_FEATURE[];
     abstract putSchema(schema: ImbricateDatabaseSchema, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabasePutSchemaOutcome>;
-    abstract createDocument(properties: DocumentProperties, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
+    abstract createDocument(properties: ImbricatePropertyRecord, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
     abstract getDocument(uniqueIdentifier: string): PromiseLike<ImbricateDatabaseGetDocumentOutcome>;
     abstract queryDocuments(query: ImbricateDocumentQuery): PromiseLike<ImbricateDatabaseQueryDocumentsOutcome>;
     abstract countDocuments(query: ImbricateDocumentQuery): PromiseLike<ImbricateDatabaseCountDocumentsOutcome>;

package/database/interface.d.ts

@@ -4,7 +4,7 @@
  * @description Interface
  */
 import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../common/action";
-import { DocumentProperties } from "../document/property";
+import { ImbricatePropertyRecord } from "../property/map";
 import { DatabaseAnnotationValue, DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "./definition";
 import { IMBRICATE_DATABASE_FEATURE } from "./feature";
 import { ImbricateDatabaseAddEditRecordsOutcome, ImbricateDatabaseCountDocumentsOutcome, ImbricateDatabaseCreateDocumentOutcome, ImbricateDatabaseDeleteAnnotationOutcome, ImbricateDatabaseGetDocumentOutcome, ImbricateDatabaseGetEditRecordsOutcome, ImbricateDatabasePutAnnotationOutcome, ImbricateDatabasePutSchemaOutcome, ImbricateDatabaseQueryDocumentsOutcome, ImbricateDatabaseRemoveDocumentOutcome } from "./outcome";
@@ -59,7 +59,7 @@ export interface IImbricateDatabase {
      * @returns a promise of the outcome of the create document
      *  Symbol: S_CreateDocument_IdentifierDuplicated - if the identifier is duplicated
      */
-    createDocument(properties: DocumentProperties, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
+    createDocument(properties: ImbricatePropertyRecord, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
     /**
      * Get one document from the database
      *

package/database/schema.d.ts

@@ -3,7 +3,7 @@
  * @namespace Database
  * @description Schema
  */
-import { IMBRICATE_PROPERTY_TYPE } from "../document/property";
+import { IMBRICATE_PROPERTY_TYPE } from "../property/type";
 export type ImbricateDatabaseSchemaProperty<T extends IMBRICATE_PROPERTY_TYPE> = {
     readonly propertyIdentifier: string;
 } & ImbricateDatabaseSchemaPropertyForCreation<T>;

package/database/schema.js

@@ -6,7 +6,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateImbricateSchema = exports.validateImbricateSchemaProperty = void 0;
-const property_1 = require("../document/property");
+const type_1 = require("../property/type");
 /**
  * Validate a schema property
  *
@@ -22,11 +22,11 @@ const validateImbricateSchemaProperty = (property) => {
     if (typeof property.propertyName !== "string") {
         return "Property name must be a string";
     }
-    if (!Object.values(property_1.IMBRICATE_PROPERTY_TYPE).includes(property.propertyType)) {
+    if (!Object.values(type_1.IMBRICATE_PROPERTY_TYPE).includes(property.propertyType)) {
         return "Property type must be a valid type";
     }
     switch (property.propertyType) {
-        case property_1.IMBRICATE_PROPERTY_TYPE.REFERENCE: {
+        case type_1.IMBRICATE_PROPERTY_TYPE.REFERENCE: {
             if (typeof property.propertyOptions !== "object") {
                 return "Property options must be an object";
             }

package/document/base-class/essential-readonly.d.ts

@@ -3,15 +3,15 @@
  * @namespace Document
  * @description Essential Readonly
  */
+import { ImbricatePropertyRecord } from "../../property/map";
 import { DocumentAnnotations, ImbricateDocumentAuditOptions } from "../definition";
 import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
 import { IImbricateDocument } from "../interface";
 import { ImbricateDocumentPutPropertyOutcome } from "../outcome";
-import { DocumentProperties } from "../property";
 import { ImbricateDocumentEssentialBase } from "./essential";
 export declare abstract class ImbricateDocumentEssentialReadonlyBase extends ImbricateDocumentEssentialBase implements IImbricateDocument {
     readonly annotations: DocumentAnnotations;
     readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
-    mergeProperty(_properties: DocumentProperties, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
-    replaceProperties(_properties: DocumentProperties, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
+    mergeProperty(_properties: ImbricatePropertyRecord, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
+    replaceProperties(_properties: ImbricatePropertyRecord, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
 }

package/document/base-class/full-feature-readonly.d.ts

@@ -3,16 +3,16 @@
  * @namespace Document
  * @description Full Feature Readonly
  */
+import { ImbricatePropertyRecord } from "../../property/map";
 import { DocumentAnnotationValue, DocumentEditRecord, ImbricateDocumentAuditOptions } from "../definition";
 import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
 import { IImbricateDocument } from "../interface";
 import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "../outcome";
-import { DocumentProperties } from "../property";
 import { ImbricateDocumentFullFeatureBase } from "./full-feature";
 export declare abstract class ImbricateDocumentFullFeatureReadonlyBase extends ImbricateDocumentFullFeatureBase implements IImbricateDocument {
     readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
-    mergeProperties(_properties: DocumentProperties, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
-    replaceProperties(_properties: DocumentProperties, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
+    mergeProperties(_properties: ImbricatePropertyRecord, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
+    replaceProperties(_properties: ImbricatePropertyRecord, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
     putAnnotation(_namespace: string, _identifier: string, _value: DocumentAnnotationValue, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutAnnotationOutcome>;
     deleteAnnotation(_namespace: string, _identifier: string, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentDeleteAnnotationOutcome>;
     addEditRecords(_records: DocumentEditRecord[]): Promise<ImbricateDocumentAddEditRecordsOutcome>;

package/document/base-class/full-feature-with-action.d.ts

@@ -4,19 +4,21 @@
  * @description Full Feature
  */
 import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
+import { ImbricatePropertyKey } from "../../property/definition";
+import { ImbricatePropertyRecord } from "../../property/map";
 import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "../definition";
 import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
 import { IImbricateDocument } from "../interface";
-import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentGetEditRecordsOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "../outcome";
-import { DocumentProperties } from "../property";
+import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentGetEditRecordsOutcome, ImbricateDocumentGetPropertiesOutcome, ImbricateDocumentGetPropertyOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "../outcome";
 export declare abstract class ImbricateDocumentFullFeatureWithActionBase implements IImbricateDocument {
     abstract readonly uniqueIdentifier: string;
     abstract readonly documentVersion: string;
-    abstract readonly properties: DocumentProperties;
     abstract readonly annotations: DocumentAnnotations;
     readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
-    abstract mergeProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
-    abstract replaceProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
+    abstract getProperties(): ImbricateDocumentGetPropertiesOutcome;
+    abstract getProperty(key: ImbricatePropertyKey): ImbricateDocumentGetPropertyOutcome;
+    abstract mergeProperties(properties: ImbricatePropertyRecord, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
+    abstract replaceProperties(properties: ImbricatePropertyRecord, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
     abstract putAnnotation(namespace: string, identifier: string, value: DocumentAnnotationValue, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutAnnotationOutcome>;
     abstract deleteAnnotation(namespace: string, identifier: string, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentDeleteAnnotationOutcome>;
     abstract addEditRecords(records: DocumentEditRecord[]): Promise<ImbricateDocumentAddEditRecordsOutcome>;

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

@@ -4,24 +4,15 @@
  * @description Full Feature
  */
 import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
-import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "../definition";
+import { DocumentAnnotations } from "../definition";
 import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
 import { IImbricateDocument } from "../interface";
-import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentGetEditRecordsOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "../outcome";
-import { DocumentProperties } from "../property";
 import { ImbricateDocumentFullFeatureWithActionBase } from "./full-feature-with-action";
 export declare abstract class ImbricateDocumentFullFeatureBase extends ImbricateDocumentFullFeatureWithActionBase implements IImbricateDocument {
     abstract readonly uniqueIdentifier: string;
     abstract readonly documentVersion: string;
-    abstract readonly properties: DocumentProperties;
     abstract readonly annotations: DocumentAnnotations;
     readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
-    abstract mergeProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
-    abstract replaceProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
-    abstract putAnnotation(namespace: string, identifier: string, value: DocumentAnnotationValue, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutAnnotationOutcome>;
-    abstract deleteAnnotation(namespace: string, identifier: string, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentDeleteAnnotationOutcome>;
-    abstract addEditRecords(records: DocumentEditRecord[]): Promise<ImbricateDocumentAddEditRecordsOutcome>;
-    abstract getEditRecords(): Promise<ImbricateDocumentGetEditRecordsOutcome>;
     queryOriginActions(_query: ImbricateCommonQueryOriginActionsQuery): PromiseLike<ImbricateCommonQueryOriginActionsOutcome>;
     executeOriginAction(_input: ImbricateOriginActionInput): Promise<ImbricateOriginActionOutcome>;
 }

package/document/definition.d.ts

@@ -4,7 +4,9 @@
  * @description Definition
  */
 import { ImbricateAuthor } from "../author/definition";
-import { DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "./property";
+import { ImbricatePropertyKey } from "../property/definition";
+import { IImbricateProperty } from "../property/interface";
+import { IMBRICATE_PROPERTY_TYPE } from "../property/type";
 /**
  * Edit record type of the document
  */
@@ -15,8 +17,8 @@ export declare enum IMBRICATE_DOCUMENT_EDIT_TYPE {
     RESOLVE_CONFLICT = "RESOLVE_CONFLICT"
 }
 export type DocumentEditOperationValuePutProperty = {
-    readonly key: DocumentPropertyKey;
-    readonly value: DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>;
+    readonly key: ImbricatePropertyKey;
+    readonly value: IImbricateProperty<IMBRICATE_PROPERTY_TYPE>;
 };
 export type DocumentEditOperationPutAnnotation = {
     readonly annotationNamespace: string;

package/document/export.d.ts

@@ -14,10 +14,8 @@ export * from "./definition";
 export * from "./feature";
 export * from "./interface";
 export * from "./outcome";
-export * from "./property";
 export * from "./property/default-value";
 export * from "./property/definition";
 export * from "./property/primary";
 export * from "./property/triage";
 export * from "./property/triage-manager";
-export * from "./validate";

package/document/export.js

@@ -30,10 +30,8 @@ __exportStar(require("./definition"), exports);
 __exportStar(require("./feature"), exports);
 __exportStar(require("./interface"), exports);
 __exportStar(require("./outcome"), exports);
-__exportStar(require("./property"), exports);
 __exportStar(require("./property/default-value"), exports);
 __exportStar(require("./property/definition"), exports);
 __exportStar(require("./property/primary"), exports);
 __exportStar(require("./property/triage"), exports);
 __exportStar(require("./property/triage-manager"), exports);
-__exportStar(require("./validate"), exports);

package/document/interface.d.ts

@@ -4,10 +4,11 @@
  * @description Interface
  */
 import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../common/action";
+import { ImbricatePropertyKey } from "../property/definition";
+import { ImbricatePropertyRecord } from "../property/map";
 import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "./definition";
 import { IMBRICATE_DOCUMENT_FEATURE } from "./feature";
-import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentGetEditRecordsOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "./outcome";
-import { DocumentProperties } from "./property";
+import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentGetEditRecordsOutcome, ImbricateDocumentGetPropertiesOutcome, ImbricateDocumentGetPropertyOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "./outcome";
 export interface IImbricateDocument {
     /**
      * Unique identifier of the database
@@ -17,10 +18,6 @@ export interface IImbricateDocument {
      * Version of the document draft
      */
     readonly documentVersion: string;
-    /**
-     * Properties of the document
-     */
-    readonly properties: DocumentProperties;
     /**
      * Annotations of the database
      */
@@ -29,6 +26,18 @@ export interface IImbricateDocument {
      * Supported features of the document
      */
     readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
+    /**
+     * Get properties of the document
+     */
+    getProperties(): ImbricateDocumentGetPropertiesOutcome;
+    /**
+     * Get a property of the document
+     *
+     * @param propertyKey the key of the property
+     *
+     * @returns the property of the document
+     */
+    getProperty(propertyKey: ImbricatePropertyKey): ImbricateDocumentGetPropertyOutcome;
     /**
      * Merge a property to the document
      *
@@ -40,7 +49,7 @@ export interface IImbricateDocument {
      * @returns a promise of the outcome of the put property
      *  Symbol: S_Document_PutProperty_InvalidKey - if the key is invalid
      */
-    mergeProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
+    mergeProperties(properties: ImbricatePropertyRecord, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
     /**
      * Replace all properties of the document
      *
@@ -52,7 +61,7 @@ export interface IImbricateDocument {
      * @returns a promise of the outcome of the put properties
      *  Symbol: S_Document_PutProperty_InvalidKey - if the key is invalid
      */
-    replaceProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
+    replaceProperties(properties: ImbricatePropertyRecord, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
     /**
      * Put annotation to the document, optional
      *

package/document/outcome.d.ts

@@ -4,7 +4,25 @@
  * @description Outcome
  */
 import { CommonOutcomeSymbol } from "../common/outcome";
+import { IImbricateProperty } from "../property/interface";
+import { ImbricatePropertyRecord } from "../property/map";
+import { IMBRICATE_PROPERTY_TYPE } from "../property/type";
 import { DocumentEditRecord } from "./definition";
+export declare const S_Document_GetProperties_Unknown: unique symbol;
+export type ImbricateDocumentGetPropertiesOutcomeSymbol = typeof S_Document_GetProperties_Unknown;
+export declare const ImbricateDocumentGetPropertiesOutcomeSymbolList: ImbricateDocumentGetPropertiesOutcomeSymbol[];
+export declare const rebuildImbricateDocumentGetPropertiesSymbol: (symbolDescription: string) => CommonOutcomeSymbol | typeof S_Document_GetProperties_Unknown;
+export type ImbricateDocumentGetPropertiesOutcome = {
+    readonly properties: ImbricatePropertyRecord;
+} | CommonOutcomeSymbol | ImbricateDocumentGetPropertiesOutcomeSymbol;
+export declare const S_Document_GetProperty_NotFound: unique symbol;
+export declare const S_Document_GetProperty_Unknown: unique symbol;
+export type ImbricateDocumentGetPropertyOutcomeSymbol = typeof S_Document_GetProperty_NotFound | typeof S_Document_GetProperty_Unknown;
+export declare const ImbricateDocumentGetPropertyOutcomeSymbolList: ImbricateDocumentGetPropertyOutcomeSymbol[];
+export declare const rebuildImbricateDocumentGetPropertySymbol: (symbolDescription: string) => CommonOutcomeSymbol | ImbricateDocumentGetPropertyOutcomeSymbol;
+export type ImbricateDocumentGetPropertyOutcome = {
+    readonly property: IImbricateProperty<IMBRICATE_PROPERTY_TYPE>;
+} | CommonOutcomeSymbol | ImbricateDocumentGetPropertyOutcomeSymbol;
 export declare const S_Document_PutProperty_InvalidKey: unique symbol;
 export declare const S_Document_PutProperty_InvalidValue: unique symbol;
 export declare const S_Document_PutProperty_Unknown: unique symbol;

package/document/outcome.js

@@ -5,8 +5,22 @@
  * @description Outcome
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rebuildImbricateDocumentGetEditRecordsSymbol = exports.ImbricateDocumentGetEditRecordsOutcomeSymbolList = exports.S_Document_GetEditRecords_Unknown = exports.S_Document_GetEditRecords_NotFound = exports.rebuildImbricateDocumentAddEditRecordsSymbol = exports.ImbricateDocumentAddEditRecordsOutcomeSymbolList = exports.S_Document_AddEditRecords_Unknown = exports.S_Document_AddEditRecords_InvalidRecord = exports.rebuildImbricateDocumentDeleteAnnotationSymbol = exports.ImbricateDocumentDeleteAnnotationOutcomeSymbolList = exports.S_Document_DeleteAnnotation_Unknown = exports.S_Document_DeleteAnnotation_NotFound = exports.rebuildImbricateDocumentPutAnnotationSymbol = exports.ImbricateDocumentPutAnnotationOutcomeSymbolList = exports.S_Document_PutAnnotation_Unknown = exports.S_Document_PutAnnotation_InvalidIdentifier = exports.S_Document_PutAnnotation_InvalidNamespace = exports.rebuildImbricateDocumentPutPropertySymbol = exports.ImbricateDocumentPutPropertyOutcomeSymbolList = exports.S_Document_PutProperty_Unknown = exports.S_Document_PutProperty_InvalidValue = exports.S_Document_PutProperty_InvalidKey = void 0;
+exports.rebuildImbricateDocumentGetEditRecordsSymbol = exports.ImbricateDocumentGetEditRecordsOutcomeSymbolList = exports.S_Document_GetEditRecords_Unknown = exports.S_Document_GetEditRecords_NotFound = exports.rebuildImbricateDocumentAddEditRecordsSymbol = exports.ImbricateDocumentAddEditRecordsOutcomeSymbolList = exports.S_Document_AddEditRecords_Unknown = exports.S_Document_AddEditRecords_InvalidRecord = exports.rebuildImbricateDocumentDeleteAnnotationSymbol = exports.ImbricateDocumentDeleteAnnotationOutcomeSymbolList = exports.S_Document_DeleteAnnotation_Unknown = exports.S_Document_DeleteAnnotation_NotFound = exports.rebuildImbricateDocumentPutAnnotationSymbol = exports.ImbricateDocumentPutAnnotationOutcomeSymbolList = exports.S_Document_PutAnnotation_Unknown = exports.S_Document_PutAnnotation_InvalidIdentifier = exports.S_Document_PutAnnotation_InvalidNamespace = exports.rebuildImbricateDocumentPutPropertySymbol = exports.ImbricateDocumentPutPropertyOutcomeSymbolList = exports.S_Document_PutProperty_Unknown = exports.S_Document_PutProperty_InvalidValue = exports.S_Document_PutProperty_InvalidKey = exports.rebuildImbricateDocumentGetPropertySymbol = exports.ImbricateDocumentGetPropertyOutcomeSymbolList = exports.S_Document_GetProperty_Unknown = exports.S_Document_GetProperty_NotFound = exports.rebuildImbricateDocumentGetPropertiesSymbol = exports.ImbricateDocumentGetPropertiesOutcomeSymbolList = exports.S_Document_GetProperties_Unknown = void 0;
 const rebuild_symbol_1 = require("../util/rebuild-symbol");
+// Get Properties
+exports.S_Document_GetProperties_Unknown = Symbol("Document_GetProperties_Unknown");
+exports.ImbricateDocumentGetPropertiesOutcomeSymbolList = [
+    exports.S_Document_GetProperties_Unknown,
+];
+exports.rebuildImbricateDocumentGetPropertiesSymbol = (0, rebuild_symbol_1.createRebuildImbricateSymbolFunction)(exports.ImbricateDocumentGetPropertiesOutcomeSymbolList, exports.S_Document_GetProperties_Unknown);
+// Get Property
+exports.S_Document_GetProperty_NotFound = Symbol("Document_GetProperty_NotFound");
+exports.S_Document_GetProperty_Unknown = Symbol("Document_GetProperty_Unknown");
+exports.ImbricateDocumentGetPropertyOutcomeSymbolList = [
+    exports.S_Document_GetProperty_NotFound,
+    exports.S_Document_GetProperty_Unknown,
+];
+exports.rebuildImbricateDocumentGetPropertySymbol = (0, rebuild_symbol_1.createRebuildImbricateSymbolFunction)(exports.ImbricateDocumentGetPropertyOutcomeSymbolList, exports.S_Document_GetProperty_Unknown);
 // Put Property
 exports.S_Document_PutProperty_InvalidKey = Symbol("Document_PutProperty_InvalidKey");
 exports.S_Document_PutProperty_InvalidValue = Symbol("Document_PutProperty_InvalidValue");

package/document/property/default-value.d.ts

@@ -3,5 +3,5 @@
  * @namespace Document_Property
  * @description Default Value
  */
-import { DocumentPropertyValueObject, IMBRICATE_PROPERTY_TYPE } from "../property";
-export declare const getImbricateDefaultValueOfProperty: (type: IMBRICATE_PROPERTY_TYPE) => DocumentPropertyValueObject<IMBRICATE_PROPERTY_TYPE>;
+import { IMBRICATE_PROPERTY_TYPE, ImbricatePropertyValueObject } from "../../property/type";
+export declare const getImbricateDefaultValueOfProperty: (type: IMBRICATE_PROPERTY_TYPE) => ImbricatePropertyValueObject<IMBRICATE_PROPERTY_TYPE>;

package/document/property/default-value.js

@@ -6,19 +6,19 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getImbricateDefaultValueOfProperty = void 0;
-const property_1 = require("../property");
+const type_1 = require("../../property/type");
 // IMBRICATE_PROPERTY_TYPE SWITCH
 const getImbricateDefaultValueOfProperty = (type) => {
     switch (type) {
-        case property_1.IMBRICATE_PROPERTY_TYPE.BOOLEAN: return false;
-        case property_1.IMBRICATE_PROPERTY_TYPE.STRING: return "";
-        case property_1.IMBRICATE_PROPERTY_TYPE.NUMBER: return 0;
-        case property_1.IMBRICATE_PROPERTY_TYPE.MARKDOWN: return "";
-        case property_1.IMBRICATE_PROPERTY_TYPE.JSON: return "";
-        case property_1.IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT: return "";
-        case property_1.IMBRICATE_PROPERTY_TYPE.DATE: return new Date().toISOString();
-        case property_1.IMBRICATE_PROPERTY_TYPE.LABEL: return [];
-        case property_1.IMBRICATE_PROPERTY_TYPE.REFERENCE: return [];
+        case type_1.IMBRICATE_PROPERTY_TYPE.BOOLEAN: return false;
+        case type_1.IMBRICATE_PROPERTY_TYPE.STRING: return "";
+        case type_1.IMBRICATE_PROPERTY_TYPE.NUMBER: return 0;
+        case type_1.IMBRICATE_PROPERTY_TYPE.MARKDOWN: return "";
+        case type_1.IMBRICATE_PROPERTY_TYPE.JSON: return "";
+        case type_1.IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT: return "";
+        case type_1.IMBRICATE_PROPERTY_TYPE.DATE: return new Date().toISOString();
+        case type_1.IMBRICATE_PROPERTY_TYPE.LABEL: return [];
+        case type_1.IMBRICATE_PROPERTY_TYPE.REFERENCE: return [];
     }
     return null;
 };

package/document/property/definition.d.ts

@@ -3,5 +3,7 @@
  * @namespace Document_Property
  * @description Definition
  */
-import { DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "../property";
-export type DocumentPropertyTriageFunction<T extends IMBRICATE_PROPERTY_TYPE, Result> = (propertyKey: DocumentPropertyKey, value: DocumentPropertyValue<T>) => Result;
+import { ImbricatePropertyKey } from "../../property/definition";
+import { IImbricateProperty } from "../../property/interface";
+import { IMBRICATE_PROPERTY_TYPE } from "../../property/type";
+export type ImbricatePropertyTriageFunction<T extends IMBRICATE_PROPERTY_TYPE, Result> = (propertyKey: ImbricatePropertyKey, value: IImbricateProperty<T>) => Result;

package/document/property/primary.d.ts

@@ -4,5 +4,7 @@
  * @description Primary
  */
 import { ImbricateDatabaseSchema } from "../../database/schema";
-import { DocumentProperties, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "../property";
-export declare const findPrimaryProperty: (schema: ImbricateDatabaseSchema, properties: DocumentProperties) => DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE> | null;
+import { IImbricateProperty } from "../../property/interface";
+import { ImbricatePropertyRecord } from "../../property/map";
+import { IMBRICATE_PROPERTY_TYPE } from "../../property/type";
+export declare const findPrimaryProperty: (schema: ImbricateDatabaseSchema, properties: ImbricatePropertyRecord) => IImbricateProperty<IMBRICATE_PROPERTY_TYPE> | null;

package/document/property/triage-base.d.ts

@@ -3,8 +3,10 @@
  * @namespace Document_Property
  * @description Triage Base
  */
-import { DocumentProperties, DocumentPropertyKey, IMBRICATE_PROPERTY_TYPE } from "../property";
-import { DocumentPropertyTriageFunction } from "./definition";
+import { ImbricatePropertyKey } from "../../property/definition";
+import { ImbricatePropertyRecord } from "../../property/map";
+import { IMBRICATE_PROPERTY_TYPE } from "../../property/type";
+import { ImbricatePropertyTriageFunction } from "./definition";
 export declare class ImbricateDocumentPropertyTriageBase<Result> {
     private readonly _triageFunctionsByKey;
     private readonly _triageFunctionsByType;
@@ -17,15 +19,15 @@ export declare class ImbricateDocumentPropertyTriageBase<Result> {
      * @param triageFunction triage function
      * @returns triage manager
      */
-    forPropertyKey<T extends IMBRICATE_PROPERTY_TYPE>(propertyKey: DocumentPropertyKey, triageFunction: DocumentPropertyTriageFunction<T, Result>): this;
-    forBoolean(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.BOOLEAN, Result>): this;
-    forString(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.STRING, Result>): this;
-    forNumber(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.NUMBER, Result>): this;
-    forMarkdown(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.MARKDOWN, Result>): this;
-    forJson(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.JSON, Result>): this;
-    forImbriscript(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT, Result>): this;
-    forDate(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.DATE, Result>): this;
-    forLabel(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.LABEL, Result>): this;
-    forReference(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.REFERENCE, Result>): this;
-    protected _collect(properties: DocumentProperties): Map<DocumentPropertyKey, Result>;
+    forPropertyKey<T extends IMBRICATE_PROPERTY_TYPE>(propertyKey: ImbricatePropertyKey, triageFunction: ImbricatePropertyTriageFunction<T, Result>): this;
+    forBoolean(triageFunction: ImbricatePropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.BOOLEAN, Result>): this;
+    forString(triageFunction: ImbricatePropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.STRING, Result>): this;
+    forNumber(triageFunction: ImbricatePropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.NUMBER, Result>): this;
+    forMarkdown(triageFunction: ImbricatePropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.MARKDOWN, Result>): this;
+    forJson(triageFunction: ImbricatePropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.JSON, Result>): this;
+    forImbriscript(triageFunction: ImbricatePropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT, Result>): this;
+    forDate(triageFunction: ImbricatePropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.DATE, Result>): this;
+    forLabel(triageFunction: ImbricatePropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.LABEL, Result>): this;
+    forReference(triageFunction: ImbricatePropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.REFERENCE, Result>): this;
+    protected _collect(properties: ImbricatePropertyRecord): Map<ImbricatePropertyKey, Result>;
 }

package/document/property/triage-base.js

@@ -6,7 +6,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImbricateDocumentPropertyTriageBase = void 0;
-const property_1 = require("../property");
+const type_1 = require("../../property/type");
 // IMBRICATE_PROPERTY_TYPE SWITCH
 class ImbricateDocumentPropertyTriageBase {
     constructor() {
@@ -26,39 +26,39 @@ class ImbricateDocumentPropertyTriageBase {
         return this;
     }
     forBoolean(triageFunction) {
-        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.BOOLEAN, triageFunction);
+        this._triageFunctionsByType.set(type_1.IMBRICATE_PROPERTY_TYPE.BOOLEAN, triageFunction);
         return this;
     }
     forString(triageFunction) {
-        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.STRING, triageFunction);
+        this._triageFunctionsByType.set(type_1.IMBRICATE_PROPERTY_TYPE.STRING, triageFunction);
         return this;
     }
     forNumber(triageFunction) {
-        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.NUMBER, triageFunction);
+        this._triageFunctionsByType.set(type_1.IMBRICATE_PROPERTY_TYPE.NUMBER, triageFunction);
         return this;
     }
     forMarkdown(triageFunction) {
-        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.MARKDOWN, triageFunction);
+        this._triageFunctionsByType.set(type_1.IMBRICATE_PROPERTY_TYPE.MARKDOWN, triageFunction);
         return this;
     }
     forJson(triageFunction) {
-        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.JSON, triageFunction);
+        this._triageFunctionsByType.set(type_1.IMBRICATE_PROPERTY_TYPE.JSON, triageFunction);
         return this;
     }
     forImbriscript(triageFunction) {
-        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT, triageFunction);
+        this._triageFunctionsByType.set(type_1.IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT, triageFunction);
         return this;
     }
     forDate(triageFunction) {
-        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.DATE, triageFunction);
+        this._triageFunctionsByType.set(type_1.IMBRICATE_PROPERTY_TYPE.DATE, triageFunction);
         return this;
     }
     forLabel(triageFunction) {
-        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.LABEL, triageFunction);
+        this._triageFunctionsByType.set(type_1.IMBRICATE_PROPERTY_TYPE.LABEL, triageFunction);
         return this;
     }
     forReference(triageFunction) {
-        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.REFERENCE, triageFunction);
+        this._triageFunctionsByType.set(type_1.IMBRICATE_PROPERTY_TYPE.REFERENCE, triageFunction);
         return this;
     }
     _collect(properties) {
@@ -72,7 +72,7 @@ class ImbricateDocumentPropertyTriageBase {
                 result.set(key, value);
                 continue;
             }
-            const typeFunction = this._triageFunctionsByType.get(property.type);
+            const typeFunction = this._triageFunctionsByType.get(property.propertyType);
             if (typeof typeFunction === "function") {
                 const value = typeFunction(key, property);
                 result.set(key, value);

package/document/property/triage-manager.d.ts

@@ -3,10 +3,11 @@
  * @namespace Document_Property
  * @description Triage Manager
  */
-import { DocumentProperties, DocumentPropertyKey } from "../property";
+import { ImbricatePropertyKey } from "../../property/definition";
+import { ImbricatePropertyRecord } from "../../property/map";
 import { ImbricateDocumentPropertyTriageBase } from "./triage-base";
 export declare class ImbricateDocumentPropertyTriageManager<Result> extends ImbricateDocumentPropertyTriageBase<Result> {
-    static create<Result>(properties: DocumentProperties): ImbricateDocumentPropertyTriageManager<Result>;
+    static create<Result>(properties: ImbricatePropertyRecord): ImbricateDocumentPropertyTriageManager<Result>;
     private readonly _properties;
     private constructor();
     /**
@@ -20,11 +21,11 @@ export declare class ImbricateDocumentPropertyTriageManager<Result> extends Imbr
      *
      * @returns collected result as map
      */
-    collectAsMap(): Map<DocumentPropertyKey, Result>;
+    collectAsMap(): Map<ImbricatePropertyKey, Result>;
     /**
      * Collect the result as object
      *
      * @returns collected result as object
      */
-    collectAsObject(): Record<DocumentPropertyKey, Result>;
+    collectAsObject(): Record<ImbricatePropertyKey, Result>;
 }