chore: Mark unused options as deprecated (#800)

- Mark unused options as deprecated
- Remove validation of unused options
- Do not pass unused options to the API

Deprecated options should be removed in #799

Author: Pijukatel

src/resource_clients/actor_env_var_collection.ts

@@ -48,32 +48,23 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient {
      * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
      * items in a single API call is limited.
      * ```javascript
-     * const paginatedList = await client.list(options);
-     * ```
+     * const paginatedList = await client.list();
+     *```
      *
      * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
      * retrieved.
      *
      * ```javascript
-     * for await (const singleItem of client.list(options)) {...}
+     * for await (const singleItem of client.list()) {...}
      * ```
      *
-     * @param options - Pagination options.
      * @returns A paginated iterator of environment variables.
      * @see https://docs.apify.com/api/v2/act-version-env-vars-get
      */
     list(
-        options: ActorEnvVarCollectionListOptions = {},
+        _options: ActorEnvVarCollectionListOptions = {},
     ): Promise<ActorEnvVarListResult> & AsyncIterable<ActorEnvironmentVariable> {
-        ow(
-            options,
-            ow.object.exactShape({
-                limit: ow.optional.number.not.negative,
-                offset: ow.optional.number.not.negative,
-                desc: ow.optional.boolean,
-            }),
-        );
-        return this._listPaginated(options);
+        return this._listPaginated();
     }
 
     /**
@@ -89,6 +80,10 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient {
     }
 }
 
+/**
+ * @deprecated No options are used in the current API implementation.
+ * https://github.com/apify/apify-client-js/issues/799
+ */
 export interface ActorEnvVarCollectionListOptions extends PaginationOptions {
     desc?: boolean;
 }

src/resource_clients/actor_version_collection.ts

@@ -46,33 +46,23 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient {
      * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
      * items in a single API call is limited.
      * ```javascript
-     * const paginatedList = await client.list(options);
-     * ```
+     * const paginatedList = await client.list();
+     *```
      *
      * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
      * retrieved.
      *
      * ```javascript
-     * for await (const singleItem of client.list(options)) {...}
+     * for await (const singleItem of client.list()) {...}
      * ```
      *
-     * @param options - Pagination options.
      * @returns A paginated iterator of Actor versions.
      * @see https://docs.apify.com/api/v2/act-versions-get
      */
     list(
-        options: ActorVersionCollectionListOptions = {},
+        _options: ActorVersionCollectionListOptions = {},
     ): Promise<ActorVersionListResult> & AsyncIterable<FinalActorVersion> {
-        ow(
-            options,
-            ow.object.exactShape({
-                limit: ow.optional.number.not.negative,
-                offset: ow.optional.number.not.negative,
-                desc: ow.optional.boolean,
-            }),
-        );
-
-        return this._listPaginated(options);
+        return this._listPaginated();
     }
 
     /**
@@ -89,6 +79,10 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient {
     }
 }
 
+/**
+ * @deprecated No options are used in the current API implementation.
+ * https://github.com/apify/apify-client-js/issues/799
+ */
 export interface ActorVersionCollectionListOptions extends PaginationOptions {
     desc?: boolean;
 }

test/pagination.test.js

@@ -13,12 +13,15 @@ const range = (start, end, step = 1) => {
     );
 };
 
-const limitPaginationOptions = [
+const noOptions = [
     {
         testName: 'No options',
         userDefinedOptions: {},
         expectedItems: range(0, 2500),
     },
+];
+
+const limitPaginationOptions = [
     {
         testName: 'User limit',
         userDefinedOptions: { limit: 1100 },
@@ -72,11 +75,11 @@ describe('Collection clients list method as async iterable', () => {
     const maxItemsPerPage = 1000;
 
     const allCollectionClients = [
+        client.actor('some-id').version('some-version').envVars(), // Does not support options
+        client.actor('some-id').versions(), // Does not support options
         client.store(), // Does not support desc
-        client.actors(),
-        client.actor('some-id').version('some-version').envVars(),
-        client.actor('some-id').versions(),
         client.actor('some-id').builds(),
+        client.actors(),
         client.datasets(), // Supports unnamed
         client.keyValueStores(), // Supports unnamed
         client.requestQueues(), // Supports unnamed
@@ -95,17 +98,22 @@ describe('Collection clients list method as async iterable', () => {
     ];
 
     // Create valid tests cases for each client based on the pagination options it is supporting.
-    const commonTestCases = generateTestCases(allCollectionClients, [
-        ...limitPaginationOptions,
-        ...offsetPaginationOptions,
-    ]);
+    const noOptionsTestCases = generateTestCases(allCollectionClients, noOptions);
+
+    const commonTestCases = generateTestCases(
+        allCollectionClients.slice(2), // without envVars and versions
+        [...limitPaginationOptions, ...offsetPaginationOptions],
+    );
     const unnamedTestCases = generateTestCases(
         [client.datasets(), client.keyValueStores(), client.requestQueues()],
         unnamedPaginationOptions,
     );
-    const descTestCases = generateTestCases(allCollectionClients.slice(1), descPaginationOptions);
+    const descTestCases = generateTestCases(
+        allCollectionClients.slice(3), // without envVars, versions and store
+        descPaginationOptions,
+    );
 
-    test.each([...commonTestCases, ...unnamedTestCases, ...descTestCases])(
+    test.each([...noOptionsTestCases, ...commonTestCases, ...unnamedTestCases, ...descTestCases])(
         '$clientName: $testName',
         async ({ resourceClient, userDefinedOptions, expectedItems }) => {
             const mockedPlatformLogic = async (request) => {