Added support for pagination, GCP support and package bump (#113)

* Added support for pagination, GCP support and package bump * Updated the import package name in examples. * Added pagination API test cases in assets and entries. * Removed only in test file. * Remove only in test file * Updated license file * fix: 👷 fixed package file and regenerated package-lock file * Changed package name --------- Co-authored-by: Nadeem Patwekar <[email protected]>
contentstack · Jan 18, 2024 · 44c6500 · 44c6500
1 parent e45e5af
commit 44c6500
Show file tree

Hide file tree

Showing 20 changed files with 1,121 additions and 8,926 deletions.
diff --git a/README.md b/README.md
@@ -291,7 +291,7 @@ You can use advanced sync queries to fetch custom results while performing initi
 
 ### The MIT License (MIT)
 
-Copyright © 2012-2021 [Contentstack](https://www.contentstack.com). All Rights Reserved
+Copyright © 2012-2024 [Contentstack](https://www.contentstack.com). All Rights Reserved
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@contentstack/delivery",
+  "name": "@contentstack/delivery-sdk",
   "version": "0.0.1",
   "type": "commonjs",
   "main": "./dist/cjs/src/index.js",
@@ -20,8 +20,9 @@
   },
   "dependencies": {
     "@contentstack/core": "^1.0.1",
-    "@contentstack/utils": "^1.1.3",
-    "@types/humps": "^2.0.2",
+    "@contentstack/utils": "^1.3.1",
+    "@types/humps": "^2.0.6",
+
     "dotenv": "^16.3.1",
     "humps": "^2.0.1"
   },
@@ -31,17 +32,17 @@
     "README.md"
   ],
   "devDependencies": {
-    "@nrwl/jest": "^16.8.1",
-    "@types/jest": "^29.5.5",
-    "axios-mock-adapter": "^1.21.2",
+    "@nrwl/jest": "^17.2.8",
+    "@types/jest": "^29.5.11",
+    "axios-mock-adapter": "^1.22.0",
     "babel-jest": "^29.7.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "jest-html-reporters": "^3.1.4",
+    "jest-html-reporters": "^3.1.7",
     "jest-junit": "^16.0.0",
     "ts-jest": "^29.1.1",
-    "ts-loader": "^9.4.4",
-    "ts-node": "10.9.1",
+    "ts-loader": "^9.5.1",
+    "ts-node": "10.9.2",
     "webpack-cli": "^5.1.4"
   }
 }
