@tabstack/sdk 1.0.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a fee
+      for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may act only on Your own behalf and
+      on Your sole responsibility, not on behalf of any other Contributor,
+      and only if You agree to indemnify, defend, and hold each Contributor
+      harmless for any liability incurred by, or claims asserted against,
+      such Contributor by reason of your accepting any such warranty or
+      additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 TABStack
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,485 @@
+# TABStack AI TypeScript SDK
+
+TypeScript/JavaScript SDK for [TABStack AI](https://tabstack.ai) - Extract, Generate, and Automate web content with AI.
+
+## Features
+
+- **Extract**: Convert web pages to Markdown, generate schemas, and extract structured JSON data
+- **Generate**: Transform web content using AI with custom instructions
+- **Automate**: Execute complex browser automation tasks with natural language
+- **Type-Safe**: Full TypeScript support with comprehensive type definitions
+- **Zero Dependencies**: Uses only Node.js standard library
+- **Universal Module Support**: Works with CommonJS, ESM, and all TypeScript configurations
+
+## Installation
+
+Install the SDK using your preferred package manager:
+
+### npm
+```bash
+npm install @tabstack/sdk
+```
+
+### Yarn
+```bash
+yarn add @tabstack/sdk
+```
+
+### pnpm
+```bash
+pnpm add @tabstack/sdk
+```
+
+### Bun
+```bash
+bun add @tabstack/sdk
+```
+
+### From Source
+
+Clone and build the SDK locally:
+
+```bash
+git clone https://github.com/tabstack/tabs-typescript.git
+cd tabs-typescript
+npm install
+npm run build
+```
+
+To use the local build in your project:
+
+```bash
+# Link the package globally
+npm link
+
+# In your project directory
+npm link @tabstack/sdk
+```
+
+Or install directly from the local path:
+
+```bash
+npm install /path/to/tabs-typescript
+```
+
+## Quick Start
+
+### Get Your API Key
+
+Sign up at [tabstack.ai](https://tabstack.ai) to get your API key.
+
+### Basic Usage
+
+#### ES Modules (ESM)
+```typescript
+import { TABStack } from '@tabstack/sdk';
+
+const tabs = new TABStack({
+  apiKey: process.env.TABSTACK_API_KEY!
+});
+
+// Extract markdown from a URL
+const markdown = await tabs.extract.markdown('https://example.com');
+console.log(markdown.content);
+
+// Extract structured data with JSON schema
+const schema = {
+  type: 'object',
+  properties: {
+    stories: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          title: { type: 'string' },
+          points: { type: 'number' },
+          author: { type: 'string' }
+        },
+        required: ['title', 'points', 'author']
+      }
+    }
+  },
+  required: ['stories']
+};
+
+const data = await tabs.extract.json('https://news.ycombinator.com', schema);
+console.log(data.data);
+```
+
+#### CommonJS
+```javascript
+const { TABStack } = require('@tabstack/sdk');
+
+const tabs = new TABStack({
+  apiKey: process.env.TABSTACK_API_KEY
+});
+
+// Extract markdown
+tabs.extract.markdown('https://example.com')
+  .then(result => {
+    console.log(result.content);
+  })
+  .catch(error => {
+    console.error('Error:', error.message);
+  });
+```
+
+## Core Features
+
+### Extract Markdown
+
+Convert web pages to clean Markdown format:
+
+```typescript
+const result = await tabs.extract.markdown('https://example.com/blog/article', {
+  metadata: true,  // optional: include page metadata
+  nocache: false   // optional: bypass cache
+});
+
+console.log(result.content);
+console.log(result.metadata); // if metadata: true
+```
+
+### Extract Structured Data
+
+Extract data matching a JSON schema:
+
+```typescript
+const schema = {
+  type: 'object',
+  properties: {
+    products: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          name: { type: 'string' },
+          price: { type: 'number' },
+          inStock: { type: 'boolean' }
+        },
+        required: ['name', 'price', 'inStock']
+      }
+    }
+  },
+  required: ['products']
+};
+
+const result = await tabs.extract.json('https://example.com/products', schema);
+console.log(result.data);
+```
+
+### Generate Schema
+
+Generate a JSON schema from web content:
+
+```typescript
+const schema = await tabs.extract.schema('https://news.ycombinator.com', {
+  instructions: 'extract top stories with title, points, and author'
+});
+
+// Use the generated schema for extraction
+const result = await tabs.extract.json('https://news.ycombinator.com', schema);
+console.log(result.data);
+```
+
+### Generate Content
+
+Transform web content using AI:
+
+```typescript
+const schema = {
+  type: 'object',
+  properties: {
+    summaries: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          title: { type: 'string' },
+          category: { type: 'string' },
+          summary: { type: 'string' }
+        },
+        required: ['title', 'category', 'summary']
+      }
+    }
+  },
+  required: ['summaries']
+};
+
+const result = await tabs.generate.json(
+  'https://news.ycombinator.com',
+  schema,
+  'Categorize each story and write a one-sentence summary'
+);
+
+console.log(result.data);
+```
+
+### Automate Tasks
+
+Execute browser automation tasks with streaming updates:
+
+```typescript
+for await (const event of tabs.automate.execute(
+  'Find the top 3 trending repositories and extract their details',
+  {
+    url: 'https://github.com/trending',
+    guardrails: 'browse and extract only',
+    maxIterations: 50
+  }
+)) {
+  console.log(`Event: ${event.type}`);
+
+  if (event.type === 'task:completed') {
+    console.log('Result:', event.data.get('finalAnswer'));
+  } else if (event.type === 'agent:extracted') {
+    console.log('Extracted:', event.data.get('extractedData'));
+  }
+}
+```
+
+## Working with JSON Schemas
+
+The SDK uses standard [JSON Schema](https://json-schema.org/) format for defining data structures. You can define schemas manually or generate them automatically:
+
+### Manual Schema Definition
+
+```typescript
+const schema = {
+  type: 'object',
+  properties: {
+    name: { type: 'string', description: 'Person name' },
+    age: { type: 'number', description: 'Person age' },
+    isActive: { type: 'boolean', description: 'Active status' },
+    tags: {
+      type: 'array',
+      items: { type: 'string' }
+    },
+    addresses: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          street: { type: 'string' },
+          city: { type: 'string' },
+          zipCode: { type: 'number' }
+        },
+        required: ['street', 'city', 'zipCode']
+      }
+    },
+    metadata: {
+      type: 'object',
+      properties: {
+        createdAt: { type: 'string' },
+        updatedAt: { type: 'string' }
+      },
+      required: ['createdAt', 'updatedAt']
+    }
+  },
+  required: ['name', 'age']
+};
+```
+
+### Automatic Schema Generation
+
+Let the AI generate a schema from any webpage:
+
+```typescript
+// Generate schema from content
+const schema = await tabs.extract.schema('https://news.ycombinator.com', {
+  instructions: 'extract stories with title, points, and author'
+});
+
+// Use it immediately
+const data = await tabs.extract.json('https://news.ycombinator.com', schema);
+```
+
+## Error Handling
+
+Handle errors with specific error classes:
+
+```typescript
+import {
+  TABStackError,
+  UnauthorizedError,
+  InvalidURLError,
+  BadRequestError,
+  ServerError
+} from '@tabstack/sdk';
+
+try {
+  const result = await tabs.extract.markdown('https://example.com');
+} catch (error) {
+  if (error instanceof UnauthorizedError) {
+    console.error('Invalid API key');
+  } else if (error instanceof InvalidURLError) {
+    console.error('Invalid or inaccessible URL');
+  } else if (error instanceof TABStackError) {
+    console.error(`API error: ${error.message}`);
+  }
+}
+```
+
+### Error Classes
+
+- `TABStackError` - Base error class
+- `BadRequestError` - 400: Malformed request
+- `UnauthorizedError` - 401: Invalid API key
+- `InvalidURLError` - 422: Invalid or inaccessible URL
+- `ServerError` - 500: Internal server error
+- `ServiceUnavailableError` - 503: Service unavailable
+- `APIError` - Generic API error with status code
+
+## Requirements
+
+- Node.js >= 20.0.0
+- TABStack API key ([get one here](https://tabstack.ai))
+
+## Development & Testing
+
+This SDK includes a comprehensive testing suite with excellent code coverage and type safety.
+
+### Running Tests
+
+```bash
+# Run all tests
+npm test
+
+# Run unit tests only
+npm run test:unit
+
+# Run E2E tests only
+npm run test:e2e
+
+# Run tests in watch mode
+npm run test:watch
+
+# Run tests with coverage report
+npm run test:coverage
+
+# Run TypeScript type tests
+npm run test:types
+```
+
+### Test Structure
+
+The SDK includes multiple types of tests:
+
+**Unit Tests** (`src/**/*.test.ts`)
+- HTTPClient tests - HTTP request/response handling, error scenarios
+- Exception classes tests - Error creation and inheritance
+- Type classes tests - Serialization, deserialization, data access
+- Extract operator tests - Markdown, schema, and JSON extraction
+- Generate operator tests - AI-powered content generation
+- Automate operator tests - SSE streaming and event parsing
+- Client tests - Main client initialization and configuration
+
+**E2E Tests** (`test/e2e/`)
+- Complete workflows from client to operators
+- Real-world use case scenarios
+- Error handling and edge cases
+- Multi-operation workflows
+
+**Type Tests** (`test/types/`)
+- TypeScript type safety validation using `tsd`
+- Generic type inference
+- Type guard verification
+- Compile-time type checking
+
+### Test Coverage
+
+The SDK maintains high test coverage across all modules:
+
+- **172+ test cases** covering all major functionality
+- **~70%+ code coverage** across branches, functions, lines, and statements
+- **Mocked HTTP requests** using `nock` for fast, reliable tests
+- **Type-safe tests** with full TypeScript support
+
+### Test Technologies
+
+- **Jest** - Test runner and assertion library
+- **ts-jest** - TypeScript support for Jest
+- **nock** - HTTP request mocking
+- **tsd** - TypeScript type definition testing
+
+### Writing Tests
+
+When contributing to the SDK, please:
+
+1. Write tests for all new features and bug fixes
+2. Maintain or improve code coverage
+3. Use descriptive test names that explain the behavior being tested
+4. Mock external HTTP requests using `nock`
+5. Test both success and error scenarios
+6. Add type tests for new public APIs
+
+Example test structure:
+
+```typescript
+describe('Feature', () => {
+  describe('method', () => {
+    it('should handle success case', async () => {
+      // Arrange
+      const mockData = { result: 'success' };
+      nock('https://api.tabstack.ai')
+        .post('/endpoint')
+        .reply(200, mockData);
+
+      // Act
+      const result = await client.feature.method();
+
+      // Assert
+      expect(result).toEqual(mockData);
+    });
+
+    it('should handle error case', async () => {
+      nock('https://api.tabstack.ai')
+        .post('/endpoint')
+        .reply(400, { error: 'Bad request' });
+
+      await expect(client.feature.method()).rejects.toThrow(BadRequestError);
+    });
+  });
+});
+```
+
+## Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+### Quick Start for Contributors
+
+```bash
+# Fork and clone the repository
+git clone https://github.com/YOUR_USERNAME/tabs-typescript.git
+cd tabs-typescript
+
+# Install dependencies
+npm install
+
+# Run checks locally before submitting PR
+npm run lint        # Check for linting errors
+npm run format:check # Check formatting
+npm test            # Run all tests
+npm run build       # Verify builds work
+```
+
+### Pull Request Requirements
+
+All PRs must pass these checks before merging:
+
+- ✅ **Lint** - Code style and formatting (ESLint + Prettier)
+- ✅ **Node 20, 22, 24** - Tests and builds on all supported Node versions
+- ✅ **Code Review** - Approval from maintainers
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
+
+## License
+
+Apache
+
+## Support
+
+- Documentation: [https://docs.tabstack.ai](https://docs.tabstack.ai)
+- GitHub Issues: [https://github.com/tabstack/tabs-typescript/issues](https://github.com/tabstack/tabs-typescript/issues)
+- Website: [https://tabstack.ai](https://tabstack.ai)