@relyio/sdk 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @relyio/sdk
 
+## 0.3.0
+
+### Minor Changes
+
+- a8ae363: **Breaking:** `schemaToJSON`, `viewToJSON` and `workflowToJSON` are removed from `@relyio/sdk` and `@relyio/sdk/schema`.
+
+  These converted a schema definition to JSON by stripping the internal `_tag` markers the `define*` helpers attach. Their docstrings described them as being "for the CLI", but the CLI never called them — it has always done the conversion itself, and the two implementations had drifted: the SDK's stripped a single level where the CLI's recurses. A nested content type, component or field kept its `_tag`, so anything built on these functions produced a payload `relyio deploy` would not have produced.
+
+  **If you were calling one of them:** you almost certainly do not need a replacement. `relyio deploy` and `relyio diff` read your schema module and perform the conversion themselves, so passing them a `defineSchema(...)` value is all that is required — as it was before.
+
+  If you need the JSON for something else, such as committing a snapshot or sending it to your own tooling, strip `_tag` **recursively**:
+
+  ```ts
+  function stripTags(value: unknown): unknown {
+    if (Array.isArray(value)) return value.map(stripTags)
+    if (value && typeof value === 'object') {
+      return Object.fromEntries(
+        Object.entries(value)
+          .filter(([key]) => key !== '_tag')
+          .map(([key, entry]) => [key, stripTags(entry)]),
+      )
+    }
+    return value
+  }
+  ```
+
+  That mirrors what the CLI does, so its output matches the payload `relyio deploy` sends. Note that it is a plain recursive walk: values that are not JSON to begin with, such as a `Date`, become `{}` — as they do on the deploy path today.
+
+  Everything you author with is unchanged. `defineSchema`, `defineContentType`, `defineSingleton`, `defineComponent`, `defineSettingsGroup`, `defineQuery`, `defineAssetType`, `defineLocale`, `defineRole`, `defineWorkflow` and `defineView` keep their signatures and their inferred types, and each now has a fixture asserted against the same validator the platform applies at deploy — so an authoring shape the platform would reject fails when we build the SDK rather than when you run `relyio deploy`.
+
+## 0.2.1
+
+### Patch Changes
+
+- 5b58217: Republish so the npm page carries the pre-launch notice.
+
+  npm serves whatever was inside the published tarball, so replacing the README and the package description in the repository changed nothing for anyone looking at the live pages. Only a new version can carry them.
+
+  No source change in any of the four — the whole content of this release is the README and the `description` and `keywords` fields.
+
 ## 0.2.0
 
 ### Minor Changes

package/README.md

@@ -1,314 +1,9 @@
 # @relyio/sdk
 
-The official TypeScript SDK for RelyIO - a type-safe, performant, and developer-friendly client library for interacting with the RelyIO API.
+**RelyIO is coming soon.**
 
-## 🚀 Quick Start
+This package is on npm so its name is reserved and the release pipeline stays exercised end to
+end. It is not ready for general use yet, and its documentation is deliberately not published
+here.
 