diff --git a/src/lib/asset-query.ts b/src/lib/asset-query.ts
@@ -13,7 +13,7 @@ export class AssetQuery extends BaseQuery {
    * @description Retrieve a specific version of an asset in result
    * @returns {AssetQuery}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset().version(1).find();
@@ -30,7 +30,7 @@ export class AssetQuery extends BaseQuery {
    * @description Includes the dimensions (height and width) of the image in result
    * @returns {AssetQuery}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset().includeDimension().find();
@@ -47,7 +47,7 @@ export class AssetQuery extends BaseQuery {
    * @description Includes the branch in result
    * @returns {AssetQuery}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset().includeBranch().find();
@@ -64,7 +64,7 @@ export class AssetQuery extends BaseQuery {
    * @description Include the metadata for getting metadata content for the entry.
    * @returns {Entries}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset().includeMetadata().fetch();
@@ -81,7 +81,7 @@ export class AssetQuery extends BaseQuery {
    * @description Includes the relative URLs of the assets in result
    * @returns {AssetQuery}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset().relativeUrls().find();
@@ -98,7 +98,7 @@ export class AssetQuery extends BaseQuery {
    * @description When an entry is not published in a specific language, content can be fetched from its fallback language
    * @returns {AssetQuery}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset().includeFallback().find();
@@ -115,7 +115,7 @@ export class AssetQuery extends BaseQuery {
    * @description The assets published in the locale will be fetched
    * @returns {AssetQuery}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset().locale('en-us').find();

diff --git a/src/lib/asset.ts b/src/lib/asset.ts
@@ -16,7 +16,7 @@ export class Asset {
    * @description When an entry is not published in a specific language, content can be fetched from its fallback language
    * @returns {Asset}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset('asset_uid').includeFallback().fetch();
@@ -33,7 +33,7 @@ export class Asset {
    * @description Include the metadata for getting metadata content for the entry.
    * @returns {Entries}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset('asset_uid').includeMetadata().fetch();
@@ -50,7 +50,7 @@ export class Asset {
    * @description Includes the dimensions (height and width) of the image in result
    * @returns {Asset}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset('asset_uid').includeDimension().fetch();
@@ -67,7 +67,7 @@ export class Asset {
    * @description Includes the branch in result
    * @returns {Asset}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset('asset_uid').includeBranch().fetch();
@@ -84,7 +84,7 @@ export class Asset {
    * @description Includes the relative URLs of the asset in result
    * @returns {Asset}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset('asset_uid').relativeUrls().fetch();
@@ -101,7 +101,7 @@ export class Asset {
    * @description Retrieve a specific version of an asset in result
    * @returns {Asset}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset('asset_uid').version(1).fetch();
@@ -118,7 +118,7 @@ export class Asset {
    * @description The assets published in the locale will be fetched
    * @returns {Asset}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset('asset_uid').locale('en-us').fetch();
@@ -135,7 +135,7 @@ export class Asset {
    * @description Fetches the asset data on the basis of the asset uid
    * @returns {Asset}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset('asset_uid').fetch();

diff --git a/src/lib/base-query.ts b/src/lib/base-query.ts
@@ -12,7 +12,7 @@ export class BaseQuery extends Pagination {
    * @memberof BaseQuery
    * @description Retrieve count and data of objects in result
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const query = stack.contentType("contentTypeUid").entry().query();
@@ -33,7 +33,7 @@ export class BaseQuery extends Pagination {
    * @memberof BaseQuery
    * @description Sorts the results in ascending order based on the specified field UID.
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const query = stack.contentType("contentTypeUid").entry().query();
@@ -54,7 +54,7 @@ export class BaseQuery extends Pagination {
    * @memberof BaseQuery
    * @description Sorts the results in descending order based on the specified key.
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const query = stack.contentType("contentTypeUid").entry().query();
@@ -70,12 +70,56 @@ export class BaseQuery extends Pagination {
     return this;
   }
 
+  /**
+   * @method limit
+   * @memberof BaseQuery
+   * @description Returns a specific number of entries based on the set limit
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const query = stack.contentType("contentTypeUid").entry().query();
+   * const result = await query.limit("limit_value").find()
+   * // OR
+   * const asset = await stack.asset().limit(5).find()
+   *
+   * @returns {BaseQuery}
+   */
+  limit(key: number): BaseQuery {
+    this._queryParams.limit = key;
+
+    return this;
+  }
+
+  /**
+   * @method skip
+   * @memberof BaseQuery
+   * @description Skips at specific number of entries.
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const query = stack.contentType("contentTypeUid").entry().query();
+   * const result = await query.skip("skip_value").find()
+   * // OR
+   * const asset = await stack.asset().skip(5).find()
+   *
+   * @returns {BaseQuery}
+   */
+  skip(key: number): BaseQuery {
+    this._queryParams.skip = key;
+
+    return this;
+  }
+
+
+
   /**
    * @method param
    * @memberof BaseQuery
    * @description Adds query parameters to the URL.
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const query = stack.contentType("contentTypeUid").entry().query();
@@ -96,7 +140,7 @@ export class BaseQuery extends Pagination {
    * @memberof BaseQuery
    * @description Adds a query parameter to the query.
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const query = stack.contentType("contentTypeUid").entry().query();
@@ -117,7 +161,7 @@ export class BaseQuery extends Pagination {
    * @memberof BaseQuery
    * @description Removes a query parameter from the query.
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const query = stack.contentType("contentTypeUid").entry().query();
@@ -139,17 +183,17 @@ export class BaseQuery extends Pagination {
    * @description The assets of the stack will be fetched
    * @returns {Collection}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset().find();
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.contentType("contentType1Uid").entry().query().find();
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.asset(asset_uid).fetch();

diff --git a/src/lib/content-type.ts b/src/lib/content-type.ts
@@ -24,7 +24,7 @@ export class ContentType {
    * @description Creates entry object of the passed entry uid.
    * @returns {Entry}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const entry = stack.contentType("contentTypeUid").entry("entryUid");
@@ -43,7 +43,7 @@ export class ContentType {
    * @description Fetches the contentType data on the basis of the contentType uid
    * @returns {ContentType}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const result = await stack.contentType(asset_uid).fetch();

diff --git a/src/lib/contentstack.ts b/src/lib/contentstack.ts
@@ -13,10 +13,10 @@ export * as Utils from '@contentstack/utils';
  * @param {StackConfig} config - config object for stack with apiKey, deliveryToken and environment as required fields
  *
  * @example
- * import contentstack from '@contentstack/typescript'
+ * import contentstack from '@contentstack/delivery-sdk'
  * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
  * @example
- * import contentstack from '@contentstack/typescript'
+ * import contentstack from '@contentstack/delivery-sdk'
  * const stack = contentstack.Stack({
  *   apiKey: "apiKey",
  *   deliveryToken: "deliveryToken",

diff --git a/src/lib/contenttype-query.ts b/src/lib/contenttype-query.ts
@@ -16,7 +16,7 @@ export class ContentTypeQuery {
    * @description The assets published in the locale will be fetched
    * @returns {ContentTypeQuery}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const contentTypeQuery = stack.contentType();
@@ -33,7 +33,7 @@ export class ContentTypeQuery {
    * @description Fetches all contentTypes of the stack
    * @returns {ContentTypeQuery}
    * @example
-   * import contentstack from '@contentstack/typescript'
+   * import contentstack from '@contentstack/delivery-sdk'
    *
    * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
    * const contentTypeQuery = stack.contentType();