celestya 0.0.5 → 0.2.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { IronSessionData, IronSession } from 'iron-session';
+import { SessionOptions, IronSessionData, IronSession } from 'iron-session';
 import { NextRequest } from 'next/server';
 
 declare module "iron-session" {
@@ -12,19 +12,86 @@ declare module "iron-session" {
     }
 }
 interface DefaultUser {
-    [key: string]: any;
+    [key: string]: unknown;
 }
 interface Token {
     token: string;
 }
+declare const getSession: <U = DefaultUser>(sessionOpts?: SessionOptions) => Promise<Session<U>>;
+
+type BaseError = {
+    error: string;
+    message: string;
+};
+type Success<S> = {
+    data: S;
+};
+/**
+ * A Result type that represents either a successful value (Ok) or an error (Err).
+ * This is a discriminated union type that helps handle errors in a type-safe way.
+ *
+ * @template T - The type of the successful value
+ * @template E - The type of the error, must extend BaseError
+ */
+type Result<T, E extends BaseError> = Ok<T, E> | Err<T, E>;
+type IResult<T, E extends BaseError> = {
+    /**
+     * Checks if the `Result` is an `Ok` instance
+     */
+    isOk: () => this is Ok<T, E>;
+    /**
+     * Checks if the `Result` is an `Err` instance.
+     */
+    isErr: () => this is Err<T, E>;
+};
+/**
+ * Represents a successful `Result` value.
+ *
+ * @template T - The type of the successful value.
+ * @template E - The type of the error, must extend `BaseError`.
+ */
+declare class Ok<T, E extends BaseError> implements IResult<T, E> {
+    value: Success<T>;
+    constructor(value: Success<T>);
+    isOk(): this is Ok<T, E>;
+    isErr(): this is Err<T, E>;
+}
+/**
+ * Represents an error `Result` value.
+ *
+ * @template T - The type of the successful value.
+ * @template E - The type of the error, must extend `BaseError`.
+ */
+declare class Err<T, E extends BaseError> implements IResult<T, E> {
+    error: E;
+    constructor(error: E);
+    isOk(): this is Ok<T, E>;
+    isErr(): this is Err<T, E>;
+}
+/**
+ * Creates a new successful `Result` (i.e., an instance of `Ok`).
+ *
+ * @template T - The type of the successful value
+ * @param value - The successful value
+ * @returns A new `Ok` instance.
+ */
+declare function ok<const T>(value: Success<T>): Result<T, never>;
+/**
+ * Creates a new error `Result` (i.e., an instance of `Err`).
+ *
+ * @template E - The type of the error, must extend `BaseError`.
+ * @param error - The error value.
+ * @returns A new `Err` instance.
+ */
+declare function err<const E extends BaseError>(error: E): Result<never, E>;
 
 type ServerSideSession<U> = IronSessionData<U, Token>;
 
 type Params = string[];
 interface IRequestOptions {
-    params: {
+    params: Promise<{
         endpoint: Params;
-    };
+    }>;
 }
 interface IConfig {
     host: string;
@@ -34,16 +101,48 @@ interface IConfig {
     debug?: boolean;
 }
 type Session<U = DefaultUser> = IronSession<ServerSideSession<U>>;
-interface IServerSideRequestOptions {
-    method?: string;
-    body?: JSON;
-}
+type CallbackOptions = {
+    method: "GET" | "POST" | "DELETE";
+    url: string;
+    body?: object;
+};
+type WrapperFunction = <T>(data: CallbackOptions) => Promise<Result<T, BaseError>>;
+
+declare const CelestyaProxy: (config: IConfig) => {
+    POST: (req: NextRequest, opt: IRequestOptions) => Promise<any>;
+    GET: (req: NextRequest, opt: IRequestOptions) => Promise<any>;
+    DELETE: (req: NextRequest, opt: IRequestOptions) => Promise<any>;
+};
 
-declare function proxy(method: string, request: NextRequest, options: IRequestOptions, config: IConfig): Promise<any>;
+declare const serverSideFetch: <T>({ url, method, config, body, sessionIsOptional, skipRefresh, ...options }: {
+    url: string;
+    method?: "GET" | "POST" | "DELETE";
+    body?: object;
+    config: IConfig;
+    sessionIsOptional?: boolean;
+    skipRefresh?: boolean;
+} & Omit<RequestInit, "body" | "method">) => Promise<Result<T, BaseError>>;
+declare function attemptTokenRefresh(config: IConfig): Promise<Result<string, BaseError>>;
 
-declare const Proxy: typeof proxy;
-declare const getSession: <U = DefaultUser>() => Promise<Session<U>>;
-declare const debug: () => void;
-declare const apiFetch: (url: string, options: IServerSideRequestOptions, config: IConfig) => Promise<any>;
+/**
+ * Register new Wrapper for the API.
+ *
+ * Example Wrapper:
+ * ```ts
+ *  const apiWrapper = (cb: WrapperFunction) => {
+ *    return {
+ *      commmands: {
+ *        get: () => cb<string>({ method: "GET", url: "/command" }),
+ *        update: (id: string, body: JSON) =>
+ *          cb({ method: "POST", url: `/command/${id}`, body }),
+ *      },
+ *    };
+ *  };
+ * ````
+ * @param apiWrapper
+ * @param config
+ * @returns
+ */
+declare const serverAPIWrapper: <T>(apiWrapper: (cb: WrapperFunction) => T, config: IConfig) => T;
 
-export { type IConfig, type IRequestOptions, Proxy, type Session, apiFetch, debug, getSession };
+export { type BaseError, CelestyaProxy, Err, type IConfig, type IRequestOptions, Ok, type Result, type Session, type WrapperFunction, attemptTokenRefresh, err, getSession, ok, serverAPIWrapper, serverSideFetch };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { IronSessionData, IronSession } from 'iron-session';
+import { SessionOptions, IronSessionData, IronSession } from 'iron-session';
 import { NextRequest } from 'next/server';
 
 declare module "iron-session" {
@@ -12,19 +12,86 @@ declare module "iron-session" {
     }
 }
 interface DefaultUser {
-    [key: string]: any;
+    [key: string]: unknown;
 }
 interface Token {
     token: string;
 }
+declare const getSession: <U = DefaultUser>(sessionOpts?: SessionOptions) => Promise<Session<U>>;
+
+type BaseError = {
+    error: string;
+    message: string;
+};
+type Success<S> = {
+    data: S;
+};
+/**
+ * A Result type that represents either a successful value (Ok) or an error (Err).
+ * This is a discriminated union type that helps handle errors in a type-safe way.
+ *
+ * @template T - The type of the successful value
+ * @template E - The type of the error, must extend BaseError
+ */
+type Result<T, E extends BaseError> = Ok<T, E> | Err<T, E>;
+type IResult<T, E extends BaseError> = {
+    /**
+     * Checks if the `Result` is an `Ok` instance
+     */
+    isOk: () => this is Ok<T, E>;
+    /**
+     * Checks if the `Result` is an `Err` instance.
+     */
+    isErr: () => this is Err<T, E>;
+};
+/**
+ * Represents a successful `Result` value.
+ *
+ * @template T - The type of the successful value.
+ * @template E - The type of the error, must extend `BaseError`.
+ */
+declare class Ok<T, E extends BaseError> implements IResult<T, E> {
+    value: Success<T>;
+    constructor(value: Success<T>);
+    isOk(): this is Ok<T, E>;
+    isErr(): this is Err<T, E>;
+}
+/**
+ * Represents an error `Result` value.
+ *
+ * @template T - The type of the successful value.
+ * @template E - The type of the error, must extend `BaseError`.
+ */
+declare class Err<T, E extends BaseError> implements IResult<T, E> {
+    error: E;
+    constructor(error: E);
+    isOk(): this is Ok<T, E>;
+    isErr(): this is Err<T, E>;
+}
+/**
+ * Creates a new successful `Result` (i.e., an instance of `Ok`).
+ *
+ * @template T - The type of the successful value
+ * @param value - The successful value
+ * @returns A new `Ok` instance.
+ */
+declare function ok<const T>(value: Success<T>): Result<T, never>;
+/**
+ * Creates a new error `Result` (i.e., an instance of `Err`).
+ *
+ * @template E - The type of the error, must extend `BaseError`.
+ * @param error - The error value.
+ * @returns A new `Err` instance.
+ */
+declare function err<const E extends BaseError>(error: E): Result<never, E>;
 
 type ServerSideSession<U> = IronSessionData<U, Token>;
 
 type Params = string[];
 interface IRequestOptions {
-    params: {
+    params: Promise<{
         endpoint: Params;
-    };
+    }>;
 }
 interface IConfig {
     host: string;
@@ -34,16 +101,48 @@ interface IConfig {
     debug?: boolean;
 }
 type Session<U = DefaultUser> = IronSession<ServerSideSession<U>>;
-interface IServerSideRequestOptions {
-    method?: string;
-    body?: JSON;
-}
+type CallbackOptions = {
+    method: "GET" | "POST" | "DELETE";
+    url: string;
+    body?: object;
+};
+type WrapperFunction = <T>(data: CallbackOptions) => Promise<Result<T, BaseError>>;
+
+declare const CelestyaProxy: (config: IConfig) => {
+    POST: (req: NextRequest, opt: IRequestOptions) => Promise<any>;
+    GET: (req: NextRequest, opt: IRequestOptions) => Promise<any>;
+    DELETE: (req: NextRequest, opt: IRequestOptions) => Promise<any>;
+};
 
-declare function proxy(method: string, request: NextRequest, options: IRequestOptions, config: IConfig): Promise<any>;
+declare const serverSideFetch: <T>({ url, method, config, body, sessionIsOptional, skipRefresh, ...options }: {
+    url: string;
+    method?: "GET" | "POST" | "DELETE";
+    body?: object;
+    config: IConfig;
+    sessionIsOptional?: boolean;
+    skipRefresh?: boolean;
+} & Omit<RequestInit, "body" | "method">) => Promise<Result<T, BaseError>>;
+declare function attemptTokenRefresh(config: IConfig): Promise<Result<string, BaseError>>;
 
-declare const Proxy: typeof proxy;
-declare const getSession: <U = DefaultUser>() => Promise<Session<U>>;
-declare const debug: () => void;
-declare const apiFetch: (url: string, options: IServerSideRequestOptions, config: IConfig) => Promise<any>;
+/**
+ * Register new Wrapper for the API.
+ *
+ * Example Wrapper:
+ * ```ts
+ *  const apiWrapper = (cb: WrapperFunction) => {
+ *    return {
+ *      commmands: {
+ *        get: () => cb<string>({ method: "GET", url: "/command" }),
+ *        update: (id: string, body: JSON) =>
+ *          cb({ method: "POST", url: `/command/${id}`, body }),
+ *      },
+ *    };
+ *  };
+ * ````
+ * @param apiWrapper
+ * @param config
+ * @returns
+ */
+declare const serverAPIWrapper: <T>(apiWrapper: (cb: WrapperFunction) => T, config: IConfig) => T;
 
-export { type IConfig, type IRequestOptions, Proxy, type Session, apiFetch, debug, getSession };
+export { type BaseError, CelestyaProxy, Err, type IConfig, type IRequestOptions, Ok, type Result, type Session, type WrapperFunction, attemptTokenRefresh, err, getSession, ok, serverAPIWrapper, serverSideFetch };