@oxy-hq/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 Additional Liability. 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Titanium Intelligence, Inc.
+
+   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,295 @@
+# Oxy TypeScript SDK
+
+Official TypeScript/JavaScript SDK for interacting with the Oxy data platform.
+
+## Features
+
+- 🚀 **Simple API** - Easy-to-use client for fetching app data
+- 📊 **Parquet Support** - Read and query Parquet files using DuckDB-WASM
+- 🔒 **Type-Safe** - Full TypeScript support with comprehensive type definitions
+- 🌐 **Universal** - Works in both Node.js and browser environments
+- ⚡ **Fast** - Optimized for performance with efficient data handling
+
+## Installation
+
+```bash
+npm install @oxy/sdk
+# or
+yarn add @oxy/sdk
+# or
+pnpm add @oxy/sdk
+```
+
+For Parquet file support, also install DuckDB-WASM:
+
+```bash
+npm install @duckdb/duckdb-wasm
+```
+
+## Quick Start
+
+### Configuration
+
+Set up environment variables:
+
+```bash
+export OXY_URL="https://api.oxy.tech"  # or your self-hosted URL
+export OXY_API_KEY="your-api-key"
+export OXY_PROJECT_ID="your-project-uuid"
+export OXY_BRANCH="main"  # optional
+```
+
+### Basic Usage
+
+```typescript
+import { OxyClient, createConfig } from '@oxy/sdk';
+
+// Create configuration from environment variables
+const config = createConfig();
+
+// Initialize the client
+const client = new OxyClient(config);
+
+// List all apps
+const apps = await client.listApps();
+console.log('Available apps:', apps);
+
+// Get app data
+const data = await client.getAppData('dashboard.app.yml');
+if (!data.error) {
+  console.log('App data:', data.data);
+}
+
+// Fetch a file (e.g., chart image)
+const blob = await client.getFile('charts/sales-chart.png');
+const url = URL.createObjectURL(blob);
+// Use the URL in an <img> tag
+```
+
+### Reading Parquet Files
+
+```typescript
+import { OxyClient, createConfig, readParquet, ParquetReader } from '@oxy/sdk';
+
+const config = createConfig();
+const client = new OxyClient(config);
+
+// Quick read - get all data
+const blob = await client.getFile('data/sales.parquet');
+const data = await readParquet(blob, 1000); // Read first 1000 rows
+console.log(data.columns);
+console.log(data.rows);
+
+// Advanced - query with SQL
+const reader = new ParquetReader('sales');
+await reader.registerParquet(blob);
+
+const result = await reader.query(`
+  SELECT product, SUM(amount) as total_sales
+  FROM sales
+  GROUP BY product
+  ORDER BY total_sales DESC
+  LIMIT 10
+`);
+
+console.log('Top 10 products:', result.rows);
+await reader.close();
+```
+
+## React Integration
+
+### Displaying App Data
+
+```typescript
+import { OxyClient, createConfig } from '@oxy/sdk';
+import { useEffect, useState } from 'react';
+
+const client = new OxyClient(createConfig());
+
+function Dashboard() {
+  const [data, setData] = useState(null);
+
+  useEffect(() => {
+    client.getAppData('dashboard.app.yml')
+      .then(result => setData(result.data))
+      .catch(console.error);
+  }, []);
+
+  if (!data) return <div>Loading...</div>;
+
+  return (
+    <div>
+      <h1>Dashboard</h1>
+      {/* Render your data */}
+    </div>
+  );
+}
+```
+
+### Displaying Parquet Data
+
+```typescript
+import { ParquetReader } from '@oxy/sdk';
+
+function DataTable({ filePath }: { filePath: string }) {
+  const [data, setData] = useState(null);
+
+  useEffect(() => {
+    async function loadData() {
+      const blob = await client.getFile(filePath);
+      const reader = new ParquetReader();
+      await reader.registerParquet(blob);
+      const result = await reader.getAll(100);
+      setData(result);
+      await reader.close();
+    }
+    loadData();
+  }, [filePath]);
+
+  // Render table...
+}
+```
+
+## Use with v0 and Other Sandbox Services
+
+Perfect for integrating Oxy data into v0-generated apps or other sandbox environments:
+
+```typescript
+// In your v0 app
+import { OxyClient, createConfig, readParquet } from '@oxy/sdk';
+
+// Configure with environment variables set in v0 project settings
+const client = new OxyClient(createConfig());
+
+export async function fetchDashboardData() {
+  const [sales, customers] = await Promise.all([
+    client.getAppData('apps/sales.app.yml'),
+    client.getAppData('apps/customers.app.yml'),
+  ]);
+
+  return { sales: sales.data, customers: customers.data };
+}
+
+export function getSalesChartUrl() {
+  return client.getFileUrl('charts/sales-overview.png');
+}
+```
+
+## API Reference
+
+### OxyClient
+
+#### `constructor(config: OxyConfig)`
+
+Creates a new Oxy client instance.
+
+#### `listApps(): Promise<AppItem[]>`
+
+Lists all apps in the project.
+
+#### `getAppData(appPath: string): Promise<AppDataResponse>`
+
+Gets data for a specific app (with caching).
+
+#### `runApp(appPath: string): Promise<AppDataResponse>`
+
+Runs an app and returns fresh data (bypasses cache).
+
+#### `getDisplays(appPath: string): Promise<GetDisplaysResponse>`
+
+Gets display configurations for an app.
+
+#### `getFile(filePath: string): Promise<Blob>`
+
+Fetches a file from the app state directory.
+
+#### `getFileUrl(filePath: string): string`
+
+Returns a URL for direct file access.
+
+### ParquetReader
+
+#### `registerParquet(blob: Blob): Promise<void>`
+
+Registers a Parquet file for querying.
+
+#### `query(sql: string): Promise<QueryResult>`
+
+Executes a SQL query against the Parquet data.
+
+#### `getAll(limit?: number): Promise<QueryResult>`
+
+Gets all data from the Parquet file.
+
+#### `getSchema(): Promise<QueryResult>`
+
+Gets schema information for the Parquet file.
+
+#### `count(): Promise<number>`
+
+Returns the row count.
+
+#### `close(): Promise<void>`
+
+Closes the reader and cleans up resources.
+
+### Helper Functions
+
+#### `createConfig(overrides?: Partial<OxyConfig>): OxyConfig`
+
+Creates configuration from environment variables with optional overrides.
+
+#### `queryParquet(blob: Blob, sql?: string): Promise<QueryResult>`
+
+Quick helper to query a Parquet blob.
+
+#### `readParquet(blob: Blob, limit?: number): Promise<QueryResult>`
+
+Quick helper to read all data from a Parquet blob.
+
+## Environment Variables
+
+- `OXY_URL` - Base URL of the Oxy API (required)
+- `OXY_API_KEY` - API key for authentication (required)
+- `OXY_PROJECT_ID` - Project UUID (required)
+- `OXY_BRANCH` - Branch name (optional)
+
+## Examples
+
+See the [examples](./examples) directory for more detailed examples:
+
+- [basic-usage.ts](./examples/basic-usage.ts) - Basic SDK usage
+- [parquet-usage.ts](./examples/parquet-usage.ts) - Parquet file reading
+- [react-example.tsx](./examples/react-example.tsx) - React integration
+- [react-parquet.tsx](./examples/react-parquet.tsx) - React with Parquet
+- [v0-integration.ts](./examples/v0-integration.ts) - v0 sandbox integration
+
+## Building and Publishing
+
+```bash
+# Install dependencies
+npm install
+
+# Build the SDK
+npm run build
+
+# Type check
+npm run typecheck
+
+# Lint
+npm run lint
+
+# Publish to npm (beta)
+npm run publish:beta
+
+# Publish to npm (latest)
+npm run publish:latest
+```
+
+## License
+
+MIT
+
+## Support
+
+For issues and questions, please visit [GitHub Issues](https://github.com/dataframehq/oxy-internal/issues).