@squadbase/react 0.0.1 → 0.0.2-dev.1

package/dist/index.cjs

@@ -21,6 +21,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   SquadbaseProvider: () => SquadbaseProvider,
+  StorageUploadsClient: () => StorageUploadsClient,
+  useStorage: () => useStorage,
   useUser: () => useUser
 });
 module.exports = __toCommonJS(index_exports);
@@ -70,8 +72,186 @@ var import_jsx_runtime2 = require("react/jsx-runtime");
 function SquadbaseProvider({ children }) {
   return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(UserProvider, { children });
 }
+
+// src/storage.tsx
+var import_zod2 = require("zod");
+var STORAGE_BASE_PATH = "/_sqcore/storage";
+var zApiListItem = import_zod2.z.object({
+  key: import_zod2.z.string(),
+  size: import_zod2.z.number(),
+  lastModified: import_zod2.z.string()
+});
+var zApiListResult = import_zod2.z.object({
+  objects: import_zod2.z.array(zApiListItem),
+  commonPrefixes: import_zod2.z.array(import_zod2.z.string()).default([]),
+  nextCursor: import_zod2.z.string().optional()
+});
+var zApiMetadata = import_zod2.z.object({
+  key: import_zod2.z.string(),
+  size: import_zod2.z.number(),
+  contentType: import_zod2.z.string(),
+  createdAt: import_zod2.z.string(),
+  createdBy: import_zod2.z.string(),
+  source: import_zod2.z.enum(["upload", "agent", "system"])
+});
+var zApiPresignedGet = import_zod2.z.object({
+  url: import_zod2.z.string(),
+  expiresAt: import_zod2.z.string()
+});
+var zApiPresignedPut = import_zod2.z.object({
+  url: import_zod2.z.string(),
+  headers: import_zod2.z.record(import_zod2.z.string(), import_zod2.z.string()),
+  expiresAt: import_zod2.z.string()
+});
+var storageUrl = (path, query) => {
+  const params = new URLSearchParams();
+  for (const [key, value] of Object.entries(query ?? {})) {
+    if (value != null) params.set(key, value);
+  }
+  const qs = params.toString();
+  return `${STORAGE_BASE_PATH}${path}${qs.length > 0 ? `?${qs}` : ""}`;
+};
+var throwIfNotOk = async (res, label) => {
+  if (res.ok) return;
+  const text = await res.text();
+  throw new Error(
+    `Project Storage ${label} failed: ${res.status} ${res.statusText}: ${text}`
+  );
+};
+var StorageUploadsClient = class {
+  /**
+   * Lists files under a prefix. Pass `delimiter: "/"` for a folder-style
+   * listing, or omit it for a flat recursive listing.
+   */
+  async list(prefix, options) {
+    const res = await fetch(
+      storageUrl("/list", {
+        prefix,
+        limit: options?.limit != null ? String(options.limit) : void 0,
+        cursor: options?.cursor,
+        delimiter: options?.delimiter
+      }),
+      { credentials: "include" }
+    );
+    await throwIfNotOk(res, "list");
+    const data = zApiListResult.parse(await res.json());
+    return {
+      objects: data.objects.map((o) => ({
+        key: o.key,
+        size: o.size,
+        lastModified: o.lastModified
+      })),
+      commonPrefixes: data.commonPrefixes,
+      nextCursor: data.nextCursor
+    };
+  }
+  /**
+   * Fetches a file's metadata without reading its body.
+   */
+  async head(key) {
+    const res = await fetch(storageUrl("/head", { key }), {
+      credentials: "include"
+    });
+    await throwIfNotOk(res, "head");
+    const data = zApiMetadata.parse(await res.json());
+    return {
+      key: data.key,
+      size: data.size,
+      contentType: data.contentType,
+      createdAt: data.createdAt
+    };
+  }
+  /**
+   * Returns a short-lived presigned GET URL for a file. Re-fetch before
+   * `expiresAt` to keep the URL valid.
+   */
+  async getUrl(key) {
+    const res = await fetch(storageUrl("/sign", { key }), {
+      credentials: "include"
+    });
+    await throwIfNotOk(res, "getUrl");
+    const data = zApiPresignedGet.parse(await res.json());
+    return { url: data.url, expiresAt: data.expiresAt };
+  }
+  /**
+   * Fetches a file's contents and returns the raw `Response`. Use the standard
+   * `Response` methods (`.text()` / `.json()` / `.blob()` / `.arrayBuffer()`)
+   * to read the body.
+   */
+  async get(key) {
+    const { url } = await this.getUrl(key);
+    const res = await fetch(url, { method: "GET" });
+    await throwIfNotOk(res, "get");
+    return res;
+  }
+  /**
+   * Uploads a file. `data` may be a `Blob` (including `File`), `ArrayBuffer`,
+   * `Uint8Array`, or `string`.
+   */
+  async put(key, data, options) {
+    const contentType = options?.contentType ?? "application/octet-stream";
+    const body = typeof data === "string" ? new Blob([data], { type: contentType }) : data;
+    const contentLength = body instanceof Blob ? body.size : body.byteLength;
+    const signRes = await fetch(storageUrl("/sign"), {
+      method: "POST",
+      credentials: "include",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ key, contentType, contentLength })
+    });
+    await throwIfNotOk(signRes, "put (sign)");
+    const signed = zApiPresignedPut.parse(await signRes.json());
+    const putRes = await fetch(signed.url, {
+      method: "PUT",
+      headers: signed.headers,
+      body
+    });
+    await throwIfNotOk(putRes, "put (S3)");
+  }
+  /**
+   * Deletes a file.
+   */
+  async delete(key) {
+    const res = await fetch(storageUrl("/objects", { key }), {
+      method: "DELETE",
+      credentials: "include"
+    });
+    await throwIfNotOk(res, "delete");
+  }
+  /**
+   * Copies a file to a new key.
+   */
+  async copy(srcKey, destKey, options) {
+    const res = await fetch(storageUrl("/copy"), {
+      method: "POST",
+      credentials: "include",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ srcKey, destKey, overwrite: options?.overwrite })
+    });
+    await throwIfNotOk(res, "copy");
+  }
+  /**
+   * Moves (renames) a file to a new key.
+   */
+  async move(srcKey, destKey, options) {
+    const res = await fetch(storageUrl("/move"), {
+      method: "POST",
+      credentials: "include",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ srcKey, destKey, overwrite: options?.overwrite })
+    });
+    await throwIfNotOk(res, "move");
+  }
+};
+var storageClient = {
+  uploads: new StorageUploadsClient()
+};
+function useStorage() {
+  return storageClient;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   SquadbaseProvider,
+  StorageUploadsClient,
+  useStorage,
   useUser
 });

