@pooflabs/web 0.0.2 → 0.0.4

package/README.md

@@ -1,130 +1,216 @@
-# @tarobase/web
 
-Web SDK for Tarobase API - Browser/Frontend implementation. This package provides identical functionality to the original `@tarobase/js-sdk` package, but uses a modular architecture with shared functionality in `@tarobase/core`.
+# Tarobase JS SDK
+Tarobase is the web3 alternative to firebase. It is a powerful platform that simplifies the integration of hybrid on-chain actions and data for modern web and mobile applications.
 
-## Installation
+Welcome to the **Tarobase JavaScript SDK**! This SDK allows you to interact with the Tarobase platform seamlessly from your JavaScript or TypeScript applications. Whether you're building a web app, a Node.js service, or a React Native application (support coming soon), the Tarobase JS SDK provides the tools you need.
 
-```bash
-npm install @tarobase/web
-```
 
-## Usage
+## Table of Contents
+- [Installation](#installation)
 
-```typescript
-import { init, login, getCurrentUser, set, get } from '@tarobase/web';
+- [Getting Started](#getting-started)
 
-// Initialize the SDK
-await init({
-  appId: 'your-app-id',
-  authMethod: 'phantom',  // or 'privy'
-});
+	- [Initialization](#initialization)
 
-// Log in
-await login();
+	- [Authentication](#authentication)
 
-// Get the current user
-const user = getCurrentUser();
-console.log(user.address);
+- [Usage Examples](#usage-examples)
 
-// Set data
-await set('todos/123', { text: 'Buy milk', completed: false });
+	- [Initialize the SDK](#initialize-the-sdk)
 
-// Get data
-const todo = await get('todos/123');
-console.log(todo);
-```
+	- [Authenticate a User](#authenticate-a-user)
 
-### React Hook
+	- [Get Current User](#get-current-user)
 
-```typescript
-import { useAuth } from '@tarobase/web';
+	- [Set Data](#set-data)
 
-function MyComponent() {
-  const { user, isLoading, isLoggedIn, login, logout } = useAuth();
+		- [On-Chain and Off-Chain Data](#on-chain-and-off-chain-data)
 
-  if (isLoading) {
-    return <div>Loading...</div>;
-  }
+	- [Get Data](#get-data)
 
-  if (!isLoggedIn) {
-    return <button onClick={login}>Login</button>;
-  }
+- [Additional Resources](#additional-resources)
 
-  return (
-    <div>
-      <p>Logged in as: {user.address}</p>
-      <button onClick={logout}>Logout</button>
-    </div>
-  );
-}
+- [React Native Support](#react-native-support)
+
+- [Contributing](#contributing)
+
+- [License](#license)
+
+  
+
+## Installation
+  
+Install the SDK via npm:
+
+  
+```bash
+npm install @tarobase/js-sdk
+```
+  
+
+Or with Yarn:
+```bash
+yarn add @tarobase/js-sdk
 ```
 
-## Authentication Methods
+  
+
+## Getting Started
+### Initialization
 
-### Phantom Wallet
+  
 
+Before using the SDK, initialize it with your **Application ID**. You can obtain your `appId` by creating an application on the [Tarobase Console](https://console.tarobase.com). The console also allows you to configure your application's policies, including data storage preferences (on-chain or off-chain) and data schemas.
+
+  
 ```typescript
-await init({
-  appId: 'your-app-id',
-  authMethod: 'phantom'
-});
-```
+import { init } from '@tarobase/js-sdk';
+
+init({appId: 'YOUR_APP_ID' });
+```  
+
+### Authentication
 
-### Privy Wallet
+  
+To authenticate users, use the `login` function:
 
 ```typescript
-await init({
-  appId: 'your-app-id',
-  authMethod: 'privy',
-  privyConfig: {
-    appId: 'your-privy-app-id',
-    config: {
-      // Privy configuration options
-      embeddedWallets: {
-        solana: {
-          createOnLogin: "users-without-wallets"
-        }
-      }
-    }
-  }
+import { login } from '@tarobase/js-sdk';
+
+// Start the login process
+login();
+```
+
+You can also listen for authentication state changes:
+  
+```typescript
+import { onAuthStateChanged } from '@tarobase/js-sdk';
+
+onAuthStateChanged((user) => {
+	if (user) {
+		console.log('User logged in:', user.address);
+	} else {
+		console.log('User logged out');
+	}
 });
 ```
 
-## API Reference
+  
+
+## Usage
+
+### Get Current User
 
-### Initialization
 
 ```typescript
-function init(newConfig: Partial<ClientConfig>): Promise<void>;
+import { getCurrentUser } from '@tarobase/js-sdk';
+
+const user = await getCurrentUser();
+if (user) {
+	console.log('Current user:', user.address);
+} else {
+	console.log('No user is currently logged in.');
+}
 ```
 
-### Authentication
+  
 
+### Set Data
 ```typescript
-function login(): Promise<User | null>;
-function logout(): Promise<void>;
-function getCurrentUser(): User | null;
-function onAuthStateChanged(callback: (user: User | null) => void): void;
+import { set } from '@tarobase/js-sdk';
+
+const path = 'path/to/data';
+const data = { key: 'value' };
+
+await set(path, data);
+
+console.log(`Data set at ${path}`);
 ```
+  
+
+#### On-Chain and Off-Chain Data
+
+The `set` and `get` functions automatically handle whether data is stored **on-chain** or **off-chain** based on your application's policy configuration in the [Tarobase Console](https://console.tarobase.com).
+  
+
+**On-Chain Data:**
+
+- If the data path corresponds to on-chain storage defined in your application policy, the `set` function will store data on-chain.
+
+- The data must adhere to the `fields` schema defined in your Tarobase policy.
+
+- Transactions are handled automatically, and users may be prompted to approve blockchain transactions.
+
+**Off-Chain Data:**
+
+- If the data path corresponds to off-chain storage, the `set` function will store data off-chain.
+
+  
+
+**Important:**
+
+  
+
+- Manage your data storage preferences and define policies at the [Tarobase Console](https://console.tarobase.com).
+
+- Ensure that for on-chain data, the parameters you provide to `set` match the `fields` specified in your Tarobase policy.
 
-### Data Operations
+- The policy also controls what can be `set` or `get` in your application.
+
+- For information on how to form your policy specifically for your app's use-cases, view the policy docs [here](https://docs.tarobase.com/policies).
+
+  
+### Subscribe
 
 ```typescript
-function get(path: string): Promise<any>;
-function set(path: string, data: any, options?: SetOptions): Promise<any>;
-function setMany(paths: { [key: string]: any }, options?: SetOptions): Promise<any>;
-function setFile(path: string, file: File, metadata?: any): Promise<any>;
-function getFiles(path: string): Promise<any>;
-function runQuery(queryString: string, variables?: any): Promise<any>;
-function runQueryMany(queryString: string, variables?: any): Promise<any>;
+await subscribe('path/to/data', {}, (data) => { 
+	console.log('Data updated:', data); }
+);
 ```
 
-### Subscriptions
+
+### Get Data
 
 ```typescript
-function subscribe(path: string, options?: SubscriptionOptions): Promise<() => void>;
+import { get } from '@tarobase/js-sdk';
+
+const path = 'messages/abc123';
+const data = await get(path);
+
+const collection = 'messages';
+// For colletion queries, include a plain english prompt to filter your results accordingly,
+// smart queries will be constructed on your behalf by tarobase.
+const data = await get(path, { prompt: "where text starts with the letter f" });
+
+console.log(`Data at ${path}:`, data);
 ```
 
-## Contributing
+**Note:** Similar to `set`, the `get` and `subscribe` functions will automatically retrieve data from on-chain or off-chain storage based on your application's configuration.
+
+
+  
+
+### Additional Resources
+For more comprehensive examples, detailed guides, and API references, please visit our documentation site:
+
+- [Tarobase Documentation](https://docs.tarobase.com)
+
+- Quickstart Guide
+
+- [API Reference](https://docs.tarobase.com/api)
+
+
+### React Native Support  
+Support for **React Native** is coming soon! Stay tuned for updates, and feel free to check back on our [documentation site](https://docs.tarobase.com) for the latest information.
+
+### Contributing
+Contributions are welcome! Please open an issue or submit a pull request on GitHub.
+
+### License
+This Tarobase JS SDK project is licensed under the MIT License.
+
+* * * * *
+  
+
+Thank you for using the Tarobase JS SDK! If you have any questions or need further assistance, feel free to crete an issue.
 
-Please see the main repository for contribution guidelines.

package/dist/auth/hooks/useAuth.d.ts

@@ -1,4 +1,4 @@
-import { User } from '@tarobase/core';
+import { User } from '../../types';
 export interface UseAuthResult {
     login: () => Promise<void>;
     logout: () => Promise<void>;

package/dist/auth/index.d.ts

@@ -1,5 +1,6 @@
-import { AuthProvider, User } from '@tarobase/core';
+export { deserializeTransaction } from './providers/sol/sol-utils';
+import { AuthProvider, User } from '../types';
+export declare const SURFNET_RPC_URL = "https://surfpool.fly.dev";
 export declare function getAuthProvider(): Promise<AuthProvider>;
-export declare function matchAuthProvider(appName: string | null, appLogoUrl: string | null, authMethod: string, rpcUrl: string, privyConfig?: any): Promise<AuthProvider>;
 export declare function login(): Promise<User | null>;
 export declare function logout(): Promise<void>;

package/dist/auth/providers/phantom-wallet-provider.d.ts

@@ -1,7 +1,7 @@
-import type { EVMTransaction, SolTransaction, TransactionResult, User, AuthProvider } from '@tarobase/core';
+import type { EVMTransaction, SolTransaction, TransactionResult, User, AuthProvider } from '../../types';
 import { PublicKey, Transaction, VersionedTransaction } from '@solana/web3.js';
 import { CreatePhantomConfig } from '@phantom/wallet-sdk';
-import { SetOptions } from '@tarobase/core';
+import { SetOptions } from '../../client/operations';
 export declare class PhantomWalletProvider implements AuthProvider {
     private connection;
     private initialized;
@@ -45,6 +45,7 @@ export declare class PhantomWalletProvider implements AuthProvider {
     restoreSession(): Promise<User | null>;
     address(): Promise<string | null>;
     runTransaction(evmTransactionData?: EVMTransaction, solTransactionData?: SolTransaction, options?: SetOptions): Promise<TransactionResult>;
+    signTransaction(transaction: Transaction | VersionedTransaction): Promise<Transaction | VersionedTransaction>;
     signMessage(message: string): Promise<string>;
     logout(): Promise<void>;
     getNativeMethods(): Promise<any>;

package/dist/auth/providers/privy-wallet-provider.d.ts

@@ -1,6 +1,7 @@
-import type { EVMTransaction, SolTransaction, TransactionResult } from '@tarobase/core';
-import { AuthProvider, User } from '@tarobase/core';
-import { SetOptions } from '@tarobase/core';
+import type { EVMTransaction, SolTransaction, TransactionResult } from '../../types';
+import { AuthProvider, User } from '../../types';
+import { Transaction, VersionedTransaction } from '@solana/web3.js';
+import { SetOptions } from '../../client/operations';
 export declare class PrivyWalletProvider implements AuthProvider {
     private static instance;
     private containerElement;
@@ -20,6 +21,7 @@ export declare class PrivyWalletProvider implements AuthProvider {
     getNativeMethods(): Promise<any>;
     logout(): Promise<void>;
     runTransaction(_evmTransactionData?: EVMTransaction, solTransactionData?: SolTransaction, options?: SetOptions): Promise<TransactionResult>;
+    signTransaction(transaction: Transaction | VersionedTransaction): Promise<Transaction | VersionedTransaction>;
     signMessage(message: string): Promise<string>;
     restoreSession(): Promise<User | null>;
     private createSession;