-```bash
-npm install @relyio/sdk
-# or
-pnpm add @relyio/sdk
-# or
-yarn add @relyio/sdk
-```
-
-```typescript
-import { createClient, defineSchema, defineContentType, fields } from '@relyio/sdk'
-
-// Define your schema (or import from generated file)
-const product = defineContentType('product', {
-  displayName: 'Product',
-  fields: [
-    fields.shortText('title', { config: { required: true } }),
-    fields.currency('price', { config: { currencyCode: 'USD' } }),
-    fields.select('status', {
-      config: {
-        options: [
-          { value: 'draft', label: 'Draft' },
-          { value: 'active', label: 'Active' },
-        ],
-      },
-    }),
-  ],
-})
-
-const schema = defineSchema({ contentTypes: { product } })
-
-// Create the client
-const client = createClient({
-  apiKey: process.env.RELYIO_API_KEY!,
-  schema,
-})
-
-// Full autocomplete and type safety!
-const products = await client
-  .content('product') // ✅ 'product' autocompletes
-  .query()
-  .where({ status: 'active' }) // ✅ fields autocomplete
-  .limit(10)
-  .execute()
-```
-
-## ✨ Features
-
-- **🔒 100% Type Safe**: Auto-generated types from your schema
-- **⚡ High Performance**: Intelligent caching and request optimization
-- **🔎 Powerful Search**: Full-text, semantic, hybrid, and autocomplete
-- **📦 Batch Operations**: Execute multiple operations in one request
-- **🎯 Developer Friendly**: Fluent APIs with excellent IntelliSense
-- **📦 Tree Shakeable**: Only bundle what you use
-
-## 📖 Usage
-
-### With Schema (Recommended)
-
-```typescript
-import { createClient, defineSchema, defineContentType, fields } from '@relyio/sdk'
-
-const product = defineContentType('product', {
-  displayName: 'Product',
-  fields: [fields.shortText('title'), fields.currency('price'), fields.tags('tags')],
-})
-
-const schema = defineSchema({ contentTypes: { product } })
-
-const client = createClient({
-  apiKey: 'your-api-key',
-  schema, // Enables full type safety
-})
-
-// All methods have full autocomplete!
-await client.content('product').create({
-  title: 'Amazing Widget',
-  price: 49.99,
-  tags: ['new', 'featured'],
-})
-```
-
-### Without Schema (Dynamic)
-
-```typescript
-import { createClient } from '@relyio/sdk'
-
-const client = createClient({
-  apiKey: 'your-api-key',
-})
-
-// Works dynamically without type checking
-const products = await client.content('product').query().where({ status: 'active' }).execute()
-```
-
-## 📚 API Reference
-
-### Content Operations
-
-```typescript
-const products = client.content('product')
-
-// Query with fluent API
-const items = await products
-  .query()
-  .where({ status: 'active', price: { $gte: 50 } })
-  .sort('title', 'asc')
-  .limit(20)
-  .offset(0)
-  .execute()
-
-// Get single item
-const product = await products.fetchOne('product-id')
-
-// Create
-const newProduct = await products.create({
-  title: 'New Product',
-  price: 99.99,
-})
-
-// Update
-const updated = await products.update('product-id', {
-  price: 79.99,
-})
-
-// Delete
-await products.delete('product-id')
-
-// Pagination: the entry list is the cursor dialect, so the body is
-// `{ data, page: { nextCursor, hasMore } }` — there is no total here.
-const page = await products.query().page(1).pageSize(10).executeWithMeta()
-
-console.log(page.data, page.page.hasMore, page.page.nextCursor)
-```
-
-### Search
-
-```typescript
-// Full-text search
-const results = await client
-  .search('wireless headphones')
-  .in('product')
-  .limit(10)
-  .includeScore()
-  .execute()
-
-// Autocomplete suggestions
-const suggestions = await client
-  .autocomplete('wire')
-  .in('product')
-  .field('title')
-  .fuzzy()
-  .limit(5)
-  .execute()
-
-// Find similar items
-const similar = await client.similar('product-id').in('product').locale('fr-FR').limit(5).execute()
-```
-
-### Batch Operations
-
-```typescript
-// Execute multiple operations atomically
-const result = await client
-  .batch()
-  .create('product', { content: { title: 'Product 1', price: 29.99 } })
-  .create('product', { content: { title: 'Product 2', price: 39.99 } })
-  .update('product', 'existing-id', { content: { price: 24.99 } })
-  .delete('product', 'old-id')
-  .execute({ atomic: true })
-
-console.log(result.summary) // { total: 4, succeeded: 4, failed: 0 }
-```
-
-### Singletons
-
-```typescript
-// Fetch singleton
-const homepage = await client.singleton('homepage').fetch()
-
-// Update singleton
-await client.singleton('homepage').update({
-  heroTitle: 'Welcome',
-  heroSubtitle: 'Discover amazing products',
-})
-```
-
-### Settings
-
-```typescript
-// Fetch settings
-const config = await client.settings('site-config').fetch()
-
-// Update settings
-await client.settings('site-config').update({
-  siteName: 'My Store',
-  timezone: 'UTC',
-})
-```
-
-### Ad-hoc Queries
-
-```typescript
-// Build dynamic queries
-const result = await client
-  .adhoc()
-  .from('product')
-  .where({ status: 'active' })
-  .include(['brand', 'categories'])
-  .select({
-    id: '_metadata.id',
-    name: 'title',
-    cost: 'price',
-  })
-  .sort('title', 'asc')
-  .limit(20)
-  .execute()
-```
-
-## 🔧 Configuration
-
-```typescript
-const client = createClient({
-  apiKey: 'your-api-key',
-
-  // API endpoint (defaults to production)
-  baseUrl: 'https://api.relyio.com',
-
-  // Dataset/environment
-  dataset: 'production',
-  environment: 'production',
-
-  // Request settings
-  timeout: 30000,
-  retryAttempts: 3,
-
-  // Debug logging
-  debug: {
-    enabled: true,
-    logger: (level, message, data) => {
-      console.log(`[${level}] ${message}`, data)
-    },
-  },
-
-  // Schema for type safety (optional)
-  schema: mySchema,
-})
-```
-
-## 🆘 Error Handling
-
-```typescript
-import { RelyIONotFoundError, RelyIOValidationError } from '@relyio/sdk'
-
-try {
-  await client.content('product').fetchOne('invalid-id')
-} catch (error) {
-  if (error instanceof RelyIONotFoundError) {
-    console.log('Product not found')
-  } else if (error instanceof RelyIOValidationError) {
-    console.log('Validation errors:', error.validationErrors)
-  }
-}
-```
-
-## 🧪 Testing
-
-```typescript
-// Create a client pointing to your test API
-const testClient = createClient({
-  apiKey: 'test-api-key',
-  baseUrl: 'http://localhost:3200',
-  dataset: 'test',
-})
-```
-
-## 📊 Performance
-
-- **Bundle Size**: < 50KB gzipped
-- **Tree Shaking**: Only bundle features you use
-- **Request Deduplication**: Automatic deduplication of identical requests
-- **Intelligent Caching**: Multi-level caching support
-
-## 📝 TypeScript Support
-
-The SDK is written in TypeScript and provides full type safety:
-
-- Content type names autocomplete from your schema
-- Field names autocomplete in where clauses
-- Create/update data is type-checked against your schema
-- Query results are fully typed
-
-## 🤝 Contributing
-
-We welcome contributions! Please see our [Contributing Guide](../../CONTRIBUTING.md) for details.
-
-## 📄 License
-
-MIT License - see [LICENSE](./LICENSE) file for details.
-
-## 🆘 Support
-
-- 📧 Email: [support@relyio.com](mailto:support@relyio.com)
-- 📖 Documentation: [docs.relyio.com](https://docs.relyio.com)
-- 🐛 Issues: [GitHub Issues](https://github.com/relyio/relyio/issues)
-
----
-
-Built with ❤️ by the RelyIO Team
+There is nothing to follow yet — watch [relyio.com](https://relyio.com) for the launch.