package/dist/index.d.cts

@@ -26,4 +26,101 @@ type UserState = {
 };
 declare function useUser(): UserState;
 
-export { SquadbaseProvider, type User, type UserState, useUser };
+/** A single file in a listing. */
+type StorageObject = {
+    /** Relative key within the uploads namespace. */
+    key: string;
+    /** Size in bytes. */
+    size: number;
+    /** Last modified time (ISO 8601). */
+    lastModified: string;
+};
+type StorageListResult = {
+    /** Files under the requested prefix. */
+    objects: StorageObject[];
+    /** Sub-prefixes (folders) returned when `delimiter` is set; otherwise empty. */
+    commonPrefixes: string[];
+    /** Cursor to pass back for the next page, if any. */
+    nextCursor?: string;
+};
+/** Metadata for a single file. */
+type StorageMetadata = {
+    key: string;
+    size: number;
+    /** MIME type. */
+    contentType: string;
+    /** Creation time (ISO 8601). */
+    createdAt: string;
+};
+/** A presigned URL and its expiry. */
+type PresignedUrl = {
+    url: string;
+    /** Expiry time (ISO 8601). Re-fetch before it expires. */
+    expiresAt: string;
+};
+type StorageListOptions = {
+    /** Maximum number of entries to return. */
+    limit?: number;
+    /** Pagination cursor from a previous `nextCursor`. */
+    cursor?: string;
+    /**
+     * When set to `"/"`, splits the result into direct files and
+     * `commonPrefixes` (folders). When omitted, lists every file under the
+     * prefix recursively as a flat list.
+     */
+    delimiter?: string;
+};
+type StoragePutOptions = {
+    /** Defaults to `application/octet-stream`. */
+    contentType?: string;
+};
+type StorageCopyOptions = {
+    /** When omitted, an existing destination is overwritten. */
+    overwrite?: boolean;
+};
+declare class StorageUploadsClient {
+    /**
+     * Lists files under a prefix. Pass `delimiter: "/"` for a folder-style
+     * listing, or omit it for a flat recursive listing.
+     */
+    list(prefix?: string, options?: StorageListOptions): Promise<StorageListResult>;
+    /**
+     * Fetches a file's metadata without reading its body.
+     */
+    head(key: string): Promise<StorageMetadata>;
+    /**
+     * Returns a short-lived presigned GET URL for a file. Re-fetch before
+     * `expiresAt` to keep the URL valid.
+     */
+    getUrl(key: string): Promise<PresignedUrl>;
+    /**
+     * Fetches a file's contents and returns the raw `Response`. Use the standard
+     * `Response` methods (`.text()` / `.json()` / `.blob()` / `.arrayBuffer()`)
+     * to read the body.
+     */
+    get(key: string): Promise<Response>;
+    /**
+     * Uploads a file. `data` may be a `Blob` (including `File`), `ArrayBuffer`,
+     * `Uint8Array`, or `string`.
+     */
+    put(key: string, data: Blob | ArrayBuffer | Uint8Array | string, options?: StoragePutOptions): Promise<void>;
+    /**
+     * Deletes a file.
+     */
+    delete(key: string): Promise<void>;
+    /**
+     * Copies a file to a new key.
+     */
+    copy(srcKey: string, destKey: string, options?: StorageCopyOptions): Promise<void>;
+    /**
+     * Moves (renames) a file to a new key.
+     */
+    move(srcKey: string, destKey: string, options?: StorageCopyOptions): Promise<void>;
+}
+type StorageClient = {
+    uploads: StorageUploadsClient;
+};
+/** Returns the Project Storage client. */
+declare function useStorage(): StorageClient;
+
+export { type PresignedUrl, SquadbaseProvider, type StorageClient, type StorageCopyOptions, type StorageListOptions, type StorageListResult, type StorageMetadata, type StorageObject, type StoragePutOptions, StorageUploadsClient, type User, type UserState, useStorage, useUser };

