@data-loom/js 0.0.2-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dataloom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,354 @@
+## Usage
+
+### Install
+
+```sh
+npm install @data-loom/js
+```
+
+
+### Initializing
+
+```js
+import { createClient } from '@data-loom/js'
+
+// Create a single dataloom client for interacting with your database
+const dataloom = createClient('https://xyzcompany.feishu.cn/suda/api/v1/workspaces/workspace_abc', 'public-anon-key')
+```
+
+### Fetch data
+Perform a SELECT query on the table or view.
+
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select()
+```
+参数
+
+| 参数名称 | 必需 | 类型   | 描述 |
+| -------- | ----| ------ | ---- |
+| `columns`    | Optional   | Query | The columns to retrieve, separated by commas. Columns can be renamed when returned with `customName:columnName` |
+| `options`    | Required   | object | Named parameters |
+
+
+`options` 对象
+
+| 参数名称        | 必需 | 类型   | 描述 |
+| --------------- | ---- | ------ | ---- |
+| `count`            | Optional   | `exact` `planned` `estimated` | Count algorithm to use to count rows in the table or view. |
+| `head`          | Optional   | boolean | When set to `true`, data will not be returned. Useful if you only need the count. |
+
+### Insert data
+Perform an INSERT into the table or view.
+
+```js
+const { error } = await dataloom
+  .from('countries')
+  .insert({ id: 1, name: 'Mordor' })
+
+
+```
+参数
+
+| 参数名称 | 必需 | 类型   | 描述 |
+| -------- | ----| ------ | ---- |
+| `values`    | Required   | `Row` `Array<Row>` | The values to insert. Pass an object to insert a single row or an array to insert multiple rows. |
+| `options`    | Optional   | object | Named parameters |
+
+
+`options` 对象
+
+| 参数名称        | 必需 | 类型   | 描述 |
+| --------------- | ---- | ------ | ---- |
+| `count`            | Optional   | `exact` `planned` `estimated` | Count algorithm to use to count inserted rows. |
+| `defaultToNull`          | Optional   | boolean | Make missing fields default to `null`. Otherwise, use the default value for the column. Only applies for bulk inserts. |
+
+### Update data
+Perform an UPDATE on the table or view.
+
+```js
+const { error } = await dataloom
+  .from('instruments')
+  .update({ name: 'piano' })
+  .eq('id', 1)
+
+```
+参数
+
+| 参数名称 | 必需 | 类型   | 描述 |
+| -------- | ----| ------ | ---- |
+| `values`    | Required   | `Row` | The values to update with |
+| `options`    | Required   | object | Named parameters |
+
+
+`options` 对象
+
+| 参数名称        | 必需 | 类型   | 描述 |
+| --------------- | ---- | ------ | ---- |
+| `count`            | Optional   | `exact` `planned` `estimated` | Count algorithm to use to count updated rows. |
+
+### Delete data
+Perform a DELETE on the table or view.
+
+```js
+const response = await dataloom
+  .from('countries')
+  .delete()
+  .eq('id', 1)
+
+```
+参数
+
+| 参数名称 | 必需 | 类型   | 描述 |
+| -------- | ----| ------ | ---- |
+| `options`    | Required   | object | Named parameters |
+
+
+`options` 对象
+
+| 参数名称        | 必需 | 类型   | 描述 |
+| --------------- | ---- | ------ | ---- |
+| `count`            | Optional   | `exact` `planned` `estimated` | Count algorithm to use to count updated rows. |
+
+### Using filters
+Filters allow you to only return rows that match certain conditions.  
+Filters can be used on select(), update(), upsert(), and delete() queries.
+
+* Column is equal to a value
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select()
+  .eq('name', 'Leia')
+```
+
+* Column is not equal to a value
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select()
+  .neq('name', 'Leia')
+```
+
+* Column is greater than a value
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select()
+  .gt('id', 2)
+```
+
+* Column is greater than or equal to a value
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select()
+  .gte('id', 2)
+```
+
+* Column is less than a value
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select()
+  .lt('id', 2)
+```
+
+* Column is less than or equal to a value
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select()
+  .lte('id', 2)
+```
+
+* Column matches a pattern
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select()
+  .like('name', '%Lu%')
+```
+
+* Column matches a case-insensitive pattern
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select()
+  .ilike('name', '%lu%')
+```
+
+* Column is a value
+```js
+const { data, error } = await dataloom
+  .from('countries')
+  .select()
+  .is('name', null)
+```
+
+* Column is in an array
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select()
+  .in('name', ['Leia', 'Han'])
+```
+
+* Column contains every element in a value
+```js
+const { data, error } = await dataloom
+  .from('issues')
+  .select()
+  .contains('tags', ['is:open', 'priority:low'])
+```
+
+* Contained by value
+```js
+const { data, error } = await dataloom
+  .from('classes')
+  .select('name')
+  .containedBy('days', ['monday', 'tuesday', 'wednesday', 'friday'])
+```
+
+* Greater than a range
+```js
+const { data, error } = await dataloom
+  .from('reservations')
+  .select()
+  .rangeGt('during', '[2000-01-02 08:00, 2000-01-02 09:00)')
+```
+
+* Greater than or equal to a range
+```js
+const { data, error } = await dataloom
+  .from('reservations')
+  .select()
+  .rangeGte('during', '[2000-01-02 08:30, 2000-01-02 09:30)')
+```
+
+* Less than a range
+```js
+const { data, error } = await dataloom
+  .from('reservations')
+  .select()
+  .rangeLt('during', '[2000-01-01 15:00, 2000-01-01 16:00)')
+```
+
+* Less than or equal to a range
+```js
+const { data, error } = await dataloom
+  .from('reservations')
+  .select()
+  .rangeLte('during', '[2000-01-01 14:00, 2000-01-01 16:00)')
+```
+
+* Mutually exclusive to a range
+```js
+const { data, error } = await dataloom
+  .from('reservations')
+  .select()
+  .rangeAdjacent('during', '[2000-01-01 12:00, 2000-01-01 13:00)')
+```
+
+* With a common element
+```js
+const { data, error } = await dataloom
+  .from('issues')
+  .select('title')
+  .overlaps('tags', ['is:closed', 'severity:high'])
+```
+
+* Match a string
+```js
+const result = await dataloom
+  .from("texts")
+  .select("content")
+  .textSearch("content", `'eggs' & 'ham'`, {
+    config: "english",
+  });
+```
+
+* Match an associated value
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select('name')
+  .match({ id: 2, name: 'Leia' })
+```
+
+* Don't match the filter
+```js
+const { data, error } = await dataloom
+  .from('countries')
+  .select()
+  .not('name', 'is', null)
+```
+
+* Don't match the filter
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select('name')
+  .or('id.eq.2,name.eq.Han')
+```
+
+* Match the filter
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select()
+  .filter('name', 'in', '("Han","Yoda")')
+```
+
+### Using modifiers
+Filters work on the row level—they allow you to return rows that only match certain conditions without changing the shape of the rows. Modifiers are everything that don't fit that definition—allowing you to change the format of the response (e.g., returning a CSV string).  
+Modifiers must be specified after filters. Some modifiers only apply for queries that return rows
+
+* Order the results
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select('id, name')
+  .order('id', { ascending: false })
+```
+
+* Limit the number of rows returned
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select('name')
+  .limit(1)
+```
+
+* Limit the query to a range
+```js
+const { data, error } = await dataloom
+  .from('countries')
+  .select('name')
+  .range(0, 1)
+```
+
+* Retrieve one row of data
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select('name')
+  .limit(1)
+  .single()
+```
+
+* Retrieve zero or one row of data
+```js
+const { data, error } = await dataloom
+  .from('characters')
+  .select()
+  .eq('name', 'Katniss')
+  .maybeSingle()
+```
+
+## Acknowledgements
+
+This project references the implementation of [@supabase/supabase-js](https://github.com/supabase/supabase-js).
+
+[@supabase/supabase-js](https://github.com/supabase/supabase-js) is licensed under the MIT License.

package/dist/main/SupabaseClient.d.ts

@@ -0,0 +1,116 @@
+import { FunctionsClient } from '@data-loom/functions-js';
+import { PostgrestClient, PostgrestFilterBuilder, PostgrestQueryBuilder } from '@data-loom/postgrest-js';
+import { RealtimeChannel, RealtimeChannelOptions, RealtimeClient } from '@data-loom/realtime-js';
+import { SupabaseAuthClient } from './utils/SupabaseAuthClient';
+import { Fetch, GenericSchema, SupabaseClientOptions } from './utils/types';
+/**
+ * Supabase Client.
+ *
+ * An isomorphic Javascript client for interacting with Postgres.
+ */
+export default class SupabaseClient<Database = any, SchemaName extends string & keyof Database = 'public' extends keyof Database ? 'public' : string & keyof Database, Schema extends GenericSchema = Database[SchemaName] extends GenericSchema ? Database[SchemaName] : any> {
+    protected supabaseUrl: string;
+    protected supabaseKey: string;
+    /**
+     * Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies.
+     */
+    auth: SupabaseAuthClient;
+    realtime: RealtimeClient;
+    protected realtimeUrl: string;
+    protected authUrl: string;
+    protected storageUrl: string;
+    protected functionsUrl: string;
+    protected rest: PostgrestClient<Database, SchemaName, Schema>;
+    protected storageKey: string;
+    protected fetch?: Fetch;
+    protected changedAccessToken?: string;
+    protected accessToken?: () => Promise<string | null>;
+    protected headers: Record<string, string>;
+    /**
+     * Create a new client for use in the browser.
+     * @param supabaseUrl The unique Supabase URL which is supplied when you create a new project in your project dashboard.
+     * @param supabaseKey The unique Supabase Key which is supplied when you create a new project in your project dashboard.
+     * @param options.db.schema You can switch in between schemas. The schema needs to be on the list of exposed schemas inside Supabase.
+     * @param options.auth.autoRefreshToken Set to "true" if you want to automatically refresh the token before expiring.
+     * @param options.auth.persistSession Set to "true" if you want to automatically save the user session into local storage.
+     * @param options.auth.detectSessionInUrl Set to "true" if you want to automatically detects OAuth grants in the URL and signs in the user.
+     * @param options.realtime Options passed along to realtime-js constructor.
+     * @param options.global.fetch A custom fetch implementation.
+     * @param options.global.headers Any additional headers to send with each network request.
+     */
+    constructor(supabaseUrl: string, supabaseKey: string, options?: SupabaseClientOptions<SchemaName>);
+    /**
+     * Supabase Functions allows you to deploy and invoke edge functions.
+     */
+    get functions(): FunctionsClient;
+    /**
+     * Supabase Storage allows you to manage user-generated content, such as photos or videos.
+    //  */
+    from<TableName extends string & keyof Schema['Tables'], Table extends Schema['Tables'][TableName]>(relation: TableName): PostgrestQueryBuilder<Schema, Table, TableName>;
+    from<ViewName extends string & keyof Schema['Views'], View extends Schema['Views'][ViewName]>(relation: ViewName): PostgrestQueryBuilder<Schema, View, ViewName>;
+    /**
+     * Select a schema to query or perform an function (rpc) call.
+     *
+     * The schema needs to be on the list of exposed schemas inside Supabase.
+     *
+     * @param schema - The schema to query
+     */
+    schema<DynamicSchema extends string & keyof Database>(schema: DynamicSchema): PostgrestClient<Database, DynamicSchema, Database[DynamicSchema] extends GenericSchema ? Database[DynamicSchema] : any>;
+    /**
+     * Perform a function call.
+     *
+     * @param fn - The function name to call
+     * @param args - The arguments to pass to the function call
+     * @param options - Named parameters
+     * @param options.head - When set to `true`, `data` will not be returned.
+     * Useful if you only need the count.
+     * @param options.get - When set to `true`, the function will be called with
+     * read-only access mode.
+     * @param options.count - Count algorithm to use to count rows returned by the
+     * function. Only applicable for [set-returning
+     * functions](https://www.postgresql.org/docs/current/functions-srf.html).
+     *
+     * `"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the
+     * hood.
+     *
+     * `"planned"`: Approximated but fast count algorithm. Uses the Postgres
+     * statistics under the hood.
+     *
+     * `"estimated"`: Uses exact count for low numbers and planned count for high
+     * numbers.
+     */
+    rpc<FnName extends string & keyof Schema['Functions'], Fn extends Schema['Functions'][FnName]>(fn: FnName, args?: Fn['Args'], options?: {
+        head?: boolean;
+        get?: boolean;
+        count?: 'exact' | 'planned' | 'estimated';
+    }): PostgrestFilterBuilder<Schema, Fn['Returns'] extends any[] ? Fn['Returns'][number] extends Record<string, unknown> ? Fn['Returns'][number] : never : never, Fn['Returns'], FnName, null>;
+    /**
+     * Creates a Realtime channel with Broadcast, Presence, and Postgres Changes.
+     *
+     * @param {string} name - The name of the Realtime channel.
+     * @param {Object} opts - The options to pass to the Realtime channel.
+     *
+     */
+    channel(name: string, opts?: RealtimeChannelOptions): RealtimeChannel;
+    /**
+     * Returns all Realtime channels.
+     */
+    getChannels(): RealtimeChannel[];
+    /**
+     * Unsubscribes and removes Realtime channel from Realtime client.
+     *
+     * @param {RealtimeChannel} channel - The name of the Realtime channel.
+     *
+     */
+    removeChannel(channel: RealtimeChannel): Promise<'ok' | 'timed out' | 'error'>;
+    /**
+     * Unsubscribes and removes all Realtime channels from Realtime client.
+     */
+    removeAllChannels(): Promise<('ok' | 'timed out' | 'error')[]>;
+    private _getAccessToken;
+    private _initSupabaseAuthClient;
+    private _initRealtimeClient;
+    private _listenForAuthEvents;
+    private _handleTokenChanged;
+}
+//# sourceMappingURL=SupabaseClient.d.ts.map

package/dist/main/SupabaseClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SupabaseClient.d.ts","sourceRoot":"","sources":["../../src/SupabaseClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAEzD,OAAO,EACL,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACtB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,eAAe,EACf,sBAAsB,EACtB,cAAc,EAEf,MAAM,wBAAwB,CAAA;AAU/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAC/D,OAAO,EACL,KAAK,EACL,aAAa,EACb,qBAAqB,EAEtB,MAAM,eAAe,CAAA;AAEtB;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc,CACjC,QAAQ,GAAG,GAAG,EACd,UAAU,SAAS,MAAM,GAAG,MAAM,QAAQ,GAAG,QAAQ,SAAS,MAAM,QAAQ,GACxE,QAAQ,GACR,MAAM,GAAG,MAAM,QAAQ,EAC3B,MAAM,SAAS,aAAa,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,aAAa,GACrE,QAAQ,CAAC,UAAU,CAAC,GACpB,GAAG;IAiCL,SAAS,CAAC,WAAW,EAAE,MAAM;IAC7B,SAAS,CAAC,WAAW,EAAE,MAAM;IAhC/B;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAA;IACxB,QAAQ,EAAE,cAAc,CAAA;IAExB,SAAS,CAAC,WAAW,EAAE,MAAM,CAAA;IAC7B,SAAS,CAAC,OAAO,EAAE,MAAM,CAAA;IACzB,SAAS,CAAC,UAAU,EAAE,MAAM,CAAA;IAC5B,SAAS,CAAC,YAAY,EAAE,MAAM,CAAA;IAC9B,SAAS,CAAC,IAAI,EAAE,eAAe,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC,CAAA;IAC7D,SAAS,CAAC,UAAU,EAAE,MAAM,CAAA;IAC5B,SAAS,CAAC,KAAK,CAAC,EAAE,KAAK,CAAA;IACvB,SAAS,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IACrC,SAAS,CAAC,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IAEpD,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAEzC;;;;;;;;;;;OAWG;gBAES,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EAC7B,OAAO,CAAC,EAAE,qBAAqB,CAAC,UAAU,CAAC;IAgE7C;;OAEG;IACH,IAAI,SAAS,IAAI,eAAe,CAK/B;IAED;;UAEM;IAMN,IAAI,CACF,SAAS,SAAS,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,EACjD,KAAK,SAAS,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,EACzC,QAAQ,EAAE,SAAS,GAAG,qBAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC;IACvE,IAAI,CAAC,QAAQ,SAAS,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,SAAS,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAC1F,QAAQ,EAAE,QAAQ,GACjB,qBAAqB,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC;IAWhD;;;;;;OAMG;IACH,MAAM,CAAC,aAAa,SAAS,MAAM,GAAG,MAAM,QAAQ,EAClD,MAAM,EAAE,aAAa,GACpB,eAAe,CAChB,QAAQ,EACR,aAAa,EACb,QAAQ,CAAC,aAAa,CAAC,SAAS,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,GAAG,CAC9E;IAKD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,GAAG,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,SAAS,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,EAC3F,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,EAAE,CAAC,MAAM,CAAM,EACrB,OAAO,GAAE;QACP,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,GAAG,CAAC,EAAE,OAAO,CAAA;QACb,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,WAAW,CAAA;KACrC,GACL,sBAAsB,CACvB,MAAM,EACN,EAAE,CAAC,SAAS,CAAC,SAAS,GAAG,EAAE,GACvB,EAAE,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACnD,EAAE,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,GACrB,KAAK,GACP,KAAK,EACT,EAAE,CAAC,SAAS,CAAC,EACb,MAAM,EACN,IAAI,CACL;IAID;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,sBAAuC,GAAG,eAAe;IAIrF;;OAEG;IACH,WAAW,IAAI,eAAe,EAAE;IAIhC;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,GAAG,WAAW,GAAG,OAAO,CAAC;IAI9E;;OAEG;IACH,iBAAiB,IAAI,OAAO,CAAC,CAAC,IAAI,GAAG,WAAW,GAAG,OAAO,CAAC,EAAE,CAAC;YAIhD,eAAe;IAU7B,OAAO,CAAC,uBAAuB;IAqC/B,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,oBAAoB;IAO5B,OAAO,CAAC,mBAAmB;CAgB5B"}