feat: add support for general resource access (#669)

We plan to allow users to configure through API & clients how their
storages and runs can be accessed — whether just the ID / name is
sufficient to access the storage. This is controlled through the
`generalAccess` resource property, which overrides account setting for
the resource.

Full context in apify/apify-core#19012.

This PR updates the client so that it can be used to get and update
general access on datasets, key-value stores, request queues, and runs.

```typescript
const run = client.run(runId);

// Set general access to ANYONE_WITH_ID_CAN_READ which overrides the account setting.
await run.update({ generalAccess: RUN_GENERAL_ACCESS.ANYONE_WITH_ID_CAN_READ });

// Reset the general access so that it follows the account setting.
await run.update({ generalAccess: null });
```

Author: tobice

package-lock.json

@@ -59,7 +59,7 @@
 		"build:browser": "webpack"
 	},
 	"dependencies": {
-		"@apify/consts": "^2.25.0",
+		"@apify/consts": "^2.40.0",
 		"@apify/log": "^2.2.6",
 		"@crawlee/types": "^3.3.0",
 		"agentkeepalive": "^4.2.1",

package.json

@@ -1,6 +1,7 @@
 import type { AxiosRequestConfig } from 'axios';
 import ow from 'ow';
 
+import type { RUN_GENERAL_ACCESS } from '@apify/consts';
 import { ACT_JOB_STATUSES, META_ORIGINS } from '@apify/consts';
 
 import type { ActorVersion} from './actor_version';
@@ -386,6 +387,7 @@ export interface ActorRun extends ActorRunListItem {
     usageUsd?: ActorRunUsage;
     pricingInfo?: ActorRunPricingInfo;
     chargedEventCounts?: Record<string, number>;
+    generalAccess?: RUN_GENERAL_ACCESS | null,
 }
 
 export interface ActorRunUsage {

src/resource_clients/actor.ts

@@ -1,5 +1,7 @@
 import ow from 'ow';
 
+import type { STORAGE_GENERAL_ACCESS } from '@apify/consts';
+
 import type { ApifyApiError } from '../apify_api_error';
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
@@ -177,6 +179,7 @@ export interface Dataset {
     actRunId?: string;
     stats: DatasetStats;
     fields: string[];
+    generalAccess?: STORAGE_GENERAL_ACCESS | null,
 }
 
 export interface DatasetStats {
@@ -189,6 +192,7 @@ export interface DatasetStats {
 export interface DatasetClientUpdateOptions {
     name?: string | null;
     title?: string;
+    generalAccess?: STORAGE_GENERAL_ACCESS | null,
 }
 
 export interface DatasetClientListItemOptions {

src/resource_clients/dataset.ts

@@ -3,6 +3,7 @@ import type { Readable } from 'node:stream';
 import ow from 'ow';
 import type { JsonValue } from 'type-fest';
 
+import type { STORAGE_GENERAL_ACCESS } from '@apify/consts';
 import log from '@apify/log';
 
 import type { ApifyApiError } from '../apify_api_error';
@@ -226,6 +227,7 @@ export interface KeyValueStore {
     actId?: string;
     actRunId?: string;
     stats?: KeyValueStoreStats;
+    generalAccess?: STORAGE_GENERAL_ACCESS | null,
 }
 
 export interface KeyValueStoreStats {
@@ -239,6 +241,7 @@ export interface KeyValueStoreStats {
 export interface KeyValueClientUpdateOptions {
     name?: string | null;
     title?: string;
+    generalAccess?: STORAGE_GENERAL_ACCESS | null,
 }
 
 export interface KeyValueClientListKeysOptions {

src/resource_clients/key_value_store.ts

@@ -1,7 +1,13 @@
 import ow from 'ow';
 import type { JsonObject } from 'type-fest';
 
-import { MAX_PAYLOAD_SIZE_BYTES, REQUEST_QUEUE_MAX_REQUESTS_PER_BATCH_OPERATION } from '@apify/consts';
+import type {
+    STORAGE_GENERAL_ACCESS
+} from '@apify/consts';
+import {
+    MAX_PAYLOAD_SIZE_BYTES,
+    REQUEST_QUEUE_MAX_REQUESTS_PER_BATCH_OPERATION
+} from '@apify/consts';
 import log from '@apify/log';
 
 import type { ApifyApiError } from '../apify_api_error';
@@ -487,6 +493,7 @@ export interface RequestQueue {
     actRunId?: string;
     hadMultipleClients: boolean;
     stats: RequestQueueStats;
+    generalAccess?: STORAGE_GENERAL_ACCESS | null,
 }
 
 export interface RequestQueueStats {
@@ -500,6 +507,7 @@ export interface RequestQueueStats {
 export interface RequestQueueClientUpdateOptions {
     name?: string | null;
     title?: string;
+    generalAccess?: STORAGE_GENERAL_ACCESS | null,
 }
 
 export interface RequestQueueClientListHeadOptions {

src/resource_clients/request_queue.ts

@@ -1,6 +1,8 @@
 import type { AxiosRequestConfig } from 'axios';
 import ow from 'ow';
 
+import type { RUN_GENERAL_ACCESS } from '@apify/consts';
+
 import type { ActorRun } from './actor';
 import { DatasetClient } from './dataset';
 import { KeyValueStoreClient } from './key_value_store';
@@ -257,6 +259,7 @@ export interface RunMetamorphOptions {
 export interface RunUpdateOptions {
     statusMessage?: string;
     isStatusMessageTerminal?: boolean;
+    generalAccess?: RUN_GENERAL_ACCESS | null,
 }
 
 export interface RunResurrectOptions {