@taruvi/refine-providers 1.0.3

package/dist/index.d.cts

@@ -0,0 +1,165 @@
+import { DataProvider, AuthProvider, AccessControlProvider, MetaQuery, CrudFilter, CrudSort, Pagination } from '@refinedev/core';
+import { Client } from '@taruvi/sdk';
+export { Auth, Client, Policy, TaruviConfig } from '@taruvi/sdk';
+
+/**
+ * Creates a Refine DataProvider for Taruvi database operations.
+ */
+declare function dataProvider(client: Client): DataProvider;
+
+/**
+ * Storage upload variables interface.
+ */
+interface StorageUploadVariables {
+    files: File[];
+    paths?: string[];
+    metadatas?: Record<string, unknown>[];
+}
+/**
+ * Creates a Refine DataProvider for Taruvi file storage operations.
+ */
+declare function storageDataProvider(client: Client): DataProvider;
+
+/**
+ * User identity returned from JWT token
+ */
+interface TaruviUser {
+    user_id: number;
+    username: string;
+    email?: string;
+    exp?: number;
+    iat?: number;
+    jti?: string;
+    token_type?: string;
+    [key: string]: unknown;
+}
+/**
+ * Login params - supports both redirect flow and credentials flow
+ */
+interface LoginParams {
+    /** For redirect-based login - URL to redirect after successful login */
+    callbackUrl?: string;
+    /** For credentials-based login (if supported) */
+    username?: string;
+    password?: string;
+    /** Whether to use redirect flow (default: true) */
+    redirect?: boolean;
+}
+/**
+ * Logout params
+ */
+interface LogoutParams {
+    /** URL to redirect after logout */
+    callbackUrl?: string;
+}
+/**
+ * Register/Signup params
+ */
+interface RegisterParams {
+    /** URL to redirect after successful signup */
+    callbackUrl?: string;
+}
+/**
+ * Creates a Refine AuthProvider for Taruvi authentication.
+ *
+ * Supports redirect-based authentication flow (Web UI Flow):
+ * 1. User calls login() → Redirects to backend /accounts/login/
+ * 2. User authenticates on backend
+ * 3. Backend redirects back with tokens in URL hash
+ * 4. Client extracts and stores tokens automatically
+ */
+declare function authProvider(client: Client): AuthProvider;
+/**
+ * Creates a Refine AccessControlProvider using Cerbos via the Policy client.
+ *
+ * This provides resource-based authorization checks using Cerbos policies.
+ * Use this with Refine's `useCan` hook or `<CanAccess>` component.
+ *
+ * @example
+ * ```tsx
+ * import { Refine } from "@refinedev/core";
+ * import { Client } from "@taruvi/sdk";
+ * import { authProvider, accessControlProvider } from "@taruvi-io/refine";
+ *
+ * const client = new Client({ appSlug: "my-app", baseUrl: "..." });
+ *
+ * <Refine
+ *   authProvider={authProvider(client)}
+ *   accessControlProvider={accessControlProvider(client)}
+ *   // ...
+ * />
+ * ```
+ */
+declare function accessControlProvider(client: Client): AccessControlProvider;
+
+/**
+ * Extended meta options for Taruvi-specific features.
+ */
+interface TaruviMeta extends MetaQuery {
+    /** Foreign key fields to populate. Use "*" for all or array of field names. */
+    populate?: string | string[];
+    /** Custom headers for the request. */
+    headers?: Record<string, string>;
+    /** Custom primary key column name (default: "id"). */
+    idColumnName?: string;
+    /** Fields to select/return. */
+    select?: string | string[];
+    /** Override the table name for API calls (when resource name differs from table name). */
+    tableName?: string;
+    /** Override the bucket name for storage API calls (when resource name differs from bucket name). */
+    bucketName?: string;
+}
+/**
+ * Response wrapper for Taruvi list endpoints.
+ */
+interface TaruviListResponse<T> {
+    data: T[];
+    total: number;
+    meta?: {
+        offset?: number;
+        count?: number;
+        has_more?: boolean;
+    };
+}
+
+/**
+ * Maps Refine operators to Taruvi DRF-style query parameter suffixes.
+ * Example: { field: "age", operator: "gte", value: 18 } → "age__gte=18"
+ */
+declare const REFINE_OPERATOR_MAP: Record<string, string>;
+/**
+ * Converts Refine CrudFilter[] to Taruvi query parameters.
+ * Handles both simple filters and logical operators (and/or).
+ */
+declare function convertRefineFilters(filters?: CrudFilter[]): Record<string, string>;
+/**
+ * Converts Refine CrudSort[] to Taruvi ordering parameter.
+ * Uses DRF convention: "-field" for DESC, "field" for ASC.
+ */
+declare function convertRefineSorters(sorters?: CrudSort[]): string | undefined;
+/**
+ * Converts Refine Pagination to Taruvi page/page_size parameters.
+ */
+declare function convertRefinePagination(pagination?: Pagination): {
+    page?: number;
+    page_size?: number;
+};
+/**
+ * Combines all Refine parameters into Taruvi query params.
+ */
+declare function buildRefineQueryParams(options: {
+    filters?: CrudFilter[];
+    sorters?: CrudSort[];
+    pagination?: Pagination;
+    meta?: TaruviMeta;
+}): Record<string, unknown>;
+/**
+ * Builds a query string from an object of parameters.
+ */
+declare function buildQueryString(params?: Record<string, unknown>): string;
+/**
+ * Handles and transforms Taruvi API errors.
+ */
+declare function handleError(error: unknown): never;
+
+export { type LoginParams, type LogoutParams, REFINE_OPERATOR_MAP, type RegisterParams, type StorageUploadVariables, type TaruviListResponse, type TaruviMeta, type TaruviUser, accessControlProvider, authProvider, buildQueryString, buildRefineQueryParams, convertRefineFilters, convertRefinePagination, convertRefineSorters, dataProvider, handleError, storageDataProvider };

