@scrapyio/sdk 0.1.0

package/dist/tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool.js","sourceRoot":"","sources":["../src/tool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C;;;;GAIG;AACH,MAAM,OAAO,UAAU;IAKF;IACA;IALV,SAAS,CAAS;IAClB,IAAI,CAAS;IAEtB,YACmB,QAAwB,EACxB,SAA2B,EAC5C,GAAW;QAFM,aAAQ,GAAR,QAAQ,CAAgB;QACxB,cAAS,GAAT,SAAS,CAAkB;QAG5C,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED,4EAA4E;IAC5E,KAAK,CAAC,GAAG;QACP,MAAM,IAAI,GAAG,MAAM,eAAe,CAChC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,2BAA2B,EAAE;YAC7C,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE;SACjE,CAAC,EACF,oBAAoB,CACrB,CAAC;QACF,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,KAAiB;QAC1B,OAAO,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,kBAAkB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IAC3F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAC,KAAiB;QAC3B,MAAM,GAAG,GAAG,MAAM,YAAY,CAC5B,IAAI,CAAC,SAAS,EACd,kBAAkB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,EAC7C,KAAK,CACN,CAAC;QACF,OAAO;YACL,GAAG,GAAG;YACN,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,QAAQ,EAAE,IAAI,CAAC,IAAI;SACpB,CAAC;IACJ,CAAC;CACF"}

package/dist/tools.d.ts

@@ -0,0 +1,21 @@
+import type { PlatformClient } from './generated/client.js';
+import { type Page } from './pagination.js';
+import type { Tool, ToolSummary } from './types.js';
+export type ListToolsParams = {
+    q?: string;
+    social?: string;
+    leads?: string;
+    searchSeo?: string;
+    ecommerce?: string;
+    feature?: string;
+    sort?: string;
+    offset?: number;
+    limit?: number;
+};
+export declare class ToolsResource {
+    private readonly client;
+    constructor(client: PlatformClient);
+    list(params?: ListToolsParams): Promise<Page<ToolSummary>>;
+    get(publisher: string, slug: string): Promise<Tool>;
+}
+//# sourceMappingURL=tools.d.ts.map

package/dist/tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["../src/tools.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAgC,KAAK,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAC1E,OAAO,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEpD,MAAM,MAAM,eAAe,GAAG;IAC5B,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,qBAAa,aAAa;IACZ,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,cAAc;IAE7C,IAAI,CAAC,MAAM,GAAE,eAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAsB9D,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAW1D"}

package/dist/tools.js

@@ -0,0 +1,35 @@
+import { platformRequest } from './platform.js';
+import { unwrapCollection, unwrapData } from './pagination.js';
+export class ToolsResource {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    async list(params = {}) {
+        const data = await platformRequest(this.client.GET('/tools', {
+            params: {
+                query: {
+                    q: params.q,
+                    social: params.social,
+                    leads: params.leads,
+                    searchSeo: params.searchSeo,
+                    ecommerce: params.ecommerce,
+                    feature: params.feature,
+                    sort: params.sort,
+                    offset: params.offset,
+                    limit: params.limit,
+                },
+            },
+        }), 'Failed to list tools');
+        return unwrapCollection(data);
+    }
+    async get(publisher, slug) {
+        const data = await platformRequest(this.client.GET('/tools/{publisher}/{slug}', {
+            params: {
+                path: { publisher, slug },
+            },
+        }), 'Failed to get tool');
+        return unwrapData(data);
+    }
+}
+//# sourceMappingURL=tools.js.map

package/dist/tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.js","sourceRoot":"","sources":["../src/tools.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAa,MAAM,iBAAiB,CAAC;AAe1E,MAAM,OAAO,aAAa;IACK;IAA7B,YAA6B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAEvD,KAAK,CAAC,IAAI,CAAC,SAA0B,EAAE;QACrC,MAAM,IAAI,GAAG,MAAM,eAAe,CAChC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE;YACxB,MAAM,EAAE;gBACN,KAAK,EAAE;oBACL,CAAC,EAAE,MAAM,CAAC,CAAC;oBACX,MAAM,EAAE,MAAM,CAAC,MAAM;oBACrB,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,SAAS,EAAE,MAAM,CAAC,SAAS;oBAC3B,SAAS,EAAE,MAAM,CAAC,SAAS;oBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,MAAM,EAAE,MAAM,CAAC,MAAM;oBACrB,KAAK,EAAE,MAAM,CAAC,KAAK;iBACpB;aACF;SACF,CAAC,EACF,sBAAsB,CACvB,CAAC;QACF,OAAO,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,SAAiB,EAAE,IAAY;QACvC,MAAM,IAAI,GAAG,MAAM,eAAe,CAChC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,2BAA2B,EAAE;YAC3C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE;aAC1B;SACF,CAAC,EACF,oBAAoB,CACrB,CAAC;QACF,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CACF"}

