@carddb/core 0.1.0

package/README.md

@@ -0,0 +1,85 @@
+# @carddb/core
+
+Core types and utilities for CardDB JavaScript clients.
+
+> **Note:** This is an internal package. You should use `@carddb/node` or `@carddb/browser` instead.
+
+## Overview
+
+This package provides:
+
+- **Types**: TypeScript type definitions for all CardDB resources
+- **Errors**: Error classes for different error scenarios
+- **Operators**: Filter operator helper functions
+- **FilterBuilder**: Builder pattern for constructing filters
+- **QueryBuilder**: GraphQL query construction
+- **Collection**: Paginated result handling with async iteration
+
+## Exports
+
+### Types
+
+```typescript
+import type {
+  CardDBConfig,
+  Publisher,
+  Game,
+  Dataset,
+  DatasetRecord,
+  DatasetSchema,
+  FieldInfo,
+  Connection,
+  PageInfo,
+  Edge,
+  FilterInput,
+  RateLimitInfo,
+  // ... and more
+} from '@carddb/core'
+```
+
+### Errors
+
+```typescript
+import {
+  CardDBError,
+  AuthenticationError,
+  RateLimitError,
+  NotFoundError,
+  ValidationError,
+  RestrictedError,
+  GraphQLError,
+  ConnectionError,
+  TimeoutError,
+  ServerError,
+} from '@carddb/core'
+```
+
+### Operators
+
+```typescript
+import {
+  eq,
+  neq,
+  gt,
+  gte,
+  lt,
+  lte,
+  within,
+  notWithin,
+  contains,
+  like,
+  ilike,
+  isNull,
+  isNotNull,
+} from '@carddb/core'
+```
+
+### Classes
+
+```typescript
+import { FilterBuilder, QueryBuilder, Collection } from '@carddb/core'
+```
+
+## License
+
+MIT