@apify/actor-utils 0.1.3-beta.2 → 0.1.4-beta.0

package/README.md

@@ -138,8 +138,7 @@ Highlights:
 
 - `scripts/check-pushdata.mjs` greps `src/` and `test/` for any
   `.pushData(` call expression and fails if one exists.
-- The package is consumed as compiled output (`dist/`), so `npm test`
-  builds via `tsc` first, then runs the compiled suite under `node --test`.
+- `npm test` runs the whole `test/` tree with Vitest, straight from source.
 
 ## Layout
 
@@ -147,10 +146,11 @@ Highlights:
 .
 ├── index.ts                               # package entry point, re-exports src/
 ├── src/pushDataWithSchemaRepair.ts        # the library
-├── test/pushDataWithSchemaRepair.test.ts  # node:test suite
+├── test/pushDataWithSchemaRepair.test.ts  # Vitest suite
 ├── scripts/
 │   ├── check-pushdata.mjs                 # CI guard against direct .pushData() calls
 │   └── probe-errors.mjs                   # reference: re-derive the API error shape
 ├── tsconfig.json
+├── vitest.config.ts
 └── package.json
 ```

package/dist/src/gteam-internal/index.d.ts

@@ -0,0 +1,2 @@
+export { safePushData } from './push-data.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/gteam-internal/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/gteam-internal/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/src/gteam-internal/index.js

@@ -0,0 +1,2 @@
+export { safePushData } from './push-data.js';
+//# sourceMappingURL=index.js.map

package/dist/src/gteam-internal/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/gteam-internal/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/src/gteam-internal/push-data.d.ts

@@ -0,0 +1,39 @@
+import type { ChargeResult } from 'apify';
+/**
+ * Pushes to the default dataset, or a named dataset when `alias` is given,
+ * converting a schema-validation failure into a {@link NonRetryableError}
+ * instead of leaving it to be retried.
+ *
+ * @param data - A single item or array of items to push.
+ * @param options.alias - Alias of the dataset to push to, opened via {@link Actor.openDataset}.
+ *   Omit to push to the default dataset. Does not charge — call {@link Actor.charge}
+ *   yourself afterwards if the push should be billable.
+ *
+ * @example
+ * ```ts
+ * await safePushData(item);
+ * await safePushData(report, { alias: 'competitorAnalysis' });
+ * ```
+ */
+export declare function safePushData<T extends object>(data: T | T[], options?: {
+    alias: string;
+}): Promise<void>;
+/**
+ * Pushes to the default dataset and atomically charges for `eventName`, via
+ * {@link Actor.pushData}'s built-in pay-per-event support. Converts a
+ * schema-validation failure into a {@link NonRetryableError} instead of
+ * leaving it to be retried.
+ *
+ * @param data - A single item or array of items to push.
+ * @param options.eventName - Pay-per-event event name to charge for this push.
+ * @returns The {@link ChargeResult}, e.g. to check `chargeableWithinLimit` and decide whether to keep scraping.
+ *
+ * @example
+ * ```ts
+ * const { chargeableWithinLimit } = await safePushData(item, { eventName: 'result-scraped' });
+ * ```
+ */
+export declare function safePushData<T extends object>(data: T | T[], options: {
+    eventName: string;
+}): Promise<ChargeResult>;
+//# sourceMappingURL=push-data.d.ts.map

package/dist/src/gteam-internal/push-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"push-data.d.ts","sourceRoot":"","sources":["../../../src/gteam-internal/push-data.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAwB1C;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAChH;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,YAAY,CAAC,CAAC,SAAS,MAAM,EAC/C,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,EACb,OAAO,EAAE;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAC/B,OAAO,CAAC,YAAY,CAAC,CAAC"}

package/dist/src/gteam-internal/push-data.js

@@ -0,0 +1,40 @@
+import { NonRetryableError } from '@crawlee/core';
+import { Actor, log } from 'apify';
+import { ApifyApiError } from 'apify-client';
+/**
+ * Wraps a push call, converting a dataset schema-validation failure into a
+ * {@link NonRetryableError} instead of a retryable one — a schema mismatch
+ * will never fix itself on retry, so retrying just burns compute.
+ */
+async function wrapPushData(pushDataFn) {
+    try {
+        return await pushDataFn();
+    }
+    catch (error) {
+        if (!(error instanceof ApifyApiError) || !Array.isArray(error.data?.invalidItems)) {
+            throw error;
+        }
+        const msg = 'Dataset validation failed';
+        for (const { validationErrors } of error.data.invalidItems) {
+            log.error(msg, { msg, error: `${error}`, validationErrors });
+        }
+        throw new NonRetryableError(msg);
+    }
+}
+export async function safePushData(data, options) {
+    const { alias, eventName } = options ?? {};
+    // Default dataset: Actor.pushData(data, eventName) already pushes and
+    // charges atomically, so delegate to it as-is instead of reimplementing charging.
+    if (!alias) {
+        if (eventName) {
+            return wrapPushData(async () => Actor.pushData(data, eventName));
+        }
+        return wrapPushData(async () => Actor.pushData(data));
+    }
+    // Named dataset: charging is handled by the caller — call Actor.charge() themselves after this push.
+    const dataset = await Actor.openDataset({ alias });
+    return wrapPushData(async () => {
+        await dataset.pushData(data);
+    });
+}
+//# sourceMappingURL=push-data.js.map

package/dist/src/gteam-internal/push-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"push-data.js","sourceRoot":"","sources":["../../../src/gteam-internal/push-data.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAElD,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C;;;;GAIG;AACH,KAAK,UAAU,YAAY,CAAI,UAA4B;IACvD,IAAI,CAAC;QACD,OAAO,MAAM,UAAU,EAAE,CAAC;IAC9B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,CAAC,KAAK,YAAY,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,CAAC;YAChF,MAAM,KAAK,CAAC;QAChB,CAAC;QACD,MAAM,GAAG,GAAG,2BAA2B,CAAC;QACxC,KAAK,MAAM,EAAE,gBAAgB,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACzD,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC;QACjE,CAAC;QACD,MAAM,IAAI,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC;AACL,CAAC;AAsCD,MAAM,CAAC,KAAK,UAAU,YAAY,CAC9B,IAAa,EACb,OAAgD;IAEhD,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAE3C,sEAAsE;IACtE,kFAAkF;IAClF,IAAI,CAAC,KAAK,EAAE,CAAC;QACT,IAAI,SAAS,EAAE,CAAC;YACZ,OAAO,YAAY,CAAC,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,YAAY,CAAC,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED,qGAAqG;IACrG,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,WAAW,CAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACtD,OAAO,YAAY,CAAC,KAAK,IAAI,EAAE;QAC3B,MAAM,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACP,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apify/actor-utils",
-  "version": "0.1.3-beta.2",
+  "version": "0.1.4-beta.0",
   "type": "module",
   "description": "Wrapper around Actor.pushData that survives dataset schema-validation failures by stripping offending fields and retrying. Callers pass the actual push function as pushFn.",
   "repository": {
@@ -24,6 +24,10 @@
     "./type-utils": {
       "types": "./dist/src/type-utils/index.d.ts",
       "default": "./dist/src/type-utils/index.js"
+    },
+    "./gteam-internal": {
+      "types": "./dist/src/gteam-internal/index.d.ts",
+      "default": "./dist/src/gteam-internal/index.js"
     }
   },
   "files": [
@@ -40,7 +44,7 @@
     "lint:fix": "eslint --fix",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
-    "test": "tsc && node --test dist/test/*.test.js",
+    "test": "vitest run --coverage",
     "check:pushdata": "node scripts/check-pushdata.mjs",
     "check-unused": "knip",
     "ci": "npm run typecheck && npm run lint && npm run format:check && npm run check:pushdata && npm test",
@@ -55,8 +59,11 @@
   "devDependencies": {
     "@apify/eslint-config": "^1.2.0",
     "@apify/tsconfig": "^0.1.2",
+    "@crawlee/core": "3.16.0",
     "@types/node": "^25.9.1",
-    "apify-client": "^2.10.0",
+    "@vitest/coverage-v8": "^4.0.18",
+    "apify": "3.7.2",
+    "apify-client": "^2.17.0",
     "eslint": "^9.39.4",
     "eslint-config-prettier": "^10.1.8",
     "globals": "^17.7.0",
@@ -65,10 +72,25 @@
     "lint-staged": "^15.5.2",
     "prettier": "^3.9.4",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.62.1"
+    "typescript-eslint": "^8.62.1",
+    "vitest": "^4.0.18"
   },
   "license": "ISC",
   "peerDependencies": {
-    "@apify/log": "^2.5.44"
+    "@apify/log": "^2.5.44",
+    "@crawlee/core": "~3.16",
+    "apify": "~3.7",
+    "apify-client": "~2.17"
+  },
+  "peerDependenciesMeta": {
+    "@crawlee/core": {
+      "optional": true
+    },
+    "apify": {
+      "optional": true
+    },
+    "apify-client": {
+      "optional": true
+    }
   }
 }