package/dist/index.d.ts

@@ -26,4 +26,101 @@ type UserState = {
 };
 declare function useUser(): UserState;
 
-export { SquadbaseProvider, type User, type UserState, useUser };
+/** A single file in a listing. */
+type StorageObject = {
+    /** Relative key within the uploads namespace. */
+    key: string;
+    /** Size in bytes. */
+    size: number;
+    /** Last modified time (ISO 8601). */
+    lastModified: string;
+};
+type StorageListResult = {
+    /** Files under the requested prefix. */
+    objects: StorageObject[];
+    /** Sub-prefixes (folders) returned when `delimiter` is set; otherwise empty. */
+    commonPrefixes: string[];
+    /** Cursor to pass back for the next page, if any. */
+    nextCursor?: string;
+};
+/** Metadata for a single file. */
+type StorageMetadata = {
+    key: string;
+    size: number;
+    /** MIME type. */
+    contentType: string;
+    /** Creation time (ISO 8601). */
+    createdAt: string;
+};
+/** A presigned URL and its expiry. */
+type PresignedUrl = {
+    url: string;
+    /** Expiry time (ISO 8601). Re-fetch before it expires. */
+    expiresAt: string;
+};
+type StorageListOptions = {
+    /** Maximum number of entries to return. */
+    limit?: number;
+    /** Pagination cursor from a previous `nextCursor`. */
+    cursor?: string;
+    /**
+     * When set to `"/"`, splits the result into direct files and
+     * `commonPrefixes` (folders). When omitted, lists every file under the
+     * prefix recursively as a flat list.
+     */
+    delimiter?: string;
+};
+type StoragePutOptions = {
+    /** Defaults to `application/octet-stream`. */
+    contentType?: string;
+};
+type StorageCopyOptions = {
+    /** When omitted, an existing destination is overwritten. */
+    overwrite?: boolean;
+};
+declare class StorageUploadsClient {
+    /**
+     * Lists files under a prefix. Pass `delimiter: "/"` for a folder-style
+     * listing, or omit it for a flat recursive listing.
+     */
+    list(prefix?: string, options?: StorageListOptions): Promise<StorageListResult>;
+    /**
+     * Fetches a file's metadata without reading its body.
+     */
+    head(key: string): Promise<StorageMetadata>;
+    /**
+     * Returns a short-lived presigned GET URL for a file. Re-fetch before
+     * `expiresAt` to keep the URL valid.
+     */
+    getUrl(key: string): Promise<PresignedUrl>;
+    /**
+     * Fetches a file's contents and returns the raw `Response`. Use the standard
+     * `Response` methods (`.text()` / `.json()` / `.blob()` / `.arrayBuffer()`)
+     * to read the body.
+     */
+    get(key: string): Promise<Response>;
+    /**
+     * Uploads a file. `data` may be a `Blob` (including `File`), `ArrayBuffer`,
+     * `Uint8Array`, or `string`.
+     */
+    put(key: string, data: Blob | ArrayBuffer | Uint8Array | string, options?: StoragePutOptions): Promise<void>;
+    /**
+     * Deletes a file.
+     */
+    delete(key: string): Promise<void>;
+    /**
+     * Copies a file to a new key.
+     */
+    copy(srcKey: string, destKey: string, options?: StorageCopyOptions): Promise<void>;
+    /**
+     * Moves (renames) a file to a new key.
+     */
+    move(srcKey: string, destKey: string, options?: StorageCopyOptions): Promise<void>;
+}
+type StorageClient = {
+    uploads: StorageUploadsClient;
+};
+/** Returns the Project Storage client. */
+declare function useStorage(): StorageClient;
+
+export { type PresignedUrl, SquadbaseProvider, type StorageClient, type StorageCopyOptions, type StorageListOptions, type StorageListResult, type StorageMetadata, type StorageObject, type StoragePutOptions, StorageUploadsClient, type User, type UserState, useStorage, useUser };