package/dist/index.d.ts

@@ -0,0 +1,165 @@
+import { DataProvider, AuthProvider, AccessControlProvider, MetaQuery, CrudFilter, CrudSort, Pagination } from '@refinedev/core';
+import { Client } from '@taruvi/sdk';
+export { Auth, Client, Policy, TaruviConfig } from '@taruvi/sdk';
+
+/**
+ * Creates a Refine DataProvider for Taruvi database operations.
+ */
+declare function dataProvider(client: Client): DataProvider;
+
+/**
+ * Storage upload variables interface.
+ */
+interface StorageUploadVariables {
+    files: File[];
+    paths?: string[];
+    metadatas?: Record<string, unknown>[];
+}
+/**
+ * Creates a Refine DataProvider for Taruvi file storage operations.
+ */
+declare function storageDataProvider(client: Client): DataProvider;
+
+/**
+ * User identity returned from JWT token
+ */
+interface TaruviUser {
+    user_id: number;
+    username: string;
+    email?: string;
+    exp?: number;
+    iat?: number;
+    jti?: string;
+    token_type?: string;
+    [key: string]: unknown;
+}
+/**
+ * Login params - supports both redirect flow and credentials flow
+ */
+interface LoginParams {
+    /** For redirect-based login - URL to redirect after successful login */
+    callbackUrl?: string;
+    /** For credentials-based login (if supported) */
+    username?: string;
+    password?: string;
+    /** Whether to use redirect flow (default: true) */
+    redirect?: boolean;
+}
+/**
+ * Logout params
+ */
+interface LogoutParams {
+    /** URL to redirect after logout */
+    callbackUrl?: string;
+}
+/**
+ * Register/Signup params
+ */
+interface RegisterParams {
+    /** URL to redirect after successful signup */
+    callbackUrl?: string;
+}
+/**
+ * Creates a Refine AuthProvider for Taruvi authentication.
+ *
+ * Supports redirect-based authentication flow (Web UI Flow):
+ * 1. User calls login() → Redirects to backend /accounts/login/
+ * 2. User authenticates on backend
+ * 3. Backend redirects back with tokens in URL hash
+ * 4. Client extracts and stores tokens automatically
+ */
+declare function authProvider(client: Client): AuthProvider;
+/**
+ * Creates a Refine AccessControlProvider using Cerbos via the Policy client.
+ *
+ * This provides resource-based authorization checks using Cerbos policies.
+ * Use this with Refine's `useCan` hook or `<CanAccess>` component.
+ *
+ * @example
+ * ```tsx
+ * import { Refine } from "@refinedev/core";
+ * import { Client } from "@taruvi/sdk";
+ * import { authProvider, accessControlProvider } from "@taruvi-io/refine";
+ *
+ * const client = new Client({ appSlug: "my-app", baseUrl: "..." });
+ *
+ * <Refine
+ *   authProvider={authProvider(client)}
+ *   accessControlProvider={accessControlProvider(client)}
+ *   // ...
+ * />
+ * ```
+ */
+declare function accessControlProvider(client: Client): AccessControlProvider;
+
+/**
+ * Extended meta options for Taruvi-specific features.
+ */
+interface TaruviMeta extends MetaQuery {
+    /** Foreign key fields to populate. Use "*" for all or array of field names. */
+    populate?: string | string[];
+    /** Custom headers for the request. */
+    headers?: Record<string, string>;
+    /** Custom primary key column name (default: "id"). */
+    idColumnName?: string;
+    /** Fields to select/return. */
+    select?: string | string[];
+    /** Override the table name for API calls (when resource name differs from table name). */
+    tableName?: string;
+    /** Override the bucket name for storage API calls (when resource name differs from bucket name). */
+    bucketName?: string;
+}
+/**
+ * Response wrapper for Taruvi list endpoints.
+ */
+interface TaruviListResponse<T> {
+    data: T[];
+    total: number;
+    meta?: {
+        offset?: number;
+        count?: number;
+        has_more?: boolean;
+    };
+}
+
+/**
+ * Maps Refine operators to Taruvi DRF-style query parameter suffixes.
+ * Example: { field: "age", operator: "gte", value: 18 } → "age__gte=18"
+ */
+declare const REFINE_OPERATOR_MAP: Record<string, string>;
+/**
+ * Converts Refine CrudFilter[] to Taruvi query parameters.
+ * Handles both simple filters and logical operators (and/or).
+ */
+declare function convertRefineFilters(filters?: CrudFilter[]): Record<string, string>;
+/**
+ * Converts Refine CrudSort[] to Taruvi ordering parameter.
+ * Uses DRF convention: "-field" for DESC, "field" for ASC.
+ */
+declare function convertRefineSorters(sorters?: CrudSort[]): string | undefined;
+/**
+ * Converts Refine Pagination to Taruvi page/page_size parameters.
+ */
+declare function convertRefinePagination(pagination?: Pagination): {
+    page?: number;
+    page_size?: number;
+};
+/**
+ * Combines all Refine parameters into Taruvi query params.
+ */
+declare function buildRefineQueryParams(options: {
+    filters?: CrudFilter[];
+    sorters?: CrudSort[];
+    pagination?: Pagination;
+    meta?: TaruviMeta;
+}): Record<string, unknown>;
+/**
+ * Builds a query string from an object of parameters.
+ */
+declare function buildQueryString(params?: Record<string, unknown>): string;
+/**
+ * Handles and transforms Taruvi API errors.
+ */
+declare function handleError(error: unknown): never;
+
+export { type LoginParams, type LogoutParams, REFINE_OPERATOR_MAP, type RegisterParams, type StorageUploadVariables, type TaruviListResponse, type TaruviMeta, type TaruviUser, accessControlProvider, authProvider, buildQueryString, buildRefineQueryParams, convertRefineFilters, convertRefinePagination, convertRefineSorters, dataProvider, handleError, storageDataProvider };