Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
@bnjmnt4n/supabase-client
Advanced tools
Readme
An alternative TypeScript-based Supabase client.
This package is an alternative to the official @supabase/supabase-js
client, with the intention of experiment with better TypeScript type definitions. In the future, this package might also contain other experiments such as a more tree-shaking-friendly API, and other UX/DX improvements, with the hope that they might eventually be upstreamed into @supabase/supabase-js
v2.
Use of template literals types to construct return type definitions of your queries, without having to manually specify them:
// Before:
// Instead of having to specify the query and the definition:
type WorkspaceWithTeam =
definition["workspaces"] & {
team: {
user: Pick<definition["users"], "id" | "email">;
};
};
supabase
.from<WorkspaceWithTeam>("workspaces")
.select(`
*,
team:members(
user:users(
id,
email
)
)
`);
// After:
// Just specify the query once!
supabase
.from("workspaces")
.select(`
*,
team:members(
user:users(
id,
email
)
)
`);
Type-checking of your select(query)
format
IntelliSense suggestions of fields in filter conditions:
supabase
.from("workspaces")
.select(`
name,
id,
team:members(
user:users(
id,
email
)
)
`)
.filter("|", "eq", X);
// Provides auto-complete suggestions of "name" | "id" | "team.user.id" | "team.user.email"
Install using npm or yarn:
npm i @supabase/supabase-js
npm i --D @bnjmnt4n/supbase-client
For now, this package only provides alternative types for the @supabase/supabase-js
client. TypeScript v4.5.0+ is required.
import { createClient } from "@supabase/supabase-js";
import { type SupabaseClient } from "@bnjmnt4n/supabase-client";
// Type-definitions for each table in your schema. See
import { definitions } from "lib/__generated__/supabase.ts";
const supabase = createClient(SUPABASE_URL, SUPABASE_KEY, OPTIONS)
as unknown as SupabaseClient<definitions>;
const { data, error } = await supabase
.from("users")
.select(`
email,
name,
products(
id,
name
)
`)
.maybeSingle();
if (data) {
data.name;
data.email;
if ("length" in data.products) {
// Array of products.
data.products[0].id;
} else {
// Single products.
data.products.id;
}
}
If there are any issues with the types, you can simply cast the client back to the original type definitions:
import { type SupabaseClient } from "@supabase/supabase-js";
(supabase as unknown as SupabaseClient).from("").select();
Do report any bugs though!
FAQs
An alternative Supabase client.
The npm package @bnjmnt4n/supabase-client receives a total of 0 weekly downloads. As such, @bnjmnt4n/supabase-client popularity was classified as not popular.
We found that @bnjmnt4n/supabase-client demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.