@forge/migrations 3.1.1-next.1 → 3.2.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/migrations
 
+## 3.2.0-next.2
+
+### Minor Changes
+
+- 8d110da: Added `migration.getConfluenceMacroIndexIterator(transferId, { rowIndex })`, which iterates the Confluence macro index NDJSON file one parsed row at a time, beginning on the given row.
+
 ## 3.1.1-next.1
 
 ### Patch Changes

package/README.md

@@ -52,6 +52,28 @@ Returns a signed download URL for the transfer's Confluence macro index. The app
 getConfluenceMacroIndexUrl: (transferId: string) => Promise<ConfluenceMacroIndexUrlResponse>;
 ```
 
+### Iterate Confluence macro index rows
+
+Downloads the transfer's Confluence macro index (an NDJSON file) and returns an iterator that yields one parsed row per call to `next()`, beginning on `rowIndex` (default `0`).
+
+```typescript
+getConfluenceMacroIndexIterator: (
+  transferId: string,
+  options?: { rowIndex?: number }
+) => AsyncIterableIterator<{ macroname: string; contentIds: string[] }>;
+```
+
+Keep track of the index of the row you are processing so that you can resume from it if processing is interrupted:
+
+```typescript
+let rowIndex = 0; // e.g. restored from where you last left off
+
+for await (const row of migration.getConfluenceMacroIndexIterator(transferId, { rowIndex })) {
+  console.log(rowIndex, row.macroname, row.contentIds.length);
+  rowIndex++;
+}
+```
+
 ### Retrieve Containers
 
 Returns a set of containers with a specified `containerType`.

package/out/index.d.ts

@@ -1,4 +1,4 @@
 import { migration, MigrationAPIError } from './migration';
 export { migration, MigrationAPIError };
-export type { ConfluenceMacroIndexUrlResponse } from './migration/migration-adaptor';
+export type { ConfluenceMacroIndexRow, ConfluenceMacroIndexRowsOptions, ConfluenceMacroIndexUrlResponse } from './migration/migration-adaptor';
 //# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAE3D,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC;AACxC,YAAY,EAAE,+BAA+B,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAE3D,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC;AACxC,YAAY,EACV,uBAAuB,EACvB,+BAA+B,EAC/B,+BAA+B,EAChC,MAAM,+BAA+B,CAAC"}

package/out/migration/index.d.ts

@@ -1,5 +1,5 @@
 import { Migration } from './migration';
-import { AppDataIteratorOptions, AppDataPageOptions, ContainerType } from './migration-adaptor';
+import { AppDataIteratorOptions, AppDataPageOptions, ConfluenceMacroIndexRowsOptions, ContainerType } from './migration-adaptor';
 import { DefaultQueryBuilder } from './query-api';
 export declare const getMigrationInstance: (adapter: Migration) => {
     getMappingById: (transferId: string, namespace: string, keys: Array<string>) => Promise<import("./migration-adaptor").MappingResponse>;
@@ -11,6 +11,7 @@ export declare const getMigrationInstance: (adapter: Migration) => {
     getAppDataIterator: (transferId: string, options?: AppDataIteratorOptions) => AsyncIterableIterator<import("./migration-adaptor").FileMetadata>;
     getAppDataPayload: (s3Key: string) => Promise<import("packages/forge-api/out").Response>;
     getConfluenceMacroIndexUrl: (transferId: string) => Promise<import("./migration-adaptor").ConfluenceMacroIndexUrlResponse>;
+    getConfluenceMacroIndexIterator: (transferId: string, options?: ConfluenceMacroIndexRowsOptions) => AsyncIterableIterator<import("./migration-adaptor").ConfluenceMacroIndexRow>;
     getMappings: (transferId: string, namespace: string) => DefaultQueryBuilder;
     getContainers: (transferId: string, containerType: ContainerType) => DefaultQueryBuilder;
 };
@@ -24,6 +25,7 @@ export declare const migration: {
     getAppDataIterator: (transferId: string, options?: AppDataIteratorOptions) => AsyncIterableIterator<import("./migration-adaptor").FileMetadata>;
     getAppDataPayload: (s3Key: string) => Promise<import("packages/forge-api/out").Response>;
     getConfluenceMacroIndexUrl: (transferId: string) => Promise<import("./migration-adaptor").ConfluenceMacroIndexUrlResponse>;
+    getConfluenceMacroIndexIterator: (transferId: string, options?: ConfluenceMacroIndexRowsOptions) => AsyncIterableIterator<import("./migration-adaptor").ConfluenceMacroIndexRow>;
     getMappings: (transferId: string, namespace: string) => DefaultQueryBuilder;
     getContainers: (transferId: string, containerType: ContainerType) => DefaultQueryBuilder;
 };

package/out/migration/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/migration/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAChG,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,eAAO,MAAM,oBAAoB,GAAI,SAAS,SAAS;iCAEtB,MAAM,aAAa,MAAM,QAAQ,KAAK,CAAC,MAAM,CAAC;mCAE5C,MAAM,aAAa,MAAM;gCAC5B,MAAM,aAAa,MAAM;yBAChC,MAAM,cAAc,MAAM;iCAClB,MAAM;iCACN,MAAM,YAAY,kBAAkB;qCAChC,MAAM,YAAY,sBAAsB;+BAE9C,MAAM;6CACQ,MAAM;8BACrB,MAAM,aAAa,MAAM;gCAEvB,MAAM,iBAAiB,aAAa;CAGnE,CAAC;AAEF,eAAO,MAAM,SAAS;iCACS,MAAM,aAAa,MAAM,QAAQ,KAAK,CAAC,MAAM,CAAC;mCAE5C,MAAM,aAAa,MAAM;gCAE5B,MAAM,aAAa,MAAM;yBAEhC,MAAM,cAAc,MAAM;iCAElB,MAAM;iCACN,MAAM,YAAY,kBAAkB;qCAEhC,MAAM,YAAY,sBAAsB;+BAE9C,MAAM;6CACQ,MAAM;8BAErB,MAAM,aAAa,MAAM;gCAEvB,MAAM,iBAAiB,aAAa;CAEjE,CAAC;AAEF,OAAO,EAAE,QAAQ,IAAI,iBAAiB,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/migration/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,+BAA+B,EAC/B,aAAa,EACd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,eAAO,MAAM,oBAAoB,GAAI,SAAS,SAAS;iCAEtB,MAAM,aAAa,MAAM,QAAQ,KAAK,CAAC,MAAM,CAAC;mCAE5C,MAAM,aAAa,MAAM;gCAC5B,MAAM,aAAa,MAAM;yBAChC,MAAM,cAAc,MAAM;iCAClB,MAAM;iCACN,MAAM,YAAY,kBAAkB;qCAChC,MAAM,YAAY,sBAAsB;+BAE9C,MAAM;6CACQ,MAAM;kDACD,MAAM,YAAY,+BAA+B;8BAErE,MAAM,aAAa,MAAM;gCAEvB,MAAM,iBAAiB,aAAa;CAGnE,CAAC;AAEF,eAAO,MAAM,SAAS;iCACS,MAAM,aAAa,MAAM,QAAQ,KAAK,CAAC,MAAM,CAAC;mCAE5C,MAAM,aAAa,MAAM;gCAE5B,MAAM,aAAa,MAAM;yBAEhC,MAAM,cAAc,MAAM;iCAElB,MAAM;iCACN,MAAM,YAAY,kBAAkB;qCAEhC,MAAM,YAAY,sBAAsB;+BAE9C,MAAM;6CACQ,MAAM;kDAED,MAAM,YAAY,+BAA+B;8BAErE,MAAM,aAAa,MAAM;gCAEvB,MAAM,iBAAiB,aAAa;CAEjE,CAAC;AAEF,OAAO,EAAE,QAAQ,IAAI,iBAAiB,EAAE,MAAM,UAAU,CAAC"}

package/out/migration/index.js

@@ -14,6 +14,7 @@ const getMigrationInstance = (adapter) => {
         getAppDataIterator: (transferId, options) => adapter.getAppDataIterator(transferId, options),
         getAppDataPayload: (s3Key) => adapter.getAppDataPayload(s3Key),
         getConfluenceMacroIndexUrl: (transferId) => adapter.getConfluenceMacroIndexUrl(transferId),
+        getConfluenceMacroIndexIterator: (transferId, options) => adapter.getConfluenceMacroIndexIterator(transferId, options),
         getMappings: (transferId, namespace) => new query_api_1.DefaultQueryBuilder(adapter, { transferId: transferId, namespace: namespace }),
         getContainers: (transferId, containerType) => new query_api_1.DefaultQueryBuilder(adapter, { transferId: transferId, containerType: containerType })
     };
@@ -29,6 +30,7 @@ exports.migration = {
     getAppDataIterator: (transferId, options) => (0, exports.getMigrationInstance)(new migration_1.Migration()).getAppDataIterator(transferId, options),
     getAppDataPayload: (s3Key) => (0, exports.getMigrationInstance)(new migration_1.Migration()).getAppDataPayload(s3Key),
     getConfluenceMacroIndexUrl: (transferId) => (0, exports.getMigrationInstance)(new migration_1.Migration()).getConfluenceMacroIndexUrl(transferId),
+    getConfluenceMacroIndexIterator: (transferId, options) => (0, exports.getMigrationInstance)(new migration_1.Migration()).getConfluenceMacroIndexIterator(transferId, options),
     getMappings: (transferId, namespace) => (0, exports.getMigrationInstance)(new migration_1.Migration()).getMappings(transferId, namespace),
     getContainers: (transferId, containerType) => (0, exports.getMigrationInstance)(new migration_1.Migration()).getContainers(transferId, containerType)
 };

package/out/migration/migration-adaptor.d.ts

@@ -6,6 +6,7 @@ export interface MigrationAdapter {
     getAppDataIterator(transferId: string, options?: AppDataIteratorOptions): AsyncIterableIterator<FileMetadata>;
     getAppDataPayload(s3Key: string): Promise<APIResponse>;
     getConfluenceMacroIndexUrl(transferId: string): Promise<ConfluenceMacroIndexUrlResponse>;
+    getConfluenceMacroIndexIterator(transferId: string, options?: ConfluenceMacroIndexRowsOptions): AsyncIterableIterator<ConfluenceMacroIndexRow>;
     messageProcessed(transferId: string, messageId: string): Promise<void>;
     messageFailed(transferId: string, messageId: string): Promise<void>;
     addLog(transferId: string, logMessage: string): Promise<void>;
@@ -40,6 +41,13 @@ export interface AppDataPayloadResponse {
 export interface ConfluenceMacroIndexUrlResponse {
     url: string;
 }
+export interface ConfluenceMacroIndexRow {
+    macroname: string;
+    contentIds: string[];
+}
+export interface ConfluenceMacroIndexRowsOptions {
+    rowIndex?: number;
+}
 export interface PaginationMappingResponse {
     meta: PaginationResponseMeta;
     items: Map<string, string>;

package/out/migration/migration-adaptor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migration-adaptor.d.ts","sourceRoot":"","sources":["../../src/migration/migration-adaptor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,WAAW,gBAAgB;IAC/B,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACrG,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjE,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACpG,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAC9G,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACvD,0BAA0B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAAC;IACzF,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,mBAAmB,GAAG,OAAO,EAAE,CAAC;AAE5C,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,+BAA+B;IAC9C,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC5B;AAED,UAAU,sBAAsB;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,aAAa,GAAG,MAAM,CAAC;AAEvE,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAAC;IACrC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;IACnC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IAChC,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACvC"}
+{"version":3,"file":"migration-adaptor.d.ts","sourceRoot":"","sources":["../../src/migration/migration-adaptor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,WAAW,gBAAgB;IAC/B,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACrG,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjE,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACpG,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAC9G,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACvD,0BAA0B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAAC;IACzF,+BAA+B,CAC7B,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,+BAA+B,GACxC,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;IAClD,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,mBAAmB,GAAG,OAAO,EAAE,CAAC;AAE5C,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,+BAA+B;IAC9C,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,+BAA+B;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC5B;AAED,UAAU,sBAAsB;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,aAAa,GAAG,MAAM,CAAC;AAEvE,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAAC;IACrC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;IACnC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IAChC,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACvC"}

package/out/migration/migration.d.ts

@@ -1,4 +1,4 @@
-import { AppDataIteratorOptions, AppDataListResponse, AppDataPageOptions, ConfluenceMacroIndexUrlResponse, FileMetadata, FileMetadataPageResponse, MappingResponse, MigrationAdapter, ListOptions, ListResults } from './migration-adaptor';
+import { AppDataIteratorOptions, AppDataListResponse, AppDataPageOptions, ConfluenceMacroIndexRow, ConfluenceMacroIndexRowsOptions, ConfluenceMacroIndexUrlResponse, FileMetadata, FileMetadataPageResponse, MappingResponse, MigrationAdapter, ListOptions, ListResults } from './migration-adaptor';
 import { APIResponse } from '@forge/api';
 export declare class Migration implements MigrationAdapter {
     private readonly basePath;
@@ -8,6 +8,7 @@ export declare class Migration implements MigrationAdapter {
     getAppDataIterator(transferId: string, { pageSize }?: AppDataIteratorOptions): AsyncIterableIterator<FileMetadata>;
     getAppDataPayload: (key: string) => Promise<APIResponse>;
     getConfluenceMacroIndexUrl: (transferId: string) => Promise<ConfluenceMacroIndexUrlResponse>;
+    getConfluenceMacroIndexIterator(transferId: string, { rowIndex }?: ConfluenceMacroIndexRowsOptions): AsyncIterableIterator<ConfluenceMacroIndexRow>;
     messageProcessed: (transferId: string, messageId: string) => Promise<void>;
     messageFailed: (transferId: string, messageId: string) => Promise<void>;
     addLog: (transferId: string, logMessage: string) => Promise<void>;

package/out/migration/migration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../src/migration/migration.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,mBAAmB,EACnB,kBAAkB,EAClB,+BAA+B,EAC/B,YAAY,EACZ,wBAAwB,EACxB,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,WAAW,EAIZ,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAIzC,qBAAa,SAAU,YAAW,gBAAgB;IAChD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IAEtD,cAAc,GAAU,YAAY,MAAM,EAAE,WAAW,MAAM,EAAE,MAAM,KAAK,CAAC,MAAM,CAAC,KAAG,OAAO,CAAC,eAAe,CAAC,CAG3G;IAEF,cAAc,GAAU,YAAY,MAAM,KAAG,OAAO,CAAC,mBAAmB,CAAC,CAGvE;IAEF,cAAc,GAAU,YAAY,MAAM,EAAE,UAAS,kBAAuB,KAAG,OAAO,CAAC,wBAAwB,CAAC,CAY9G;IAEK,kBAAkB,CACvB,UAAU,EAAE,MAAM,EAClB,EAAE,QAAQ,EAAE,GAAE,sBAA2B,GACxC,qBAAqB,CAAC,YAAY,CAAC;IAWtC,iBAAiB,GAAU,KAAK,MAAM,KAAG,OAAO,CAAC,WAAW,CAAC,CAE3D;IAEF,0BAA0B,GAAU,YAAY,MAAM,KAAG,OAAO,CAAC,+BAA+B,CAAC,CAG/F;IAEF,gBAAgB,GAAU,YAAY,MAAM,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC,CAO7E;IAEF,aAAa,GAAU,YAAY,MAAM,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC,CAO1E;IAEF,MAAM,GAAU,YAAY,MAAM,EAAE,YAAY,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC,CAMpE;IAEF,WAAW,GACT,YAAY,MAAM,EAClB,YAAY,MAAM,EAClB,aAAa,MAAM,EACnB,WAAW,MAAM,KAChB,OAAO,CAAC,WAAW,CAAC,CAuBrB;IAEF,aAAa,GACX,YAAY,MAAM,EAClB,gBAAgB,MAAM,EACtB,aAAa,MAAM,EACnB,WAAW,MAAM,KAChB,OAAO,CAAC,WAAW,CAAC,CAsBrB;IAEF,IAAI,GAAU,SAAS,WAAW,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,WAAW,CAAC,CAI1E;CACH"}
+{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../src/migration/migration.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,mBAAmB,EACnB,kBAAkB,EAClB,uBAAuB,EACvB,+BAA+B,EAC/B,+BAA+B,EAC/B,YAAY,EACZ,wBAAwB,EACxB,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,WAAW,EAIZ,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAMzC,qBAAa,SAAU,YAAW,gBAAgB;IAChD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IAEtD,cAAc,GAAU,YAAY,MAAM,EAAE,WAAW,MAAM,EAAE,MAAM,KAAK,CAAC,MAAM,CAAC,KAAG,OAAO,CAAC,eAAe,CAAC,CAG3G;IAEF,cAAc,GAAU,YAAY,MAAM,KAAG,OAAO,CAAC,mBAAmB,CAAC,CAGvE;IAEF,cAAc,GAAU,YAAY,MAAM,EAAE,UAAS,kBAAuB,KAAG,OAAO,CAAC,wBAAwB,CAAC,CAY9G;IAEK,kBAAkB,CACvB,UAAU,EAAE,MAAM,EAClB,EAAE,QAAQ,EAAE,GAAE,sBAA2B,GACxC,qBAAqB,CAAC,YAAY,CAAC;IAWtC,iBAAiB,GAAU,KAAK,MAAM,KAAG,OAAO,CAAC,WAAW,CAAC,CAE3D;IAEF,0BAA0B,GAAU,YAAY,MAAM,KAAG,OAAO,CAAC,+BAA+B,CAAC,CAG/F;IAEK,+BAA+B,CACpC,UAAU,EAAE,MAAM,EAClB,EAAE,QAAY,EAAE,GAAE,+BAAoC,GACrD,qBAAqB,CAAC,uBAAuB,CAAC;IAUjD,gBAAgB,GAAU,YAAY,MAAM,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC,CAO7E;IAEF,aAAa,GAAU,YAAY,MAAM,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC,CAO1E;IAEF,MAAM,GAAU,YAAY,MAAM,EAAE,YAAY,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC,CAMpE;IAEF,WAAW,GACT,YAAY,MAAM,EAClB,YAAY,MAAM,EAClB,aAAa,MAAM,EACnB,WAAW,MAAM,KAChB,OAAO,CAAC,WAAW,CAAC,CAuBrB;IAEF,aAAa,GACX,YAAY,MAAM,EAClB,gBAAgB,MAAM,EACtB,aAAa,MAAM,EACnB,WAAW,MAAM,KAChB,OAAO,CAAC,WAAW,CAAC,CAsBrB;IAEF,IAAI,GAAU,SAAS,WAAW,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,WAAW,CAAC,CAI1E;CACH"}

package/out/migration/migration.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Migration = void 0;
+const errors_1 = require("./errors");
+const ndjson_reader_1 = require("./ndjson-reader");
 const utils_1 = require("./utils");
 class Migration {
     basePath = '/app/migration/forge/v1';
@@ -42,6 +44,14 @@ class Migration {
         const result = await (0, utils_1.invokePOSTApi)(`${this.basePath}/confluenceMacroIndex/${transferId}`, null);
         return (0, utils_1.getResponseBody)(result);
     };
+    async *getConfluenceMacroIndexIterator(transferId, { rowIndex = 0 } = {}) {
+        (0, ndjson_reader_1.assertValidStartRow)(rowIndex);
+        const response = await (0, utils_1.invokeGETApi)(`${this.basePath}/confluenceMacroIndex/download/${transferId}`);
+        if (response.status !== 200) {
+            throw errors_1.APIError.forStatus(response.status, response.statusText);
+        }
+        yield* (0, ndjson_reader_1.readNdjson)(await response.text(), { startRow: rowIndex });
+    }
     messageProcessed = async (transferId, messageId) => {
         const request = {
             status: 'SUCCESS',

package/out/migration/ndjson-reader.d.ts

@@ -0,0 +1,6 @@
+export interface NdjsonReadOptions {
+    startRow?: number;
+}
+export declare function assertValidStartRow(startRow: number): void;
+export declare function readNdjson<T = unknown>(body: string, { startRow }?: NdjsonReadOptions): Generator<T, void, undefined>;
+//# sourceMappingURL=ndjson-reader.d.ts.map

package/out/migration/ndjson-reader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ndjson-reader.d.ts","sourceRoot":"","sources":["../../src/migration/ndjson-reader.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAK1D;AAMD,wBAAiB,UAAU,CAAC,CAAC,GAAG,OAAO,EACrC,IAAI,EAAE,MAAM,EACZ,EAAE,QAAY,EAAE,GAAE,iBAAsB,GACvC,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAmB/B"}

package/out/migration/ndjson-reader.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertValidStartRow = assertValidStartRow;
+exports.readNdjson = readNdjson;
+const errors_1 = require("./errors");
+function assertValidStartRow(startRow) {
+    if (!Number.isInteger(startRow) || startRow < 0) {
+        throw errors_1.APIError.forUnexpected('rowIndex must be a non-negative integer');
+    }
+}
+function* readNdjson(body, { startRow = 0 } = {}) {
+    assertValidStartRow(startRow);
+    let row = 0;
+    for (const line of body.split('\n')) {
+        if (line.trim() === '') {
+            continue;
+        }
+        if (row++ < startRow) {
+            continue;
+        }
+        let parsed;
+        try {
+            parsed = JSON.parse(line);
+        }
+        catch {
+            throw errors_1.APIError.forUnexpected(`Row ${row - 1} was not valid JSON: ${line}`);
+        }
+        yield parsed;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/migrations",
-  "version": "3.1.1-next.1",
+  "version": "3.2.0-next.2",
   "description": "App migration methods for Forge app",
   "main": "out/index.js",
   "scripts": {