package/dist/types.d.ts

@@ -0,0 +1,27 @@
+import type { components } from './generated/schema.js';
+export type JsonObject = Record<string, unknown>;
+export type ToolSummary = components['schemas']['ToolSummary'];
+export type Tool = components['schemas']['Tool'];
+export type Run = components['schemas']['Run'];
+export type RunStatus = components['schemas']['RunStatus'];
+export type RunKind = components['schemas']['RunKind'];
+export type Schedule = components['schemas']['Schedule'];
+export type CreateScheduleRequest = components['schemas']['CreateScheduleRequest'];
+export type UpdateScheduleRequest = components['schemas']['UpdateScheduleRequest'];
+export type DatasetItem = components['schemas']['DatasetItem'];
+export type ToolExecution = components['schemas']['ToolExecution'];
+/** Public statuses considered terminal for wait(). */
+export declare const TERMINAL_RUN_STATUSES: ReadonlySet<RunStatus>;
+export declare function isTerminalRunStatus(status: string | undefined): status is RunStatus;
+export type ScrapyIOOptions = {
+    apiKey: string;
+    /** Platform API base including `/v1`. Default `https://api.scrapy.io/v1`. */
+    baseUrl?: string;
+    /** Override fetch (tests). */
+    fetch?: typeof globalThis.fetch;
+    /** Max GET retries for transient failures. Default 2 (3 total attempts). */
+    maxRetries?: number;
+    /** Initial retry backoff in ms. Default 250. */
+    retryBackoffMs?: number;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEjD,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;AAC/D,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AACjD,MAAM,MAAM,GAAG,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC;AAC/C,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;AAC3D,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;AACvD,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC;AACzD,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC;AACnF,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC;AACnF,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;AAC/D,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AAEnE,sDAAsD;AACtD,eAAO,MAAM,qBAAqB,EAAE,WAAW,CAAC,SAAS,CAKvD,CAAC;AAEH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,IAAI,SAAS,CAEnF;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,6EAA6E;IAC7E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAChC,4EAA4E;IAC5E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gDAAgD;IAChD,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC"}

package/dist/types.js

@@ -0,0 +1,11 @@
+/** Public statuses considered terminal for wait(). */
+export const TERMINAL_RUN_STATUSES = new Set([
+    'succeeded',
+    'partial',
+    'failed',
+    'cancelled',
+]);
+export function isTerminalRunStatus(status) {
+    return status === 'succeeded' || status === 'partial' || status === 'failed' || status === 'cancelled';
+}
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAeA,sDAAsD;AACtD,MAAM,CAAC,MAAM,qBAAqB,GAA2B,IAAI,GAAG,CAAC;IACnE,WAAW;IACX,SAAS;IACT,QAAQ;IACR,WAAW;CACZ,CAAC,CAAC;AAEH,MAAM,UAAU,mBAAmB,CAAC,MAA0B;IAC5D,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,WAAW,CAAC;AACzG,CAAC"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@scrapyio/sdk",
+  "version": "0.1.0",
+  "description": "Official TypeScript/JavaScript SDK for the Scrapy.io Platform API and publisher execution APIs",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "generate": "openapi-typescript ../../docsscrapyio/openapi/platform-v1.yaml -o src/generated/schema.ts && node ./scripts/write-client.mjs",
+    "lint:openapi": "npx --yes @redocly/cli@1.34.3 lint ../../docsscrapyio/openapi/platform-v1.yaml",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "build": "tsc -p tsconfig.json",
+    "test": "node --import tsx --test \"test/sdk.test.ts\"",
+    "test:integration": "node --import tsx --test \"test/integration.test.ts\"",
+    "check": "npm run lint:openapi && npm run generate && npm run typecheck && npm run test",
+    "bootstrap:env": "npx tsx scripts/bootstrap-integration-env.ts",
+    "pack:dry": "npm run build && npm pack --dry-run"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "scrapyio",
+    "scrapy.io",
+    "web-scraping",
+    "sdk"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "openapi-fetch": "^0.14.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "openapi-typescript": "^7.8.0",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2"
+  }
+}