package/dist/index.js

@@ -48,7 +48,185 @@ import { jsx as jsx2 } from "react/jsx-runtime";
 function SquadbaseProvider({ children }) {
   return /* @__PURE__ */ jsx2(UserProvider, { children });
 }
+
+// src/storage.tsx
+import { z as z2 } from "zod";
+var STORAGE_BASE_PATH = "/_sqcore/storage";
+var zApiListItem = z2.object({
+  key: z2.string(),
+  size: z2.number(),
+  lastModified: z2.string()
+});
+var zApiListResult = z2.object({
+  objects: z2.array(zApiListItem),
+  commonPrefixes: z2.array(z2.string()).default([]),
+  nextCursor: z2.string().optional()
+});
+var zApiMetadata = z2.object({
+  key: z2.string(),
+  size: z2.number(),
+  contentType: z2.string(),
+  createdAt: z2.string(),
+  createdBy: z2.string(),
+  source: z2.enum(["upload", "agent", "system"])
+});
+var zApiPresignedGet = z2.object({
+  url: z2.string(),
+  expiresAt: z2.string()
+});
+var zApiPresignedPut = z2.object({
+  url: z2.string(),
+  headers: z2.record(z2.string(), z2.string()),
+  expiresAt: z2.string()
+});
+var storageUrl = (path, query) => {
+  const params = new URLSearchParams();
+  for (const [key, value] of Object.entries(query ?? {})) {
+    if (value != null) params.set(key, value);
+  }
+  const qs = params.toString();
+  return `${STORAGE_BASE_PATH}${path}${qs.length > 0 ? `?${qs}` : ""}`;
+};
+var throwIfNotOk = async (res, label) => {
+  if (res.ok) return;
+  const text = await res.text();
+  throw new Error(
+    `Project Storage ${label} failed: ${res.status} ${res.statusText}: ${text}`
+  );
+};
+var StorageUploadsClient = class {
+  /**
+   * Lists files under a prefix. Pass `delimiter: "/"` for a folder-style
+   * listing, or omit it for a flat recursive listing.
+   */
+  async list(prefix, options) {
+    const res = await fetch(
+      storageUrl("/list", {
+        prefix,
+        limit: options?.limit != null ? String(options.limit) : void 0,
+        cursor: options?.cursor,
+        delimiter: options?.delimiter
+      }),
+      { credentials: "include" }
+    );
+    await throwIfNotOk(res, "list");
+    const data = zApiListResult.parse(await res.json());
+    return {
+      objects: data.objects.map((o) => ({
+        key: o.key,
+        size: o.size,
+        lastModified: o.lastModified
+      })),
+      commonPrefixes: data.commonPrefixes,
+      nextCursor: data.nextCursor
+    };
+  }
+  /**
+   * Fetches a file's metadata without reading its body.
+   */
+  async head(key) {
+    const res = await fetch(storageUrl("/head", { key }), {
+      credentials: "include"
+    });
+    await throwIfNotOk(res, "head");
+    const data = zApiMetadata.parse(await res.json());
+    return {
+      key: data.key,
+      size: data.size,
+      contentType: data.contentType,
+      createdAt: data.createdAt
+    };
+  }
+  /**
+   * Returns a short-lived presigned GET URL for a file. Re-fetch before
+   * `expiresAt` to keep the URL valid.
+   */
+  async getUrl(key) {
+    const res = await fetch(storageUrl("/sign", { key }), {
+      credentials: "include"
+    });
+    await throwIfNotOk(res, "getUrl");
+    const data = zApiPresignedGet.parse(await res.json());
+    return { url: data.url, expiresAt: data.expiresAt };
+  }
+  /**
+   * Fetches a file's contents and returns the raw `Response`. Use the standard
+   * `Response` methods (`.text()` / `.json()` / `.blob()` / `.arrayBuffer()`)
+   * to read the body.
+   */
+  async get(key) {
+    const { url } = await this.getUrl(key);
+    const res = await fetch(url, { method: "GET" });
+    await throwIfNotOk(res, "get");
+    return res;
+  }
+  /**
+   * Uploads a file. `data` may be a `Blob` (including `File`), `ArrayBuffer`,
+   * `Uint8Array`, or `string`.
+   */
+  async put(key, data, options) {
+    const contentType = options?.contentType ?? "application/octet-stream";
+    const body = typeof data === "string" ? new Blob([data], { type: contentType }) : data;
+    const contentLength = body instanceof Blob ? body.size : body.byteLength;
+    const signRes = await fetch(storageUrl("/sign"), {
+      method: "POST",
+      credentials: "include",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ key, contentType, contentLength })
+    });
+    await throwIfNotOk(signRes, "put (sign)");
+    const signed = zApiPresignedPut.parse(await signRes.json());
+    const putRes = await fetch(signed.url, {
+      method: "PUT",
+      headers: signed.headers,
+      body
+    });
+    await throwIfNotOk(putRes, "put (S3)");
+  }
+  /**
+   * Deletes a file.
+   */
+  async delete(key) {
+    const res = await fetch(storageUrl("/objects", { key }), {
+      method: "DELETE",
+      credentials: "include"
+    });
+    await throwIfNotOk(res, "delete");
+  }
+  /**
+   * Copies a file to a new key.
+   */
+  async copy(srcKey, destKey, options) {
+    const res = await fetch(storageUrl("/copy"), {
+      method: "POST",
+      credentials: "include",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ srcKey, destKey, overwrite: options?.overwrite })
+    });
+    await throwIfNotOk(res, "copy");
+  }
+  /**
+   * Moves (renames) a file to a new key.
+   */
+  async move(srcKey, destKey, options) {
+    const res = await fetch(storageUrl("/move"), {
+      method: "POST",
+      credentials: "include",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ srcKey, destKey, overwrite: options?.overwrite })
+    });
+    await throwIfNotOk(res, "move");
+  }
+};
+var storageClient = {
+  uploads: new StorageUploadsClient()
+};
+function useStorage() {
+  return storageClient;
+}
 export {
   SquadbaseProvider,
+  StorageUploadsClient,
+  useStorage,
   useUser
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squadbase/react",
-  "version": "0.0.1",
+  "version": "0.0.2-dev.1",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "type": "module",