@vtecx/vtecxnext 2.2.3 → 2.2.5

package/dist/vtecxnext.d.ts

@@ -24,6 +24,11 @@ export type CreateGroupadminInfo = {
     group: string;
     uids: string[];
 };
+export type PaginationInfo = {
+    lastPageNumber: number;
+    countWithinRange: number;
+    hasNext: boolean;
+};
 export declare class VtecxNext {
     /** Request */
     readonly req: NextRequest | undefined;
@@ -383,17 +388,34 @@ export declare class VtecxNext {
      * @param uri key and conditions
      * @param pagerange page range
      * @param targetService target service name (for service linkage)
-     * @return feed Maximum number of pages in the specified page range, and total count.
+     * @return Maximum number of pages in the specified page range, and total count.
      */
-    pagination: (uri: string, pagerange: string, targetService?: string) => Promise<any>;
+    pagination: (uri: string, pagerange: string, targetService?: string) => Promise<PaginationInfo>;
     /**
      * get page
      * @param uri key and conditions
      * @param num page number
      * @param targetService target service name (for service linkage)
-     * @return feed Maximum number of pages in the specified page range, and total count.
+     * @return feed (entry array)
      */
     getPage: (uri: string, num: number, targetService?: string) => Promise<any>;
+    /**
+     * practical paging
+     * If you specify page 1, a new cursor list will be created.
+     * @param uri key and conditions
+     * @param num page number
+     * @param targetService target service name (for service linkage)
+     * @return feed (entry array)
+     */
+    practicalPaging: (uri: string, num: number, targetService?: string) => Promise<any>;
+    /**
+     * ページングのカーソルリスト作成処理
+     * 続きがある場合、次のカーソルリスト作成処理を実行する
+     * @param vtecxnext
+     * @param uri キーとパラメータ
+     * @param prevLastPage 前回の最終ページ
+     */
+    private nextPagination;
     /**
      * post data to bigquery
      * @param feed entries (JSON)
@@ -980,3 +1002,10 @@ export declare class VtecxNextError extends Error {
 export declare class FetchError extends VtecxNextError {
     constructor(message: string);
 }
+/**
+ * VtecxNextError型かどうかチェック
+ * インターフェースの判定には型ガード関数を使う
+ * @param value チェックオブジェクト
+ * @returns VtecxNextError型の場合true
+ */
+export declare const isVtecxNextError: (value: unknown) => value is VtecxNextError;

package/dist/vtecxnext.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FetchError = exports.VtecxNextError = exports.VtecxResponse = exports.VtecxNext = exports.hello = void 0;
+exports.isVtecxNextError = exports.FetchError = exports.VtecxNextError = exports.VtecxResponse = exports.VtecxNext = exports.hello = void 0;
 const sqlstring_1 = __importDefault(require("sqlstring"));
 const url_1 = __importStar(require("url"));
 /**
@@ -45,6 +45,8 @@ const SERVLETPATH_PROVIDER = '/p';
 const SERVLETPATH_OAUTH = '/o';
 /** header : nextpage */
 const HEADER_NEXTPAGE = 'x-vtecx-nextpage';
+/** The number of cursors to create (for practical paging) */
+const PAGINATION_NUM = 7;
 class VtecxNext {
     /** Request */
     req;
@@ -1356,7 +1358,7 @@ class VtecxNext {
      * @param uri key and conditions
      * @param pagerange page range
      * @param targetService target service name (for service linkage)
-     * @return feed Maximum number of pages in the specified page range, and total count.
+     * @return Maximum number of pages in the specified page range, and total count.
      */
     pagination = async (uri, pagerange, targetService) => {
         //console.log('[vtecxnext pagination] start.')
@@ -1377,15 +1379,25 @@ class VtecxNext {
         this.setCookie(response);
         // レスポンスのエラーチェック
         await checkVtecxResponse(response);
-        // 戻り値
-        return await getJson(response);
+        // 戻り値編集
+        const respJson = await getJson(response);
+        let hasNext = false;
+        if (respJson.feed.link && respJson.feed.link[0]?.___rel === 'next') {
+            hasNext = true;
+        }
+        const pagenationInfo = {
+            'lastPageNumber': Number(respJson.feed.title),
+            'countWithinRange': Number(respJson.feed.subtitle),
+            'hasNext': hasNext
+        };
+        return pagenationInfo;
     };
     /**
      * get page
      * @param uri key and conditions
      * @param num page number
      * @param targetService target service name (for service linkage)
-     * @return feed Maximum number of pages in the specified page range, and total count.
+     * @return feed (entry array)
      */
     getPage = async (uri, num, targetService) => {
         //console.log(`[vtecxnext getPage] start. uri=${uri} num=${num}`)
@@ -1410,6 +1422,59 @@ class VtecxNext {
         // 戻り値
         return await getJson(response);
     };
+    /**
+     * practical paging
+     * If you specify page 1, a new cursor list will be created.
+     * @param uri key and conditions
+     * @param num page number
+     * @param targetService target service name (for service linkage)
+     * @return feed (entry array)
+     */
+    practicalPaging = async (uri, num, targetService) => {
+        //console.log(`[practicalPaging] start. uri=${uri} num=${num} ${targetService ? 'targetService=' + targetService : ''}`)
+        // ページ数が1の場合、カーソルリスト作成処理を行う
+        if (num === 1) {
+            //console.log(`[practicalPaging] pagination start. uri=${uri}`)
+            const paginationInfo = await this.pagination(uri, `1,${String(PAGINATION_NUM)}`);
+            if (paginationInfo.hasNext) {
+                // 次のカーソルリスト作成 (非同期のまま)
+                this.nextPagination(uri, PAGINATION_NUM);
+            }
+            if (paginationInfo.lastPageNumber === 0) {
+                // データが存在しない場合終了
+                return undefined;
+            }
+        }
+        // ページ取得
+        //console.log(`[practicalPaging] getPage start. uri=${uri} num=${num}`)
+        try {
+            return await this.getPage(uri, num);
+        }
+        catch (error) {
+            if ((0, exports.isVtecxNextError)(error)) {
+                // ステータス400で「There is no designated page. The last page: ページ数」の場合、空データを返す。
+                if (error.status === 400 && error.message.startsWith('There is no designated page.')) {
+                    return undefined;
+                }
+            }
+            throw error;
+        }
+    };
+    /**
+     * ページングのカーソルリスト作成処理
+     * 続きがある場合、次のカーソルリスト作成処理を実行する
+     * @param vtecxnext
+     * @param uri キーとパラメータ
+     * @param prevLastPage 前回の最終ページ
+     */
+    nextPagination = async (uri, prevLastPage) => {
+        const firstPage = prevLastPage + 1;
+        const lastPage = prevLastPage + prevLastPage;
+        const paginationInfo = await this.pagination(uri, `${String(firstPage)},${String(lastPage)}`);
+        if (paginationInfo.hasNext) {
+            await this.nextPagination(uri, lastPage);
+        }
+    };
     /**
      * post data to bigquery
      * @param feed entries (JSON)
@@ -4001,6 +4066,29 @@ class FetchError extends VtecxNextError {
     }
 }
 exports.FetchError = FetchError;
+/**
+ * VtecxNextError型かどうかチェック
+ * インターフェースの判定には型ガード関数を使う
+ * @param value チェックオブジェクト
+ * @returns VtecxNextError型の場合true
+ */
+const isVtecxNextError = (value) => {
+    // 値がオブジェクトであるかの判定
+    if (typeof value !== "object" || value === null) {
+        return false;
+    }
+    const { status, message } = value;
+    // statusプロパティーが数値型かを判定
+    if (typeof status !== "number") {
+        return false;
+    }
+    // messageプロパティーが文字列型かを判定
+    if (typeof message !== "string") {
+        return false;
+    }
+    return true;
+};
+exports.isVtecxNextError = isVtecxNextError;
 //---------------------------------------------
 /**
  * vte.cxへリクエスト

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtecx/vtecxnext",
-  "version": "2.2.3",
+  "version": "2.2.5",
   "description": "vte.cx Next.js api",
   "main": "dist/index.js",
   "files": [