crawlee-one 1.0.0

package/dist/cjs/lib/log.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logLevelHandlerWrapper = exports.logLevelToCrawlee = exports.LOG_LEVEL = void 0;
+const crawlee_1 = require("crawlee");
+exports.LOG_LEVEL = ['debug', 'info', 'warn', 'error', 'off']; // prettier-ignore
+/** Map log levels of `crawlee-one` to log levels of `crawlee` */
+exports.logLevelToCrawlee = {
+    off: crawlee_1.LogLevel.OFF,
+    debug: crawlee_1.LogLevel.DEBUG,
+    info: crawlee_1.LogLevel.INFO,
+    warn: crawlee_1.LogLevel.WARNING,
+    error: crawlee_1.LogLevel.ERROR,
+};
+/**
+ * Wrapper for Crawlee route handler that configures log level.
+ *
+ *
+ * Usage with Crawlee's `RouterHandler.addDefaultHandler`
+ * ```ts
+ * const wrappedHandler = logLevelHandlerWrapper('debug')(handler)
+ * await router.addDefaultHandler<Ctx>(wrappedHandler);
+ * ```
+ *
+ * Usage with Crawlee's `RouterHandler.addHandler`
+ * ```ts
+ * const wrappedHandler = logLevelHandlerWrapper('error')(handler)
+ * await router.addHandler<Ctx>(wrappedHandler);
+ * ```
+ *
+ * Usage with `createCrawleeOne`
+ * ```ts
+ * const actor = await createCrawleeOne<CheerioCrawlingContext>({
+ *   validateInput,
+ *   router: createCheerioRouter(),
+ *   routes,
+ *   routeHandlers: ({ input }) => createHandlers(input!),
+ *   routerWrappers: ({ input }) => [
+ *     logLevelHandlerWrapper<CheerioCrawlingContext<any, any>>(input?.logLevel ?? 'info'),
+ *   ],
+ *   createCrawler: ({ router, input }) => createCrawler({ router, input, crawlerConfig }),
+ * });
+ * ```
+ */
+const logLevelHandlerWrapper = (logLevel) => {
+    return (handler) => {
+        return (ctx, ...args) => {
+            ctx.log.info(`Setting log level to ${logLevel}`);
+            ctx.log.setLevel(exports.logLevelToCrawlee[logLevel]);
+            return handler(ctx, ...args);
+        };
+    };
+};
+exports.logLevelHandlerWrapper = logLevelHandlerWrapper;
+//# sourceMappingURL=log.js.map

