@memberjunction/archiving-engine 0.0.1 → 5.30.0

package/dist/DefaultArchiveDriver.js

@@ -0,0 +1,403 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { CompositeKey, LogError, LogStatus, Metadata, RunView } from '@memberjunction/core';
+import { RegisterClass } from '@memberjunction/global';
+import { BaseArchiveDriver } from './BaseArchiveDriver.js';
+/**
+ * Default archive driver implementation. Archives configured field values to
+ * external storage, applies the appropriate post-archive action based on mode
+ * (StripFields, HardDelete, ArchiveOnly), and supports restoring the original
+ * values from the stored archive document.
+ */
+let DefaultArchiveDriver = class DefaultArchiveDriver extends BaseArchiveDriver {
+    /**
+     * Determines whether the record should be archived by checking if at least
+     * one of the configured fields (or SkipIfAllNullFields) has a non-null value.
+     * If no specific fields are configured but ArchiveFullRecord is true,
+     * always archives — the intent is a full record snapshot, not field stripping.
+     */
+    ShouldArchiveRecord(context) {
+        const fieldsToCheck = this.GetFieldsToCheck(context);
+        // If no specific fields are configured but ArchiveFullRecord is true,
+        // always archive — the intent is a full record snapshot, not field stripping
+        if (fieldsToCheck.length === 0) {
+            return context.FieldConfig.ArchiveFullRecord === true;
+        }
+        return fieldsToCheck.some(fieldName => {
+            const value = context.Record.Get(fieldName);
+            return value != null;
+        });
+    }
+    /**
+     * Archives a single record:
+     * 1. Builds the archive document with field values
+     * 2. Writes the document to external storage
+     * 3. Applies the post-archive action based on mode:
+     *    - StripFields: nullifies configured fields on the source record
+     *    - HardDelete: cascades to archive+delete dependent records, then deletes the source record
+     *    - ArchiveOnly: no changes to the source record
+     */
+    async ArchiveRecord(context) {
+        try {
+            const versionStamp = new Date();
+            const document = this.BuildArchiveDocument(context, versionStamp);
+            const storagePath = this.BuildStoragePath(context.BasePath, context.Record.EntityInfo.Name, document.recordId, versionStamp);
+            const writeResult = await this.WriteDocumentToStorage(context, storagePath, document);
+            if (!writeResult.Success) {
+                return writeResult;
+            }
+            const postArchiveResult = await this.ApplyPostArchiveAction(context);
+            if (!postArchiveResult.Success) {
+                return postArchiveResult;
+            }
+            return {
+                Success: true,
+                StoragePath: storagePath,
+                BytesArchived: writeResult.BytesArchived,
+            };
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            LogError(`DefaultArchiveDriver.ArchiveRecord failed: ${message}`);
+            return {
+                Success: false,
+                StoragePath: null,
+                BytesArchived: 0,
+                ErrorMessage: message,
+            };
+        }
+    }
+    /**
+     * Restores a previously archived record by reading the archive document
+     * from storage and setting the field values back on the source record.
+     */
+    async RestoreRecord(context) {
+        try {
+            const storagePath = context.ArchiveRunDetail.Get('StoragePath');
+            if (!storagePath) {
+                return { Success: false, ErrorMessage: 'No StoragePath on ArchiveRunDetail', RestoredFields: [] };
+            }
+            const document = await this.ReadDocumentFromStorage(context, storagePath);
+            const restoredFields = await this.ApplyArchivedFieldsToRecord(context, document);
+            return {
+                Success: true,
+                RestoredFields: restoredFields,
+            };
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            LogError(`DefaultArchiveDriver.RestoreRecord failed: ${message}`);
+            return {
+                Success: false,
+                ErrorMessage: message,
+                RestoredFields: [],
+            };
+        }
+    }
+    // ========================================
+    // ShouldArchive Helpers
+    // ========================================
+    /**
+     * Determines which fields to check for the "should archive" decision.
+     * Uses SkipIfAllNullFields if configured, otherwise all active field names.
+     */
+    GetFieldsToCheck(context) {
+        if (context.FieldConfig.SkipIfAllNullFields && context.FieldConfig.SkipIfAllNullFields.length > 0) {
+            return context.FieldConfig.SkipIfAllNullFields;
+        }
+        return context.FieldConfig.Fields
+            .filter(f => f.IsActive !== false)
+            .map(f => f.FieldName);
+    }
+    // ========================================
+    // Storage Write
+    // ========================================
+    /**
+     * Serializes the archive document and writes it to storage.
+     */
+    async WriteDocumentToStorage(context, storagePath, document) {
+        const jsonContent = JSON.stringify(document, null, 2);
+        const buffer = Buffer.from(jsonContent, 'utf8');
+        const success = await context.StorageDriver.PutObject(storagePath, buffer, 'application/json');
+        if (!success) {
+            return {
+                Success: false,
+                BytesArchived: 0,
+                StoragePath: null,
+                ErrorMessage: `Failed to write archive document to storage path: ${storagePath}`,
+            };
+        }
+        LogStatus(`Archived record to ${storagePath} (${buffer.byteLength} bytes)`);
+        return { Success: true, BytesArchived: buffer.byteLength, StoragePath: storagePath };
+    }
+    // ========================================
+    // Post-Archive Mode Handling
+    // ========================================
+    /**
+     * Resolves the effective archive mode from the entity config or parent config.
+     */
+    ResolveMode(context) {
+        return context.ConfigEntity.Get('Mode')
+            ?? context.Config.Get('DefaultMode')
+            ?? 'StripFields';
+    }
+    /**
+     * Applies the appropriate post-archive action based on the resolved mode.
+     */
+    async ApplyPostArchiveAction(context) {
+        const mode = this.ResolveMode(context);
+        switch (mode) {
+            case 'StripFields':
+                return this.NullifyArchivedFields(context);
+            case 'HardDelete':
+                return this.HardDeleteRecord(context);
+            case 'ArchiveOnly':
+                return { Success: true, StoragePath: null, BytesArchived: 0 };
+            default:
+                return {
+                    Success: false,
+                    StoragePath: null,
+                    BytesArchived: 0,
+                    ErrorMessage: `Unknown archive mode: ${mode}`,
+                };
+        }
+    }
+    // ========================================
+    // StripFields Mode
+    // ========================================
+    /**
+     * Sets all configured archive fields to their empty value on the source record and saves it.
+     * Uses null for nullable columns and empty string for NOT NULL string columns.
+     */
+    async NullifyArchivedFields(context) {
+        for (const fieldConfig of context.FieldConfig.Fields) {
+            if (fieldConfig.IsActive !== false) {
+                const emptyValue = this.GetEmptyValueForField(context, fieldConfig.FieldName);
+                context.Record.Set(fieldConfig.FieldName, emptyValue);
+            }
+        }
+        const saveResult = await context.Record.Save();
+        if (!saveResult) {
+            return {
+                Success: false,
+                StoragePath: null,
+                BytesArchived: 0,
+                ErrorMessage: `Failed to save record after nullifying archived fields: ${context.Record.LatestResult?.CompleteMessage ?? 'Unknown error'}`,
+            };
+        }
+        return { Success: true, StoragePath: null, BytesArchived: 0 };
+    }
+    /**
+     * Returns the appropriate empty value for a field based on its nullability.
+     * NOT NULL string fields get empty string; nullable fields get null.
+     */
+    GetEmptyValueForField(context, fieldName) {
+        const fieldInfo = context.Record.EntityInfo.Fields.find(f => f.Name === fieldName);
+        if (fieldInfo && !fieldInfo.AllowsNull) {
+            return '';
+        }
+        return null;
+    }
+    // ========================================
+    // HardDelete Mode (with Cascade)
+    // ========================================
+    /**
+     * Deletes the source record from the database after successful archival.
+     * Automatically cascades to dependent (child) records via FK relationships
+     * discovered from entity metadata, archiving each child to storage before deleting it.
+     */
+    async HardDeleteRecord(context) {
+        const cascadeResult = await this.ArchiveAndDeleteDependentRecords(context);
+        if (!cascadeResult.Success) {
+            return cascadeResult;
+        }
+        const deleteResult = await context.Record.Delete();
+        if (!deleteResult) {
+            return {
+                Success: false,
+                StoragePath: null,
+                BytesArchived: 0,
+                ErrorMessage: `Failed to delete record after archiving: ${context.Record.LatestResult?.CompleteMessage ?? 'Unknown error'}`,
+            };
+        }
+        return { Success: true, StoragePath: null, BytesArchived: 0 };
+    }
+    /**
+     * Collects all dependent records depth-first, writes one batch archive file
+     * per entity to storage, then deletes all records leaf-first. This batched
+     * approach dramatically reduces storage API calls compared to per-record writes.
+     */
+    async ArchiveAndDeleteDependentRecords(context) {
+        // 1. Collect all dependent records depth-first (leaves first in the resulting array)
+        const collectedRecords = [];
+        await this.CollectDependentsDepthFirst(context.Record, context.ContextUser, collectedRecords, new Set());
+        if (collectedRecords.length === 0) {
+            return { Success: true, StoragePath: null, BytesArchived: 0 };
+        }
+        LogStatus(`HardDelete cascade: collected ${collectedRecords.length} dependent record(s) across ${new Set(collectedRecords.map(r => r.EntityInfo.Name)).size} entity type(s)`);
+        // 2. Batch-archive: group records by entity name and write one file per entity
+        const archiveResult = await this.BatchArchiveDependents(collectedRecords, context);
+        if (!archiveResult.Success) {
+            return archiveResult;
+        }
+        // 3. Delete all records (already in leaf-first order from depth-first collection)
+        for (const record of collectedRecords) {
+            const deleted = await record.Delete();
+            if (!deleted) {
+                return {
+                    Success: false,
+                    StoragePath: null,
+                    BytesArchived: 0,
+                    ErrorMessage: `Failed to cascade-delete ${record.EntityInfo.Name} record ${record.PrimaryKey.Values()}: ${record.LatestResult?.CompleteMessage ?? 'Unknown error'}`,
+                };
+            }
+        }
+        return { Success: true, StoragePath: null, BytesArchived: 0 };
+    }
+    /**
+     * Recursively collects all dependent records depth-first. Leaves (deepest
+     * children) are added to the array first, so deleting in array order
+     * respects FK constraints. Uses a visited set to prevent infinite loops
+     * from circular references.
+     */
+    async CollectDependentsDepthFirst(parentRecord, contextUser, collected, visited) {
+        const entityInfo = parentRecord.EntityInfo;
+        const recordKey = `${entityInfo.ID}:${parentRecord.PrimaryKey.Values()}`;
+        if (visited.has(recordKey))
+            return;
+        visited.add(recordKey);
+        const cascadeRels = entityInfo.RelatedEntities.filter(r => r.Type?.trim() === 'One To Many' && r.RelatedEntityID !== entityInfo.ID);
+        for (const rel of cascadeRels) {
+            const childEntityName = rel.RelatedEntity;
+            const joinField = rel.RelatedEntityJoinField;
+            if (!childEntityName || !joinField)
+                continue;
+            const childRecords = await this.LoadChildRecords(childEntityName, joinField, parentRecord.PrimaryKey.Values(), contextUser);
+            for (const child of childRecords) {
+                // Recurse into grandchildren first (depth-first)
+                await this.CollectDependentsDepthFirst(child, contextUser, collected, visited);
+                // Then add this child (so it appears after its own dependents)
+                const childKey = `${child.EntityInfo.ID}:${child.PrimaryKey.Values()}`;
+                if (!visited.has(childKey)) {
+                    visited.add(childKey);
+                }
+                collected.push(child);
+            }
+        }
+    }
+    /**
+     * Groups collected records by entity name and writes one batch archive
+     * document per entity to storage. A batch document contains all records
+     * of that entity type in a single JSON array, dramatically reducing
+     * the number of storage API calls.
+     */
+    async BatchArchiveDependents(records, context) {
+        // Group by entity name
+        const byEntity = new Map();
+        for (const record of records) {
+            const name = record.EntityInfo.Name;
+            if (!byEntity.has(name)) {
+                byEntity.set(name, []);
+            }
+            byEntity.get(name).push(record);
+        }
+        const versionStamp = new Date();
+        const parentRecordId = context.Record.PrimaryKey.Values();
+        for (const [entityName, entityRecords] of byEntity) {
+            const batchDocument = {
+                archiveVersion: 1,
+                batchType: 'cascade-delete',
+                parentEntityName: context.Record.EntityInfo.Name,
+                parentRecordId: parentRecordId,
+                entityName: entityName,
+                archivedAt: versionStamp.toISOString(),
+                recordCount: entityRecords.length,
+                records: entityRecords.map(r => ({
+                    recordId: r.PrimaryKey.Values(),
+                    primaryKey: r.PrimaryKey.KeyValuePairs.map(kv => ({
+                        FieldName: kv.FieldName,
+                        Value: String(kv.Value),
+                    })),
+                    fullRecord: r.GetAll(),
+                })),
+            };
+            const sanitizedEntity = entityName.replace(/[^a-zA-Z0-9]/g, '_');
+            const sanitizedParent = parentRecordId.replace(/[^a-zA-Z0-9-]/g, '_');
+            const storagePath = `${context.BasePath}/${sanitizedEntity}/cascade_${sanitizedParent}_${versionStamp.toISOString().replace(/[:.]/g, '_')}.json`;
+            const jsonContent = JSON.stringify(batchDocument, null, 2);
+            const batchBuffer = Buffer.from(jsonContent, 'utf8');
+            const writeSuccess = await context.StorageDriver.PutObject(storagePath, batchBuffer, 'application/json');
+            if (!writeSuccess) {
+                return {
+                    Success: false,
+                    StoragePath: null,
+                    BytesArchived: 0,
+                    ErrorMessage: `Failed to batch-archive ${entityRecords.length} ${entityName} record(s) to storage`,
+                };
+            }
+            LogStatus(`Cascade batch-archived ${entityRecords.length} ${entityName} record(s) to ${storagePath} (${batchBuffer.byteLength} bytes)`);
+        }
+        return { Success: true, StoragePath: null, BytesArchived: 0 };
+    }
+    /**
+     * Loads all records from a child entity that reference a parent record via a join field.
+     */
+    async LoadChildRecords(entityName, joinField, parentRecordId, contextUser) {
+        const rv = new RunView();
+        const escapedId = parentRecordId.replace(/'/g, "''");
+        const result = await rv.RunView({
+            EntityName: entityName,
+            ExtraFilter: `${joinField}='${escapedId}'`,
+            ResultType: 'entity_object',
+        }, contextUser);
+        if (!result.Success) {
+            LogError(`Failed to load dependent ${entityName} records for cascade delete: ${result.ErrorMessage}`);
+            return [];
+        }
+        return result.Results;
+    }
+    // ========================================
+    // Restore Helpers
+    // ========================================
+    /**
+     * Reads and parses an archive document from storage.
+     */
+    async ReadDocumentFromStorage(context, storagePath) {
+        const buffer = await context.StorageDriver.GetObject({ fullPath: storagePath });
+        const jsonContent = buffer.toString('utf8');
+        return JSON.parse(jsonContent);
+    }
+    /**
+     * Applies the archived field values from the document back onto the entity record and saves.
+     */
+    async ApplyArchivedFieldsToRecord(context, document) {
+        const entityName = document.entityName;
+        const md = new Metadata();
+        const record = await md.GetEntityObject(entityName, context.ContextUser);
+        const compositeKey = new CompositeKey(document.primaryKey.map(pk => ({ FieldName: pk.FieldName, Value: pk.Value })));
+        const loaded = await record.InnerLoad(compositeKey);
+        if (!loaded) {
+            throw new Error(`Failed to load record for entity "${entityName}" with key: ${JSON.stringify(document.primaryKey)}`);
+        }
+        const restoredFields = [];
+        for (const [fieldName, fieldValue] of Object.entries(document.archivedFields)) {
+            record.Set(fieldName, fieldValue);
+            restoredFields.push(fieldName);
+        }
+        const saveResult = await record.Save();
+        if (!saveResult) {
+            throw new Error(`Failed to save restored record: ${record.LatestResult?.CompleteMessage ?? 'Unknown error'}`);
+        }
+        LogStatus(`Restored ${restoredFields.length} fields for ${entityName} record ${document.recordId}`);
+        return restoredFields;
+    }
+};
+DefaultArchiveDriver = __decorate([
+    RegisterClass(BaseArchiveDriver, 'DefaultArchiveDriver')
+], DefaultArchiveDriver);
+export { DefaultArchiveDriver };
+//# sourceMappingURL=DefaultArchiveDriver.js.map

package/dist/DefaultArchiveDriver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultArchiveDriver.js","sourceRoot":"","sources":["../src/DefaultArchiveDriver.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAc,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAY,MAAM,sBAAsB,CAAC;AAClH,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AASxD;;;;;GAKG;AAEI,IAAM,oBAAoB,GAA1B,MAAM,oBAAqB,SAAQ,iBAAiB;IACvD;;;;;OAKG;IACI,mBAAmB,CAAC,OAA6B;QACpD,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAErD,sEAAsE;QACtE,6EAA6E;QAC7E,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,OAAO,CAAC,WAAW,CAAC,iBAAiB,KAAK,IAAI,CAAC;QAC1D,CAAC;QAED,OAAO,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAClC,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAC5C,OAAO,KAAK,IAAI,IAAI,CAAC;QACzB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,aAAa,CAAC,OAA6B;QACpD,IAAI,CAAC;YACD,MAAM,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC;YAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;YAClE,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CACrC,OAAO,CAAC,QAAQ,EAChB,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAC9B,QAAQ,CAAC,QAAQ,EACjB,YAAY,CACf,CAAC;YAEF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;YACtF,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;gBACvB,OAAO,WAAW,CAAC;YACvB,CAAC;YAED,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;YACrE,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC;gBAC7B,OAAO,iBAAiB,CAAC;YAC7B,CAAC;YAED,OAAO;gBACH,OAAO,EAAE,IAAI;gBACb,WAAW,EAAE,WAAW;gBACxB,aAAa,EAAE,WAAW,CAAC,aAAa;aAC3C,CAAC;QACN,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,QAAQ,CAAC,8CAA8C,OAAO,EAAE,CAAC,CAAC;YAClE,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,WAAW,EAAE,IAAI;gBACjB,aAAa,EAAE,CAAC;gBAChB,YAAY,EAAE,OAAO;aACxB,CAAC;QACN,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa,CAAC,OAA6B;QACpD,IAAI,CAAC;YACD,MAAM,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAW,CAAC;YAC1E,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,oCAAoC,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;YACtG,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YAC1E,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAEjF,OAAO;gBACH,OAAO,EAAE,IAAI;gBACb,cAAc,EAAE,cAAc;aACjC,CAAC;QACN,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,QAAQ,CAAC,8CAA8C,OAAO,EAAE,CAAC,CAAC;YAClE,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,YAAY,EAAE,OAAO;gBACrB,cAAc,EAAE,EAAE;aACrB,CAAC;QACN,CAAC;IACL,CAAC;IAED,2CAA2C;IAC3C,wBAAwB;IACxB,2CAA2C;IAE3C;;;OAGG;IACK,gBAAgB,CAAC,OAA6B;QAClD,IAAI,OAAO,CAAC,WAAW,CAAC,mBAAmB,IAAI,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChG,OAAO,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC;QACnD,CAAC;QACD,OAAO,OAAO,CAAC,WAAW,CAAC,MAAM;aAC5B,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,KAAK,CAAC;aACjC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC;IAED,2CAA2C;IAC3C,gBAAgB;IAChB,2CAA2C;IAE3C;;OAEG;IACK,KAAK,CAAC,sBAAsB,CAChC,OAA6B,EAC7B,WAAmB,EACnB,QAAyB;QAEzB,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QAEhD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC;QAC/F,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,aAAa,EAAE,CAAC;gBAChB,WAAW,EAAE,IAAI;gBACjB,YAAY,EAAE,qDAAqD,WAAW,EAAE;aACnF,CAAC;QACN,CAAC;QAED,SAAS,CAAC,sBAAsB,WAAW,KAAK,MAAM,CAAC,UAAU,SAAS,CAAC,CAAC;QAC5E,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,CAAC,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;IACzF,CAAC;IAED,2CAA2C;IAC3C,6BAA6B;IAC7B,2CAA2C;IAE3C;;OAEG;IACK,WAAW,CAAC,OAA6B;QAC7C,OAAQ,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAmB;eAClD,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAY;eAC7C,aAAa,CAAC;IACzB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,sBAAsB,CAChC,OAA6B;QAE7B,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEvC,QAAQ,IAAI,EAAE,CAAC;YACX,KAAK,aAAa;gBACd,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;YAC/C,KAAK,YAAY;gBACb,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAC1C,KAAK,aAAa;gBACd,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;YAClE;gBACI,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,CAAC;oBAChB,YAAY,EAAE,yBAAyB,IAAI,EAAE;iBAChD,CAAC;QACV,CAAC;IACL,CAAC;IAED,2CAA2C;IAC3C,mBAAmB;IACnB,2CAA2C;IAE3C;;;OAGG;IACK,KAAK,CAAC,qBAAqB,CAC/B,OAA6B;QAE7B,KAAK,MAAM,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;YACnD,IAAI,WAAW,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;gBACjC,MAAM,UAAU,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;gBAC9E,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAC1D,CAAC;QACL,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC/C,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,WAAW,EAAE,IAAI;gBACjB,aAAa,EAAE,CAAC;gBAChB,YAAY,EAAE,2DAA2D,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,eAAe,IAAI,eAAe,EAAE;aAC7I,CAAC;QACN,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;IAClE,CAAC;IAED;;;OAGG;IACK,qBAAqB,CAAC,OAA6B,EAAE,SAAiB;QAC1E,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;QACnF,IAAI,SAAS,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;YACrC,OAAO,EAAE,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,2CAA2C;IAC3C,iCAAiC;IACjC,2CAA2C;IAE3C;;;;OAIG;IACK,KAAK,CAAC,gBAAgB,CAC1B,OAA6B;QAE7B,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,gCAAgC,CAAC,OAAO,CAAC,CAAC;QAC3E,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO,aAAa,CAAC;QACzB,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACnD,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,WAAW,EAAE,IAAI;gBACjB,aAAa,EAAE,CAAC;gBAChB,YAAY,EAAE,4CAA4C,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,eAAe,IAAI,eAAe,EAAE;aAC9H,CAAC;QACN,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,gCAAgC,CAC1C,OAA6B;QAE7B,qFAAqF;QACrF,MAAM,gBAAgB,GAAiB,EAAE,CAAC;QAC1C,MAAM,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,EAAE,gBAAgB,EAAE,IAAI,GAAG,EAAU,CAAC,CAAC;QAEjH,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;QAClE,CAAC;QAED,SAAS,CAAC,iCAAiC,gBAAgB,CAAC,MAAM,+BAA+B,IAAI,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,CAAC;QAE9K,+EAA+E;QAC/E,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QACnF,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO,aAAa,CAAC;QACzB,CAAC;QAED,kFAAkF;QAClF,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACpC,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC;YACtC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACX,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,CAAC;oBAChB,YAAY,EAAE,4BAA4B,MAAM,CAAC,UAAU,CAAC,IAAI,WAAW,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,MAAM,CAAC,YAAY,EAAE,eAAe,IAAI,eAAe,EAAE;iBACtK,CAAC;YACN,CAAC;QACL,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,2BAA2B,CACrC,YAAwB,EACxB,WAAqB,EACrB,SAAuB,EACvB,OAAoB;QAEpB,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAC3C,MAAM,SAAS,GAAG,GAAG,UAAU,CAAC,EAAE,IAAI,YAAY,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;QAEzE,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC;YAAE,OAAO;QACnC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAEvB,MAAM,WAAW,GAAG,UAAU,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CACtD,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,aAAa,IAAI,CAAC,CAAC,eAAe,KAAK,UAAU,CAAC,EAAE,CAC1E,CAAC;QAEF,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;YAC5B,MAAM,eAAe,GAAG,GAAG,CAAC,aAAa,CAAC;YAC1C,MAAM,SAAS,GAAG,GAAG,CAAC,sBAAsB,CAAC;YAC7C,IAAI,CAAC,eAAe,IAAI,CAAC,SAAS;gBAAE,SAAS;YAE7C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,eAAe,EAAE,SAAS,EAAE,YAAY,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,WAAW,CAAC,CAAC;YAE5H,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;gBAC/B,iDAAiD;gBACjD,MAAM,IAAI,CAAC,2BAA2B,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;gBAC/E,+DAA+D;gBAC/D,MAAM,QAAQ,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,EAAE,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;gBACvE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACzB,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAC1B,CAAC;gBACD,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC;QACL,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,sBAAsB,CAChC,OAAqB,EACrB,OAA6B;QAE7B,uBAAuB;QACvB,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAwB,CAAC;QACjD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBACtB,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC3B,CAAC;YACD,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC;QAChC,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE1D,KAAK,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,IAAI,QAAQ,EAAE,CAAC;YACjD,MAAM,aAAa,GAAG;gBAClB,cAAc,EAAE,CAAC;gBACjB,SAAS,EAAE,gBAAgB;gBAC3B,gBAAgB,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI;gBAChD,cAAc,EAAE,cAAc;gBAC9B,UAAU,EAAE,UAAU;gBACtB,UAAU,EAAE,YAAY,CAAC,WAAW,EAAE;gBACtC,WAAW,EAAE,aAAa,CAAC,MAAM;gBACjC,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;oBAC7B,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE;oBAC/B,UAAU,EAAE,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;wBAC9C,SAAS,EAAE,EAAE,CAAC,SAAS;wBACvB,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC;qBAC1B,CAAC,CAAC;oBACH,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;iBACzB,CAAC,CAAC;aACN,CAAC;YAEF,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;YACjE,MAAM,eAAe,GAAG,cAAc,CAAC,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;YACtE,MAAM,WAAW,GAAG,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,YAAY,eAAe,IAAI,YAAY,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC;YAEjJ,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAC3D,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;YAErD,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,kBAAkB,CAAC,CAAC;YACzG,IAAI,CAAC,YAAY,EAAE,CAAC;gBAChB,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,CAAC;oBAChB,YAAY,EAAE,2BAA2B,aAAa,CAAC,MAAM,IAAI,UAAU,uBAAuB;iBACrG,CAAC;YACN,CAAC;YAED,SAAS,CAAC,0BAA0B,aAAa,CAAC,MAAM,IAAI,UAAU,iBAAiB,WAAW,KAAK,WAAW,CAAC,UAAU,SAAS,CAAC,CAAC;QAC5I,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;IAClE,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,gBAAgB,CAC1B,UAAkB,EAClB,SAAiB,EACjB,cAAsB,EACtB,WAAqB;QAErB,MAAM,EAAE,GAAG,IAAI,OAAO,EAAE,CAAC;QACzB,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACrD,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,OAAO,CAAa;YACxC,UAAU,EAAE,UAAU;YACtB,WAAW,EAAE,GAAG,SAAS,KAAK,SAAS,GAAG;YAC1C,UAAU,EAAE,eAAe;SAC9B,EAAE,WAAW,CAAC,CAAC;QAEhB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YAClB,QAAQ,CAAC,4BAA4B,UAAU,gCAAgC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;YACtG,OAAO,EAAE,CAAC;QACd,CAAC;QAED,OAAO,MAAM,CAAC,OAAO,CAAC;IAC1B,CAAC;IAED,2CAA2C;IAC3C,kBAAkB;IAClB,2CAA2C;IAE3C;;OAEG;IACK,KAAK,CAAC,uBAAuB,CAAC,OAA6B,EAAE,WAAmB;QACpF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC;QAChF,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAoB,CAAC;IACtD,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,2BAA2B,CACrC,OAA6B,EAC7B,QAAyB;QAEzB,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;QACvC,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,UAAU,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAEzE,MAAM,YAAY,GAAG,IAAI,YAAY,CACjC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAChF,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACpD,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,qCAAqC,UAAU,eAAe,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACzH,CAAC;QAED,MAAM,cAAc,GAAa,EAAE,CAAC;QACpC,KAAK,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAC5E,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAClC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QACvC,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,CAAC,YAAY,EAAE,eAAe,IAAI,eAAe,EAAE,CAAC,CAAC;QAClH,CAAC;QAED,SAAS,CAAC,YAAY,cAAc,CAAC,MAAM,eAAe,UAAU,WAAW,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QACpG,OAAO,cAAc,CAAC;IAC1B,CAAC;CACJ,CAAA;AA1dY,oBAAoB;IADhC,aAAa,CAAC,iBAAiB,EAAE,sBAAsB,CAAC;GAC5C,oBAAoB,CA0dhC"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export * from './types.js';
+export * from './BaseArchiveDriver.js';
+export * from './DefaultArchiveDriver.js';
+export * from './ArchiveStorageManager.js';
+export * from './ArchiveProcessor.js';
+export * from './ArchiveRecovery.js';
+export * from './ArchiveEngine.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+export * from './types.js';
+export * from './BaseArchiveDriver.js';
+export * from './DefaultArchiveDriver.js';
+export * from './ArchiveStorageManager.js';
+export * from './ArchiveProcessor.js';
+export * from './ArchiveRecovery.js';
+export * from './ArchiveEngine.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,140 @@
+import { BaseEntity, UserInfo } from '@memberjunction/core';
+import { FileStorageBase } from '@memberjunction/storage';
+/**
+ * Configuration for which fields to archive on an entity.
+ */
+export interface ArchiveFieldConfiguration {
+    /** List of field-level configurations */
+    Fields: ArchiveFieldConfig[];
+    /** Whether to include the full record snapshot in the archive document */
+    ArchiveFullRecord?: boolean;
+    /** If all of these fields are null, skip archiving (record already archived) */
+    SkipIfAllNullFields?: string[];
+}
+/**
+ * Per-field configuration within an archive configuration entity.
+ */
+export interface ArchiveFieldConfig {
+    /** Name of the entity field to archive */
+    FieldName: string;
+    /** Whether this field configuration is active */
+    IsActive?: boolean;
+    /** Additional driver-specific options for this field */
+    Options?: Record<string, unknown>;
+}
+/**
+ * The JSON document stored in external storage for each archived record version.
+ */
+export interface ArchiveDocument {
+    /** Schema version for forward compatibility */
+    archiveVersion: number;
+    /** Name of the entity that was archived */
+    entityName: string;
+    /** ID of the Entity metadata record */
+    entityId: string;
+    /** Primary key value of the archived record (first key field) */
+    recordId: string;
+    /** Full composite primary key */
+    primaryKey: ArchivePrimaryKeyField[];
+    /** ISO 8601 timestamp used as the version identifier */
+    versionStamp: string;
+    /** ISO 8601 timestamp when the archive was created */
+    archivedAt: string;
+    /** ID of the ArchiveConfigurationEntity that triggered this archive */
+    archiveConfigurationEntityId: string;
+    /** ID of the parent ArchiveConfiguration */
+    archiveConfigurationId: string;
+    /** Archive mode (e.g. 'archive', 'purge') */
+    mode: string;
+    /** Map of field names to their archived values */
+    archivedFields: Record<string, unknown>;
+    /** Full record snapshot, or null if ArchiveFullRecord was false */
+    fullRecord: Record<string, unknown> | null;
+}
+/**
+ * Represents a single field in a composite primary key.
+ */
+export interface ArchivePrimaryKeyField {
+    FieldName: string;
+    Value: string;
+}
+/**
+ * Context passed to archive drivers for processing a single record.
+ */
+export interface ArchiveRecordContext {
+    /** The entity record to archive */
+    Record: BaseEntity;
+    /** Field configuration for this entity */
+    FieldConfig: ArchiveFieldConfiguration;
+    /** The ArchiveConfigurationEntity record */
+    ConfigEntity: BaseEntity;
+    /** The parent ArchiveConfiguration record */
+    Config: BaseEntity;
+    /** Initialized storage driver for writing archive documents */
+    StorageDriver: FileStorageBase;
+    /** Base path prefix in storage */
+    BasePath: string;
+    /** User context for server-side operations */
+    ContextUser: UserInfo;
+    /** The current ArchiveRun record */
+    ArchiveRun: BaseEntity;
+}
+/**
+ * Result of archiving a single record.
+ */
+export interface ArchiveRecordResult {
+    /** Whether the archive operation succeeded */
+    Success: boolean;
+    /** Storage path where the archive document was written, or null on failure */
+    StoragePath: string | null;
+    /** Number of bytes written to storage */
+    BytesArchived: number;
+    /** Error message if Success is false */
+    ErrorMessage?: string;
+    /** True if the record was intentionally skipped (e.g., all fields already null) */
+    Skipped?: boolean;
+}
+/**
+ * Context passed to archive drivers for restoring a single record.
+ */
+export interface RestoreRecordContext {
+    /** The ArchiveRunDetail record describing what was archived */
+    ArchiveRunDetail: BaseEntity;
+    /** Initialized storage driver for reading archive documents */
+    StorageDriver: FileStorageBase;
+    /** User context for server-side operations */
+    ContextUser: UserInfo;
+}
+/**
+ * Result of restoring a single archived record.
+ */
+export interface RestoreRecordResult {
+    /** Whether the restore operation succeeded */
+    Success: boolean;
+    /** Error message if Success is false */
+    ErrorMessage?: string;
+    /** List of field names that were restored */
+    RestoredFields: string[];
+}
+/**
+ * Result of a complete archive run across all configured entities.
+ */
+export interface ArchiveRunResult {
+    /** Whether the overall run succeeded */
+    Success: boolean;
+    /** ID of the ArchiveRun record created for this execution */
+    ArchiveRunId: string;
+    /** Total number of records evaluated */
+    TotalRecords: number;
+    /** Number of records successfully archived */
+    ArchivedRecords: number;
+    /** Number of records that failed to archive */
+    FailedRecords: number;
+    /** Number of records intentionally skipped */
+    SkippedRecords: number;
+    /** Total bytes written to storage across all records */
+    TotalBytesArchived: number;
+    /** Error message if Success is false */
+    ErrorMessage?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC,yCAAyC;IACzC,MAAM,EAAE,kBAAkB,EAAE,CAAC;IAC7B,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gFAAgF;IAChF,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,0CAA0C;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,iDAAiD;IACjD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,+CAA+C;IAC/C,cAAc,EAAE,MAAM,CAAC;IACvB,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,iEAAiE;IACjE,QAAQ,EAAE,MAAM,CAAC;IACjB,iCAAiC;IACjC,UAAU,EAAE,sBAAsB,EAAE,CAAC;IACrC,wDAAwD;IACxD,YAAY,EAAE,MAAM,CAAC;IACrB,sDAAsD;IACtD,UAAU,EAAE,MAAM,CAAC;IACnB,uEAAuE;IACvE,4BAA4B,EAAE,MAAM,CAAC;IACrC,4CAA4C;IAC5C,sBAAsB,EAAE,MAAM,CAAC;IAC/B,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,mEAAmE;IACnE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,mCAAmC;IACnC,MAAM,EAAE,UAAU,CAAC;IACnB,0CAA0C;IAC1C,WAAW,EAAE,yBAAyB,CAAC;IACvC,4CAA4C;IAC5C,YAAY,EAAE,UAAU,CAAC;IACzB,6CAA6C;IAC7C,MAAM,EAAE,UAAU,CAAC;IACnB,+DAA+D;IAC/D,aAAa,EAAE,eAAe,CAAC;IAC/B,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,8CAA8C;IAC9C,WAAW,EAAE,QAAQ,CAAC;IACtB,oCAAoC;IACpC,UAAU,EAAE,UAAU,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,8CAA8C;IAC9C,OAAO,EAAE,OAAO,CAAC;IACjB,8EAA8E;IAC9E,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,yCAAyC;IACzC,aAAa,EAAE,MAAM,CAAC;IACtB,wCAAwC;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mFAAmF;IACnF,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,+DAA+D;IAC/D,gBAAgB,EAAE,UAAU,CAAC;IAC7B,+DAA+D;IAC/D,aAAa,EAAE,eAAe,CAAC;IAC/B,8CAA8C;IAC9C,WAAW,EAAE,QAAQ,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,8CAA8C;IAC9C,OAAO,EAAE,OAAO,CAAC;IACjB,wCAAwC;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6CAA6C;IAC7C,cAAc,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,wCAAwC;IACxC,OAAO,EAAE,OAAO,CAAC;IACjB,6DAA6D;IAC7D,YAAY,EAAE,MAAM,CAAC;IACrB,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,8CAA8C;IAC9C,eAAe,EAAE,MAAM,CAAC;IACxB,+CAA+C;IAC/C,aAAa,EAAE,MAAM,CAAC;IACtB,8CAA8C;IAC9C,cAAc,EAAE,MAAM,CAAC;IACvB,wDAAwD;IACxD,kBAAkB,EAAE,MAAM,CAAC;IAC3B,wCAAwC;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,10 +1,34 @@
 {
   "name": "@memberjunction/archiving-engine",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @memberjunction/archiving-engine",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+  "type": "module",
+  "version": "5.30.0",
+  "description": "Core archiving engine for MemberJunction - handles field-level archiving, storage, and recovery of entity records.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "build": "tsc && tsc-alias -f",
+    "watch": "tsc -w",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
+  "author": "MemberJunction.com",
+  "license": "ISC",
+  "devDependencies": {
+    "vitest": "^3.1.1",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@memberjunction/core": "5.30.0",
+    "@memberjunction/core-entities": "5.30.0",
+    "@memberjunction/global": "5.30.0",
+    "@memberjunction/storage": "5.30.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MemberJunction/MJ"
+  }
 }