@openstax/ts-utils 1.34.1 → 1.35.0

package/dist/esm/services/searchProvider/index.d.ts

@@ -40,6 +40,8 @@ type Field = {
 export interface IndexOptions<T> {
     body: T;
     id: string;
+    version?: number;
+    version_type?: 'external' | 'external_gte';
 }
 export type FieldMapping = {
     type: 'keyword' | 'text' | 'boolean';

package/dist/esm/services/searchProvider/openSearch.js

@@ -60,7 +60,9 @@ export const openSearchService = (initializer = {}) => (configProvider) => {
                 index: indexConfig.name,
                 body: params.body,
                 id: params.id,
-                refresh: true
+                refresh: true,
+                version: params.version,
+                version_type: params.version_type
             }, {
                 requestTimeout: 10000,
                 maxRetries: 1,
@@ -71,7 +73,13 @@ export const openSearchService = (initializer = {}) => (configProvider) => {
             await openSearchClient.bulk({
                 index: indexConfig.name,
                 body: items.flatMap((item) => [
-                    { index: { _id: item.id } },
+                    {
+                        index: {
+                            _id: item.id,
+                            ...(item.version !== undefined ? { version: item.version } : {}),
+                            ...(item.version_type !== undefined ? { version_type: item.version_type } : {})
+                        }
+                    },
                     item.body
                 ]),
                 refresh: true

package/dist/esm/services/searchProvider/streamIndexer.d.ts

@@ -0,0 +1,17 @@
+import { DynamoDBRecord } from 'aws-lambda';
+import { Logger } from '../logger';
+import { IndexOptions } from '../searchProvider';
+export interface SearchProvider<T> {
+    index: (options: IndexOptions<T>) => Promise<void>;
+    bulkIndex: (items: IndexOptions<T>[]) => Promise<void>;
+}
+export interface SearchIndexUpdaterConfig<T> {
+    searchProvider: SearchProvider<T>;
+    logger: Logger;
+    getDocumentId: (document: T) => string;
+    getDocumentVersion?: (document: T) => number | undefined;
+}
+/**
+ * Function to update search index from DynamoDB Stream records.
+ */
+export declare const updateSearchIndexFromStream: <T>(records: DynamoDBRecord[], config: SearchIndexUpdaterConfig<T>) => Promise<void>;

package/dist/esm/services/searchProvider/streamIndexer.js

@@ -0,0 +1,37 @@
+import { unmarshall } from '@aws-sdk/util-dynamodb';
+import { Level } from '../logger';
+const VALID_EVENTS = new Set(['INSERT', 'MODIFY']);
+/**
+ * Function to update search index from DynamoDB Stream records.
+ */
+export const updateSearchIndexFromStream = async (records, config) => {
+    var _a, _b;
+    const { searchProvider, logger, getDocumentId, getDocumentVersion } = config;
+    const itemsToIndex = [];
+    for (const record of records) {
+        if (!record.eventName || !VALID_EVENTS.has(record.eventName)) {
+            logger.log(`Skipping ${record.eventName || 'undefined'} event`, Level.Error);
+            continue;
+        }
+        if (!((_a = record.dynamodb) === null || _a === void 0 ? void 0 : _a.NewImage)) {
+            logger.log('Missing NewImage in record, skipping', Level.Error);
+            continue;
+        }
+        const document = unmarshall(record.dynamodb.NewImage);
+        const documentId = getDocumentId(document);
+        const indexOptions = {
+            id: documentId,
+            body: document,
+        };
+        const version = (_b = getDocumentVersion === null || getDocumentVersion === void 0 ? void 0 : getDocumentVersion(document)) !== null && _b !== void 0 ? _b : record.dynamodb.ApproximateCreationDateTime;
+        if (version !== undefined) {
+            indexOptions.version = version;
+            indexOptions.version_type = 'external';
+        }
+        itemsToIndex.push(indexOptions);
+    }
+    if (itemsToIndex.length > 0) {
+        await searchProvider.bulkIndex(itemsToIndex);
+        logger.log(`Successfully indexed ${itemsToIndex.length} documents`);
+    }
+};