package/dist/cjs/lib/log.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.js","sourceRoot":"","sources":["../../../src/lib/log.ts"],"names":[],"mappings":";;;AAAA,qCAA4E;AAK/D,QAAA,SAAS,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAU,CAAC,CAAC,kBAAkB;AAG/F,iEAAiE;AACpD,QAAA,iBAAiB,GAAsC;IAClE,GAAG,EAAE,kBAAe,CAAC,GAAG;IACxB,KAAK,EAAE,kBAAe,CAAC,KAAK;IAC5B,IAAI,EAAE,kBAAe,CAAC,IAAI;IAC1B,IAAI,EAAE,kBAAe,CAAC,OAAO;IAC7B,KAAK,EAAE,kBAAe,CAAC,KAAK;CAC7B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACI,MAAM,sBAAsB,GAAG,CAIpC,QAAkB,EACkB,EAAE;IACtC,OAAO,CAAC,OAAO,EAAE,EAAE;QACjB,OAAO,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,EAAE;YACtB,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,wBAAwB,QAAQ,EAAE,CAAC,CAAC;YACjD,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,yBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC9C,OAAO,OAAO,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAbW,QAAA,sBAAsB,0BAajC","sourcesContent":["import { type CrawlingContext, LogLevel as CrawleeLogLevel } from 'crawlee';\n\nimport type { ArrVal } from '../utils/types';\nimport type { CrawlerRouterWrapper } from './router';\n\nexport const LOG_LEVEL = ['debug', 'info', 'warn', 'error', 'off'] as const; // prettier-ignore\nexport type LogLevel = ArrVal<typeof LOG_LEVEL>;\n\n/** Map log levels of `crawlee-one` to log levels of `crawlee` */\nexport const logLevelToCrawlee: Record<LogLevel, CrawleeLogLevel> = {\n  off: CrawleeLogLevel.OFF,\n  debug: CrawleeLogLevel.DEBUG,\n  info: CrawleeLogLevel.INFO,\n  warn: CrawleeLogLevel.WARNING,\n  error: CrawleeLogLevel.ERROR,\n};\n\n/**\n * Wrapper for Crawlee route handler that configures log level.\n *\n *\n * Usage with Crawlee's `RouterHandler.addDefaultHandler`\n * ```ts\n * const wrappedHandler = logLevelHandlerWrapper('debug')(handler)\n * await router.addDefaultHandler<Ctx>(wrappedHandler);\n * ```\n *\n * Usage with Crawlee's `RouterHandler.addHandler`\n * ```ts\n * const wrappedHandler = logLevelHandlerWrapper('error')(handler)\n * await router.addHandler<Ctx>(wrappedHandler);\n * ```\n *\n * Usage with `createCrawleeOne`\n * ```ts\n * const actor = await createCrawleeOne<CheerioCrawlingContext>({\n *   validateInput,\n *   router: createCheerioRouter(),\n *   routes,\n *   routeHandlers: ({ input }) => createHandlers(input!),\n *   routerWrappers: ({ input }) => [\n *     logLevelHandlerWrapper<CheerioCrawlingContext<any, any>>(input?.logLevel ?? 'info'),\n *   ],\n *   createCrawler: ({ router, input }) => createCrawler({ router, input, crawlerConfig }),\n * });\n * ```\n */\nexport const logLevelHandlerWrapper = <\n  T extends CrawlingContext,\n  RouterCtx extends Record<string, any> = Record<string, any>\n>(\n  logLevel: LogLevel\n): CrawlerRouterWrapper<T, RouterCtx> => {\n  return (handler) => {\n    return (ctx, ...args) => {\n      ctx.log.info(`Setting log level to ${logLevel}`);\n      ctx.log.setLevel(logLevelToCrawlee[logLevel]);\n      return handler(ctx, ...args);\n    };\n  };\n};\n"]}

package/dist/cjs/lib/migrate/localMigrator.d.ts

@@ -0,0 +1,10 @@
+export declare const createLocalMigrator: ({ migrationsDir, extension, delimeter, }: {
+    migrationsDir: string;
+    /** Extension glob */
+    extension: string;
+    /** Delimeter between version and rest of file name */
+    delimeter: string;
+}) => {
+    migrate: (version: string) => Promise<void>;
+    unmigrate: (version: string) => Promise<void>;
+};

package/dist/cjs/lib/migrate/localMigrator.js

@@ -0,0 +1,57 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLocalMigrator = void 0;
+const path_1 = __importDefault(require("path"));
+const dotenv_1 = __importDefault(require("dotenv"));
+const glob_1 = require("glob");
+const apify_client_1 = require("apify-client");
+const createLocalMigrator = ({ migrationsDir, extension = '.js', delimeter = '_', }) => {
+    const findLocalMigrationFileByVersion = (version) => __awaiter(void 0, void 0, void 0, function* () {
+        // Find files like "v1_bla_bla_bla.js" (by default)
+        const files = yield (0, glob_1.glob)(path_1.default.join(migrationsDir, `${version}${delimeter}*${extension}`));
+        if (!files.length) {
+            throw Error(`No migration file matched version "${version}"`);
+        }
+        if (files.length > 1) {
+            throw Error(`Ambiguous migration version. Version "${version}" matched multiple migration files`);
+        }
+        return files[0];
+    });
+    const setup = () => {
+        dotenv_1.default.config();
+        const client = new apify_client_1.ApifyClient({
+            token: process.env.APIFY_TOKEN,
+        });
+        return { client };
+    };
+    const migrate = (version) => __awaiter(void 0, void 0, void 0, function* () {
+        const migFile = yield findLocalMigrationFileByVersion(version);
+        const { client } = setup();
+        const { migrate } = require(migFile).default;
+        yield migrate(client);
+    });
+    const unmigrate = (version) => __awaiter(void 0, void 0, void 0, function* () {
+        const migFile = yield findLocalMigrationFileByVersion(version);
+        const { client } = setup();
+        const { unmigrate } = require(migFile).default;
+        yield unmigrate(client);
+    });
+    return {
+        migrate,
+        unmigrate,
+    };
+};
+exports.createLocalMigrator = createLocalMigrator;
+//# sourceMappingURL=localMigrator.js.map

