@elqnt/entity 1.0.0 → 1.0.5

package/dist/models/index.d.ts

@@ -0,0 +1,602 @@
+import { JSONSchema } from '@elqnt/types';
+
+type EntityFilterOperator = string;
+/**
+ * todo: move to types package
+ */
+declare const OperatorEq: EntityFilterOperator;
+/**
+ * todo: move to types package
+ */
+declare const OperatorNe: EntityFilterOperator;
+/**
+ * todo: move to types package
+ */
+declare const OperatorGt: EntityFilterOperator;
+/**
+ * todo: move to types package
+ */
+declare const OperatorGte: EntityFilterOperator;
+/**
+ * todo: move to types package
+ */
+declare const OperatorLt: EntityFilterOperator;
+/**
+ * todo: move to types package
+ */
+declare const OperatorLte: EntityFilterOperator;
+/**
+ * todo: move to types package
+ */
+declare const OperatorIn: EntityFilterOperator;
+/**
+ * todo: move to types package
+ */
+declare const OperatorNin: EntityFilterOperator;
+/**
+ * todo: move to types package
+ */
+declare const OperatorContains: EntityFilterOperator;
+/**
+ * todo: move to types package
+ */
+declare const OperatorStartsWith: EntityFilterOperator;
+/**
+ * todo: move to types package
+ */
+declare const OperatorEndsWith: EntityFilterOperator;
+/**
+ * todo: move to types package
+ */
+declare const OperatorExists: EntityFilterOperator;
+/**
+ * todo: move to types package
+ */
+declare const OperatorEmpty: EntityFilterOperator;
+/**
+ * todo: move to types package
+ */
+declare const OperatorBetween: EntityFilterOperator;
+declare const EntityFilterOperators: {
+    readonly eq: {
+        readonly value: "eq";
+        readonly label: "Equal to";
+    };
+    readonly ne: {
+        readonly value: "ne";
+        readonly label: "Not equal to";
+    };
+    readonly gt: {
+        readonly value: "gt";
+        readonly label: "Greater than";
+    };
+    readonly gte: {
+        readonly value: "gte";
+        readonly label: "Greater than or equal to";
+    };
+    readonly lt: {
+        readonly value: "lt";
+        readonly label: "Less than";
+    };
+    readonly lte: {
+        readonly value: "lte";
+        readonly label: "Less than or equal to";
+    };
+    readonly in: {
+        readonly value: "in";
+        readonly label: "In";
+    };
+    readonly nin: {
+        readonly value: "nin";
+        readonly label: "Not in";
+    };
+    readonly contains: {
+        readonly value: "contains";
+        readonly label: "Contains";
+    };
+    readonly startsWith: {
+        readonly value: "startsWith";
+        readonly label: "Starts with";
+    };
+    readonly endsWith: {
+        readonly value: "endsWith";
+        readonly label: "Ends with";
+    };
+    readonly exists: {
+        readonly value: "exists";
+        readonly label: "Exists";
+    };
+    readonly empty: {
+        readonly value: "empty";
+        readonly label: "Empty";
+    };
+    readonly between: {
+        readonly value: "between";
+        readonly label: "Between";
+    };
+};
+type EntityFilterOperatorTS = keyof typeof EntityFilterOperators;
+type EntityFilterOperatorOptionTS = typeof EntityFilterOperators[EntityFilterOperatorTS];
+type EntityFieldType = string;
+declare const EntityFieldTypeString: EntityFieldType;
+declare const EntityFieldTypeStringMultiline: EntityFieldType;
+declare const EntityFieldTypeText: EntityFieldType;
+declare const EntityFieldTypeInt: EntityFieldType;
+declare const EntityFieldTypeFloat: EntityFieldType;
+declare const EntityFieldTypeBool: EntityFieldType;
+declare const EntityFieldTypeDate: EntityFieldType;
+declare const EntityFieldTypeDateTime: EntityFieldType;
+declare const EntityFieldTypeEmail: EntityFieldType;
+declare const EntityFieldTypePhone: EntityFieldType;
+declare const EntityFieldTypeURL: EntityFieldType;
+declare const EntityFieldTypeDropdown: EntityFieldType;
+declare const EntityFieldTypeMultiSelect: EntityFieldType;
+declare const EntityFieldTypeLookup: EntityFieldType;
+declare const EntityFieldTypeMultiLookup: EntityFieldType;
+declare const EntityFieldTypeCurrency: EntityFieldType;
+declare const EntityFieldTypeFile: EntityFieldType;
+declare const EntityFieldTypeImage: EntityFieldType;
+declare const EntityFieldTypeJSON: EntityFieldType;
+declare const EntityFieldTypes: {
+    readonly string: {
+        readonly value: "string";
+        readonly label: "Short Text";
+    };
+    readonly stringMultiline: {
+        readonly value: "stringMultiline";
+        readonly label: "Long Text";
+    };
+    readonly text: {
+        readonly value: "text";
+        readonly label: "Rich Text Editor";
+    };
+    readonly int: {
+        readonly value: "int";
+        readonly label: "Integer";
+    };
+    readonly float: {
+        readonly value: "float";
+        readonly label: "Decimal";
+    };
+    readonly bool: {
+        readonly value: "bool";
+        readonly label: "Boolean";
+    };
+    readonly date: {
+        readonly value: "date";
+        readonly label: "Date";
+    };
+    readonly datetime: {
+        readonly value: "datetime";
+        readonly label: "Date & Time";
+    };
+    readonly email: {
+        readonly value: "email";
+        readonly label: "Email";
+    };
+    readonly phone: {
+        readonly value: "phone";
+        readonly label: "Phone";
+    };
+    readonly url: {
+        readonly value: "url";
+        readonly label: "URL";
+    };
+    readonly dropdown: {
+        readonly value: "dropdown";
+        readonly label: "Dropdown";
+    };
+    readonly multiselect: {
+        readonly value: "multiselect";
+        readonly label: "Multi Select";
+    };
+    readonly lookup: {
+        readonly value: "lookup";
+        readonly label: "Lookup";
+    };
+    readonly multilookup: {
+        readonly value: "multilookup";
+        readonly label: "Multi Lookup";
+    };
+    readonly currency: {
+        readonly value: "currency";
+        readonly label: "Currency";
+    };
+    readonly file: {
+        readonly value: "file";
+        readonly label: "File";
+    };
+    readonly image: {
+        readonly value: "image";
+        readonly label: "Image";
+    };
+    readonly json: {
+        readonly value: "json";
+        readonly label: "JSON";
+    };
+};
+type EntityFieldTypeTS = keyof typeof EntityFieldTypes;
+type EntityFieldTypeOptionTS = typeof EntityFieldTypes[EntityFieldTypeTS];
+interface EntityDefinition {
+    id: string;
+    name: string;
+    displayName: string;
+    module: string;
+    description: string;
+    schema: JSONSchema;
+    defaultViewId: string;
+    metadata?: {
+        [key: string]: any;
+    };
+    createdAt: string;
+    updatedAt: string;
+    isActive: boolean;
+    version: number;
+}
+interface EntityRecord {
+    id: string;
+    entityId: string;
+    name: string;
+    fields: {
+        [key: string]: any;
+    };
+    tags?: string[];
+    metadata?: {
+        [key: string]: any;
+    };
+    createdAt: string;
+    updatedAt: string;
+    isActive: boolean;
+    version: number;
+}
+/**
+ * View defines how to display entity records in a list
+ */
+interface View {
+    id: string;
+    entityId: string;
+    name: string;
+    displayName: string;
+    description?: string;
+    isDefault: boolean;
+    columns: ViewColumn[];
+    filters: Filter[];
+    sort: Sort[];
+}
+interface Filter {
+    field: string;
+    operator: EntityFilterOperator;
+    value: any;
+}
+interface Sort {
+    field: string;
+    direction: number;
+}
+interface FieldValidation {
+    required: boolean;
+    min?: number;
+    max?: number;
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+    customRules?: ValidationRule[];
+}
+interface ValidationRule {
+    name: string;
+    conditions: ValidationRuleCondition[];
+}
+interface ValidationRuleCondition {
+    field: string;
+    operator: string;
+    value: any;
+}
+interface RecordReference {
+    entityName: string;
+    recordId: string;
+    fieldName: string;
+    referencedAt: string;
+}
+interface InsertOneResult {
+    insertedId: string;
+    success: boolean;
+    error: string;
+}
+/**
+ * Query related models
+ */
+interface EntityQuery {
+    filters: {
+        [key: string]: any;
+    };
+    page: number;
+    pageSize: number;
+    sortBy: string;
+    sortOrder: number;
+    includeLookups?: LookupInclude[];
+    include?: string[];
+    exclude?: string[];
+}
+interface LookupInclude {
+    entityName: string;
+    fieldName: string;
+    fields?: string[];
+}
+interface QueryRequest {
+    orgId: string;
+    entityName: string;
+    viewId?: string;
+    query: EntityQuery;
+}
+/**
+ * Request/Response models
+ */
+interface CreateEntityDefinitionRequest {
+    orgId: string;
+    definition: EntityDefinition;
+}
+interface CreateOrgSchemaRequest {
+    orgId: string;
+}
+interface CreateOrgSchemaResponse {
+    metadata: ResponseMetadata;
+}
+interface DropOrgSchemaRequest {
+    orgId: string;
+}
+interface DropOrgSchemaResponse {
+    metadata: ResponseMetadata;
+}
+interface CreateRecordRequest {
+    orgId: string;
+    entityName: string;
+    record: EntityRecord;
+}
+interface UpdateRecordRequest {
+    orgId: string;
+    entityName: string;
+    recordId: string;
+    record: EntityRecord;
+}
+interface DeleteRecordRequest {
+    orgId: string;
+    entityName: string;
+    recordId: string;
+}
+/**
+ * View models
+ */
+interface EntityView {
+    id: string;
+    name: string;
+    displayName: string;
+    entityName: string;
+    columns: ViewColumn[];
+    filters: ViewFilter[];
+    lookups: LookupInclude[];
+    sortBy?: string;
+    sortOrder?: number;
+    isDefault: boolean;
+    createdAt: string;
+    updatedAt: string;
+    isActive: boolean;
+    version: number;
+}
+interface ViewColumn {
+    fieldName: string;
+    displayName: string;
+    width: number;
+    sortable: boolean;
+    visible: boolean;
+    order: number;
+}
+interface ViewFilter {
+    fieldName: string;
+    operator: string;
+    value: any;
+}
+/**
+ * Bulk operation models
+ */
+interface BulkCreateRequest {
+    orgId: string;
+    entityName: string;
+    records: EntityRecord[];
+}
+interface BulkUpdateRequest {
+    orgId: string;
+    entityName: string;
+    records: EntityRecord[];
+}
+interface BulkDeleteRequest {
+    orgId: string;
+    entityName: string;
+    recordIds: string[];
+}
+interface UpdateEntityDefinitionRequest {
+    orgId: string;
+    entityName: string;
+    definition: EntityDefinition;
+}
+interface GetEntityDefinitionRequest {
+    orgId: string;
+    entityName: string;
+}
+interface DeleteEntityDefinitionRequest {
+    orgId: string;
+    entityName: string;
+    deleteRecords?: boolean;
+    hardDelete?: boolean;
+}
+interface ListEntityDefinitionsRequest {
+    orgId: string;
+    module?: string;
+    status?: string;
+}
+/**
+ * View related requests
+ */
+interface CreateViewRequest {
+    orgId: string;
+    entityName: string;
+    view: EntityView;
+}
+interface UpdateViewRequest {
+    orgId: string;
+    view: EntityView;
+}
+interface DeleteViewRequest {
+    orgId: string;
+    viewId: string;
+}
+interface GetViewRequest {
+    orgId: string;
+    viewId: string;
+}
+interface ListViewsRequest {
+    orgId: string;
+    entityName: string;
+}
+/**
+ * Response models
+ */
+interface EntityDefinitionResponse {
+    definition: EntityDefinition;
+    metadata: ResponseMetadata;
+}
+interface ListEntityDefinitionsResponse {
+    definitions: EntityDefinition[];
+    metadata: ResponseMetadata;
+}
+interface EntityViewResponse {
+    view: EntityView;
+    metadata: ResponseMetadata;
+}
+interface ListViewsResponse {
+    views: EntityView[];
+    metadata: ResponseMetadata;
+}
+interface EntityRecordResponse {
+    record: EntityRecord;
+    metadata: ResponseMetadata;
+}
+interface ListEntityRecordsResponse {
+    records?: ListResult<EntityRecord>;
+    metadata: ResponseMetadata;
+}
+/**
+ * Common response metadata
+ */
+interface ResponseMetadata {
+    success: boolean;
+    timestamp: string;
+    message?: string;
+    error?: string;
+}
+interface ListOptions {
+    Page: number;
+    PageSize: number;
+    SortBy: string;
+    SortOrder: number;
+    Filters: {
+        [key: string]: any;
+    };
+    Include: string[];
+    Exclude: string[];
+}
+interface ListResult<T extends any> {
+    items: T[];
+    totalCount: number;
+    currentPage: number;
+    pageSize: number;
+    totalPages: number;
+}
+interface GetEntityRecordRequest {
+    orgId: string;
+    entityName: string;
+    recordId: string;
+}
+interface GetEntityRecordResponse {
+    record?: EntityRecord;
+    metadata: ResponseMetadata;
+}
+interface CountEntityRecordsRequest {
+    orgId: string;
+    entityName: string;
+    filters?: {
+        [key: string]: any;
+    };
+}
+interface CountEntityRecordsResponse {
+    count: number;
+    metadata: ResponseMetadata;
+}
+interface EntityRecordChangeEvent {
+    orgId: string;
+    entityName: string;
+    recordId: string;
+    record?: EntityRecord;
+    changes?: RecordChange;
+    action: RecordChangeAction;
+    timestamp: string;
+}
+interface RecordChange {
+    /**
+     * OldValues map[string]TypedValue `json:"oldValues,omitempty"`
+     * NewValues map[string]TypedValue `json:"newValues,omitempty"`
+     */
+    changedAt: string;
+    changedBy: string;
+    fields: string[];
+}
+interface EntityDefinitionChangeEvent {
+    orgId: string;
+    definition?: EntityDefinition;
+    action: string;
+    timestamp: string;
+}
+interface EntityViewChangeEvent {
+    orgId: string;
+    entityName: string;
+    view?: EntityView;
+    action: string;
+    timestamp: string;
+}
+type RecordChangeAction = string;
+declare const RecordChangeActionCreated: RecordChangeAction;
+declare const RecordChangeActionUpdated: RecordChangeAction;
+declare const RecordChangeActionDeleted: RecordChangeAction;
+declare const EntityOrgSchemaCreate = "entity.org.schema.create";
+declare const EntityOrgSchemaDrop = "entity.org.schema.drop";
+declare const EntityDefinitionCreate = "entity.definition.create";
+declare const EntityDefinitionCreated = "entity.definition.created";
+declare const EntityDefinitionUpdate = "entity.definition.update";
+declare const EntityDefinitionGet = "entity.definition.get";
+declare const EntityDefinitionGetServer = "entity.definition.get.server";
+declare const EntityDefinitionList = "entity.definition.list";
+declare const EntityDefinitionUpdated = "entity.definition.updated";
+declare const EntityDefinitionDelete = "entity.definition.delete";
+declare const EntityDefinitionDeleted = "entity.definition.deleted";
+declare const EntityRecordCreate = "entity.record.create";
+declare const EntityRecordCreated = "entity.record.created";
+declare const EntityRecordGet = "entity.record.get";
+declare const EntityRecordQuery = "entity.record.query";
+declare const EntityRecordCount = "entity.record.count";
+declare const EntityRecordUpdate = "entity.record.update";
+declare const EntityRecordUpdated = "entity.record.updated";
+declare const EntityRecordDelete = "entity.record.delete";
+declare const EntityRecordDeleted = "entity.record.deleted";
+declare const EntityRecordsBulkCreate = "entity.records.bulk.create";
+declare const EntityRecordsBulkCreated = "entity.records.bulk.created";
+declare const EntityRecordsBulkUpdate = "entity.records.bulk.update";
+declare const EntityRecordsBulkUpdated = "entity.records.bulk.updated";
+declare const EntityRecordsBulkDelete = "entity.records.bulk.delete";
+declare const EntityRecordsBulkDeleted = "entity.records.bulk.deleted";
+declare const EntityViewCreate = "entity.view.create";
+declare const EntityViewCreated = "entity.view.created";
+declare const EntityViewUpdate = "entity.view.update";
+declare const EntityViewUpdated = "entity.view.updated";
+declare const EntityViewDelete = "entity.view.delete";
+declare const EntityViewDeleted = "entity.view.deleted";
+declare const EntityViewList = "entity.view.list";
+
+export { type BulkCreateRequest, type BulkDeleteRequest, type BulkUpdateRequest, type CountEntityRecordsRequest, type CountEntityRecordsResponse, type CreateEntityDefinitionRequest, type CreateOrgSchemaRequest, type CreateOrgSchemaResponse, type CreateRecordRequest, type CreateViewRequest, type DeleteEntityDefinitionRequest, type DeleteRecordRequest, type DeleteViewRequest, type DropOrgSchemaRequest, type DropOrgSchemaResponse, type EntityDefinition, type EntityDefinitionChangeEvent, EntityDefinitionCreate, EntityDefinitionCreated, EntityDefinitionDelete, EntityDefinitionDeleted, EntityDefinitionGet, EntityDefinitionGetServer, EntityDefinitionList, type EntityDefinitionResponse, EntityDefinitionUpdate, EntityDefinitionUpdated, type EntityFieldType, EntityFieldTypeBool, EntityFieldTypeCurrency, EntityFieldTypeDate, EntityFieldTypeDateTime, EntityFieldTypeDropdown, EntityFieldTypeEmail, EntityFieldTypeFile, EntityFieldTypeFloat, EntityFieldTypeImage, EntityFieldTypeInt, EntityFieldTypeJSON, EntityFieldTypeLookup, EntityFieldTypeMultiLookup, EntityFieldTypeMultiSelect, type EntityFieldTypeOptionTS, EntityFieldTypePhone, EntityFieldTypeString, EntityFieldTypeStringMultiline, type EntityFieldTypeTS, EntityFieldTypeText, EntityFieldTypeURL, EntityFieldTypes, type EntityFilterOperator, type EntityFilterOperatorOptionTS, type EntityFilterOperatorTS, EntityFilterOperators, EntityOrgSchemaCreate, EntityOrgSchemaDrop, type EntityQuery, type EntityRecord, type EntityRecordChangeEvent, EntityRecordCount, EntityRecordCreate, EntityRecordCreated, EntityRecordDelete, EntityRecordDeleted, EntityRecordGet, EntityRecordQuery, type EntityRecordResponse, EntityRecordUpdate, EntityRecordUpdated, EntityRecordsBulkCreate, EntityRecordsBulkCreated, EntityRecordsBulkDelete, EntityRecordsBulkDeleted, EntityRecordsBulkUpdate, EntityRecordsBulkUpdated, type EntityView, type EntityViewChangeEvent, EntityViewCreate, EntityViewCreated, EntityViewDelete, EntityViewDeleted, EntityViewList, type EntityViewResponse, EntityViewUpdate, EntityViewUpdated, type FieldValidation, type Filter, type GetEntityDefinitionRequest, type GetEntityRecordRequest, type GetEntityRecordResponse, type GetViewRequest, type InsertOneResult, type ListEntityDefinitionsRequest, type ListEntityDefinitionsResponse, type ListEntityRecordsResponse, type ListOptions, type ListResult, type ListViewsRequest, type ListViewsResponse, type LookupInclude, OperatorBetween, OperatorContains, OperatorEmpty, OperatorEndsWith, OperatorEq, OperatorExists, OperatorGt, OperatorGte, OperatorIn, OperatorLt, OperatorLte, OperatorNe, OperatorNin, OperatorStartsWith, type QueryRequest, type RecordChange, type RecordChangeAction, RecordChangeActionCreated, RecordChangeActionDeleted, RecordChangeActionUpdated, type RecordReference, type ResponseMetadata, type Sort, type UpdateEntityDefinitionRequest, type UpdateRecordRequest, type UpdateViewRequest, type ValidationRule, type ValidationRuleCondition, type View, type ViewColumn, type ViewFilter };