package/dist/cjs/lib/migrate/localMigrator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localMigrator.js","sourceRoot":"","sources":["../../../../src/lib/migrate/localMigrator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gDAAwB;AACxB,oDAA4B;AAC5B,+BAA4B;AAC5B,+CAA2C;AAIpC,MAAM,mBAAmB,GAAG,CAAC,EAClC,aAAa,EACb,SAAS,GAAG,KAAK,EACjB,SAAS,GAAG,GAAG,GAOhB,EAAE,EAAE;IACH,MAAM,+BAA+B,GAAG,CAAO,OAAe,EAAmB,EAAE;QACjF,mDAAmD;QACnD,MAAM,KAAK,GAAG,MAAM,IAAA,WAAI,EAAC,cAAI,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,OAAO,GAAG,SAAS,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;QAC1F,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YACjB,MAAM,KAAK,CAAC,sCAAsC,OAAO,GAAG,CAAC,CAAC;SAC/D;QACD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACpB,MAAM,KAAK,CACT,yCAAyC,OAAO,oCAAoC,CACrF,CAAC;SACH;QACD,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAA,CAAC;IAEF,MAAM,KAAK,GAAG,GAAG,EAAE;QACjB,gBAAM,CAAC,MAAM,EAAE,CAAC;QAChB,MAAM,MAAM,GAAG,IAAI,0BAAW,CAAC;YAC7B,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW;SAC/B,CAAC,CAAC;QACH,OAAO,EAAE,MAAM,EAAE,CAAC;IACpB,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAO,OAAe,EAAE,EAAE;QACxC,MAAM,OAAO,GAAG,MAAM,+BAA+B,CAAC,OAAO,CAAC,CAAC;QAC/D,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC;QAC3B,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,OAAoB,CAAC;QAC1D,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC,CAAA,CAAC;IAEF,MAAM,SAAS,GAAG,CAAO,OAAe,EAAE,EAAE;QAC1C,MAAM,OAAO,GAAG,MAAM,+BAA+B,CAAC,OAAO,CAAC,CAAC;QAC/D,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC;QAC3B,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,OAAoB,CAAC;QAC5D,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC,CAAA,CAAC;IAEF,OAAO;QACL,OAAO;QACP,SAAS;KACV,CAAC;AACJ,CAAC,CAAC;AAnDW,QAAA,mBAAmB,uBAmD9B","sourcesContent":["import path from 'path';\nimport dotenv from 'dotenv';\nimport { glob } from 'glob';\nimport { ApifyClient } from 'apify-client';\n\nimport type { Migration } from './types';\n\nexport const createLocalMigrator = ({\n  migrationsDir,\n  extension = '.js',\n  delimeter = '_',\n}: {\n  migrationsDir: string;\n  /** Extension glob */\n  extension: string;\n  /** Delimeter between version and rest of file name */\n  delimeter: string;\n}) => {\n  const findLocalMigrationFileByVersion = async (version: string): Promise<string> => {\n    // Find files like \"v1_bla_bla_bla.js\" (by default)\n    const files = await glob(path.join(migrationsDir, `${version}${delimeter}*${extension}`));\n    if (!files.length) {\n      throw Error(`No migration file matched version \"${version}\"`);\n    }\n    if (files.length > 1) {\n      throw Error(\n        `Ambiguous migration version. Version \"${version}\" matched multiple migration files`\n      );\n    }\n    return files[0];\n  };\n\n  const setup = () => {\n    dotenv.config();\n    const client = new ApifyClient({\n      token: process.env.APIFY_TOKEN,\n    });\n    return { client };\n  };\n\n  const migrate = async (version: string) => {\n    const migFile = await findLocalMigrationFileByVersion(version);\n    const { client } = setup();\n    const { migrate } = require(migFile).default as Migration;\n    await migrate(client);\n  };\n\n  const unmigrate = async (version: string) => {\n    const migFile = await findLocalMigrationFileByVersion(version);\n    const { client } = setup();\n    const { unmigrate } = require(migFile).default as Migration;\n    await unmigrate(client);\n  };\n\n  return {\n    migrate,\n    unmigrate,\n  };\n};\n"]}

package/dist/cjs/lib/migrate/localState.d.ts

@@ -0,0 +1,7 @@
+import type { Actor, ActorClient } from 'apify-client';
+export declare const createLocalMigrationState: ({ stateDir }: {
+    stateDir: string;
+}) => {
+    saveState: (migrationFilename: string, actor: ActorClient) => Promise<void>;
+    loadState: (migrationFilename: string) => Promise<Actor>;
+};

package/dist/cjs/lib/migrate/localState.js

@@ -0,0 +1,43 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLocalMigrationState = void 0;
+const promises_1 = __importDefault(require("fs/promises"));
+const path_1 = __importDefault(require("path"));
+const createLocalMigrationState = ({ stateDir }) => {
+    const genStateFilepath = (migrationFilename) => {
+        const filenameNoExt = path_1.default.parse(migrationFilename).name;
+        const stateFilename = `${filenameNoExt}.json`;
+        const stateFilepath = path_1.default.join(stateDir, stateFilename);
+        return stateFilepath;
+    };
+    const saveState = (migrationFilename, actor) => __awaiter(void 0, void 0, void 0, function* () {
+        const stateFilepath = genStateFilepath(migrationFilename);
+        const actorData = JSON.stringify(yield actor.get());
+        yield promises_1.default.mkdir(path_1.default.dirname(stateFilepath), { recursive: true });
+        yield promises_1.default.writeFile(stateFilepath, actorData, 'utf-8');
+    });
+    const loadState = (migrationFilename) => __awaiter(void 0, void 0, void 0, function* () {
+        const stateFilepath = genStateFilepath(migrationFilename);
+        const fileContent = yield promises_1.default.readFile(stateFilepath, 'utf-8');
+        const actorData = JSON.parse(fileContent);
+        return actorData;
+    });
+    return {
+        saveState,
+        loadState,
+    };
+};
+exports.createLocalMigrationState = createLocalMigrationState;
+//# sourceMappingURL=localState.js.map

package/dist/cjs/lib/migrate/localState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localState.js","sourceRoot":"","sources":["../../../../src/lib/migrate/localState.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2DAA8B;AAC9B,gDAAwB;AAGjB,MAAM,yBAAyB,GAAG,CAAC,EAAE,QAAQ,EAAwB,EAAE,EAAE;IAC9E,MAAM,gBAAgB,GAAG,CAAC,iBAAyB,EAAE,EAAE;QACrD,MAAM,aAAa,GAAG,cAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC;QACzD,MAAM,aAAa,GAAG,GAAG,aAAa,OAAO,CAAC;QAC9C,MAAM,aAAa,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACzD,OAAO,aAAa,CAAC;IACvB,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,CAAO,iBAAyB,EAAE,KAAkB,EAAiB,EAAE;QACvF,MAAM,aAAa,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;QAEpD,MAAM,kBAAG,CAAC,KAAK,CAAC,cAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,MAAM,kBAAG,CAAC,SAAS,CAAC,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC,CAAA,CAAC;IAEF,MAAM,SAAS,GAAG,CAAO,iBAAyB,EAAkB,EAAE;QACpE,MAAM,aAAa,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QAC1D,MAAM,WAAW,GAAG,MAAM,kBAAG,CAAC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAU,CAAC;QACnD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAA,CAAC;IAEF,OAAO;QACL,SAAS;QACT,SAAS;KACV,CAAC;AACJ,CAAC,CAAC;AA3BW,QAAA,yBAAyB,6BA2BpC","sourcesContent":["import fsp from 'fs/promises';\nimport path from 'path';\nimport type { Actor, ActorClient } from 'apify-client';\n\nexport const createLocalMigrationState = ({ stateDir }: { stateDir: string }) => {\n  const genStateFilepath = (migrationFilename: string) => {\n    const filenameNoExt = path.parse(migrationFilename).name;\n    const stateFilename = `${filenameNoExt}.json`;\n    const stateFilepath = path.join(stateDir, stateFilename);\n    return stateFilepath;\n  };\n\n  const saveState = async (migrationFilename: string, actor: ActorClient): Promise<void> => {\n    const stateFilepath = genStateFilepath(migrationFilename);\n    const actorData = JSON.stringify(await actor.get());\n\n    await fsp.mkdir(path.dirname(stateFilepath), { recursive: true });\n    await fsp.writeFile(stateFilepath, actorData, 'utf-8');\n  };\n\n  const loadState = async (migrationFilename: string): Promise<Actor> => {\n    const stateFilepath = genStateFilepath(migrationFilename);\n    const fileContent = await fsp.readFile(stateFilepath, 'utf-8');\n    const actorData = JSON.parse(fileContent) as Actor;\n    return actorData;\n  };\n\n  return {\n    saveState,\n    loadState,\n  };\n};\n"]}

package/dist/cjs/lib/migrate/types.d.ts

@@ -0,0 +1,6 @@
+import type { ApifyClient } from 'apify-client';
+import type { MaybePromise } from '../../utils/types';
+export interface Migration {
+    migrate: (client: ApifyClient) => MaybePromise<void>;
+    unmigrate: (client: ApifyClient) => MaybePromise<void>;
+}

package/dist/cjs/lib/migrate/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/cjs/lib/migrate/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/lib/migrate/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ApifyClient } from 'apify-client';\n\nimport type { MaybePromise } from '../../utils/types';\n\nexport interface Migration {\n  migrate: (client: ApifyClient) => MaybePromise<void>;\n  unmigrate: (client: ApifyClient) => MaybePromise<void>;\n}\n"]}

package/dist/cjs/lib/readme/readme.d.ts

@@ -0,0 +1,65 @@
+import { CrawleeOneReadmeTemplates, ReadmeFeature, ReadmeFeatureType } from './types';
+import type { CrawleeOneScraperActorSpec } from '../actorSpec';
+export interface CrawleeOneReadmeTemplatesOverrides extends Omit<CrawleeOneReadmeTemplates, 'features'> {
+    features?: Partial<Record<ReadmeFeatureType, Partial<ReadmeFeature>>>;
+}
+/** Define the texts in features sections that are, by default, common across all actors */
+export declare const defaultFeatureTexts: CrawleeOneReadmeTemplates['features'];
+/**
+ * Render a README.md file from a common template for a given Apify crawler.
+ *
+ * See https://docs.apify.com/academy/get-most-of-actors/actor-readme
+ *
+ * The templates are rendered using ETA (https://eta.js.org/)
+ *
+ * Each template has access to `it` global variable. `it` has these props:
+ *
+ * - `it.fn` - The functions passed to this function + more (see below)
+ * - `it.t` - The templates object passed to this function
+ * - `it.a` - The actorSpec object passed to this function
+ *
+ * Example:
+ * ```eta
+ * ActorId: <%~ it.a.platform.actorId %>
+ * ```
+ *
+ * Following functions are available by default:
+ * - `it.fn.enumerate`
+ * - `it.fn.perfStat`
+ * - `it.fn.millify`
+ * - `it.fn.capitalize`
+ * - `it.fn.stringify`
+ * - `it.fn.email`
+ * - `it.fn.includesPersonalData`
+ * - `it.fn.collectFilters`
+ * - `it.fn.collectModes`
+ * - `it.fn.collectEmails`
+ *
+ * See their definitions for details
+ */
+export declare const renderApifyReadme: (input: {
+    /** Filepath (relative to CWD) where the generated README should be written. */
+    filepath: string;
+    /**
+     * Info about a particular actor.
+     *
+     * Inside the template during rendering, this object
+     * can be accessed as `<%~ it.a.platform.actorId %>`
+     */
+    actorSpec: CrawleeOneScraperActorSpec;
+    /**
+     * Custom eta template strings that plug into different
+     * parts of the README template.
+     *
+     * Inside the template during rendering, these templates
+     * can be accessed as `<%~ it.t.someTemplate %>`
+     */
+    templates: CrawleeOneReadmeTemplatesOverrides;
+    /**
+     * Functions to be made available in the template.
+     *
+     * Inside the template during rendering, these functions
+     * can be accessed as `<%~ it.fn.funcName() %>`
+     */
+    fn?: Record<string, (...args: any[]) => any> | undefined;
+}) => Promise<void>;