@sekolaos/shared-api 0.0.0-stage → 1.1.0

package/dist/types-BxV0BtVp.d.ts

@@ -0,0 +1,89 @@
+import { UseMutationOptions, UseQueryOptions } from '@tanstack/react-query';
+import { AxiosError, AxiosRequestConfig } from 'axios';
+
+declare class SekolaosApiError extends Error {
+    readonly statusCode: number;
+    readonly errors: ApiErrorDetail[];
+    readonly isNetworkError: boolean;
+    readonly rawError?: AxiosError | undefined;
+    constructor(message: string, statusCode?: number, errors?: ApiErrorDetail[], isNetworkError?: boolean, rawError?: AxiosError | undefined);
+    /** HTTP 422 validation failure coming from the Zod validation middleware. */
+    get isValidationError(): boolean;
+    get isUnauthorized(): boolean;
+    get isForbidden(): boolean;
+    get isNotFound(): boolean;
+    /** Maps field-level validation errors into a `{ field: message }` record. */
+    toFieldErrors(): Record<string, string>;
+    static fromAxiosError(error: AxiosError<ApiErrorPayload>): SekolaosApiError;
+    /** Converts any thrown value into a `SekolaosApiError` instance. */
+    static normalize(error: unknown): SekolaosApiError;
+}
+interface RequestOptions {
+    /** Extra axios options (headers, signal, params, ...). */
+    config?: AxiosRequestConfig;
+    /** Query string parameters serialized by axios. */
+    params?: AxiosRequestConfig["params"];
+    /** Abort signal forwarded to axios for TanStack Query cancellation. */
+    signal?: AbortSignal;
+}
+
+interface BaseApiResponse<T> {
+    success: boolean;
+    message: string;
+    data: T;
+    /** Operator metadata emitted by the backend when available. */
+    meta?: Record<string, unknown>;
+}
+interface PaginationMeta {
+    currentPage: number;
+    pageSize: number;
+    totalItems: number;
+    totalPages: number;
+}
+/**
+ * The backend wraps paginated collections inside `data` (see
+ * `paginatedDataSchema` in `@sekolaos/shared-schema`).
+ */
+interface PaginatedApiResponse<T> {
+    success: boolean;
+    message: string;
+    data: PaginatedData<T>;
+    meta?: Record<string, unknown>;
+}
+interface PaginatedData<T> {
+    items: T[];
+    meta: PaginationMeta;
+}
+/**
+ * `@sekolaos/shared-schema` declares `PaginatedData<T>` with a Zod schema
+ * constraint, so the client exposes an equivalent runtime-shaped alias.
+ */
+type PaginatedResult<T> = PaginatedData<T>;
+interface ApiErrorDetail {
+    field?: string;
+    message: string;
+}
+interface ApiErrorPayload {
+    success: false;
+    message: string;
+    errors?: ApiErrorDetail[];
+    meta?: Record<string, unknown>;
+}
+interface ClientConfig {
+    baseURL?: string;
+    timeout?: number;
+    bearerToken?: string;
+    withCredentials?: boolean;
+    onUnauthorized?: () => void;
+    onForbidden?: () => void;
+}
+interface UploadFileResult {
+    url: string;
+    fileName: string;
+    size: number;
+    mimeType: string;
+}
+type QueryOptionsWithoutKey<TData, TSelect = TData> = Omit<UseQueryOptions<TData, SekolaosApiError, TSelect>, "queryKey" | "queryFn">;
+type MutationOptionsCustom<TData, TVariables, TContext = unknown> = UseMutationOptions<TData, SekolaosApiError, TVariables, TContext>;
+
+export { type ApiErrorDetail as A, type BaseApiResponse as B, type ClientConfig as C, type MutationOptionsCustom as M, type PaginatedApiResponse as P, type QueryOptionsWithoutKey as Q, type RequestOptions as R, SekolaosApiError as S, type UploadFileResult as U, type ApiErrorPayload as a, type PaginatedData as b, type PaginatedResult as c, type PaginationMeta as d };

package/package.json

@@ -1,6 +1,138 @@
-{
-  "name": "@sekolaos/shared-api",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "@sekolaos/shared-api",
+  "version": "1.1.0",
+  "description": "Shared HTTP API client, TanStack Query hooks, and query key factory for Sekolaos ecosystem aligned with OpenAPI 3.0.3",
+  "license": "ISC",
+  "author": "Sekolaos",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "import": "./dist/client/index.js",
+      "require": "./dist/client/index.cjs"
+    },
+    "./keys": {
+      "types": "./dist/keys/index.d.ts",
+      "import": "./dist/keys/index.js",
+      "require": "./dist/keys/index.cjs"
+    },
+    "./provider": {
+      "types": "./dist/provider.d.ts",
+      "import": "./dist/provider.js",
+      "require": "./dist/provider.cjs"
+    },
+    "./auth": {
+      "types": "./dist/modules/auth/index.d.ts",
+      "import": "./dist/modules/auth/index.js",
+      "require": "./dist/modules/auth/index.cjs"
+    },
+    "./tenant": {
+      "types": "./dist/modules/tenant/index.d.ts",
+      "import": "./dist/modules/tenant/index.js",
+      "require": "./dist/modules/tenant/index.cjs"
+    },
+    "./academic": {
+      "types": "./dist/modules/academic/index.d.ts",
+      "import": "./dist/modules/academic/index.js",
+      "require": "./dist/modules/academic/index.cjs"
+    },
+    "./classroom": {
+      "types": "./dist/modules/classroom/index.d.ts",
+      "import": "./dist/modules/classroom/index.js",
+      "require": "./dist/modules/classroom/index.cjs"
+    },
+    "./student": {
+      "types": "./dist/modules/student/index.d.ts",
+      "import": "./dist/modules/student/index.js",
+      "require": "./dist/modules/student/index.cjs"
+    },
+    "./subject": {
+      "types": "./dist/modules/subject/index.d.ts",
+      "import": "./dist/modules/subject/index.js",
+      "require": "./dist/modules/subject/index.cjs"
+    },
+    "./teaching-schedule": {
+      "types": "./dist/modules/teaching-schedule/index.d.ts",
+      "import": "./dist/modules/teaching-schedule/index.js",
+      "require": "./dist/modules/teaching-schedule/index.cjs"
+    },
+    "./user": {
+      "types": "./dist/modules/user/index.d.ts",
+      "import": "./dist/modules/user/index.js",
+      "require": "./dist/modules/user/index.cjs"
+    },
+    "./attendance": {
+      "types": "./dist/modules/attendance/index.d.ts",
+      "import": "./dist/modules/attendance/index.js",
+      "require": "./dist/modules/attendance/index.cjs"
+    },
+    "./upload": {
+      "types": "./dist/modules/upload/index.d.ts",
+      "import": "./dist/modules/upload/index.js",
+      "require": "./dist/modules/upload/index.cjs"
+    },
+    "./lead": {
+      "types": "./dist/modules/lead/index.d.ts",
+      "import": "./dist/modules/lead/index.js",
+      "require": "./dist/modules/lead/index.cjs"
+    },
+    "./system": {
+      "types": "./dist/modules/system/index.d.ts",
+      "import": "./dist/modules/system/index.js",
+      "require": "./dist/modules/system/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "clean": "rimraf dist",
+    "prepublishOnly": "pnpm run typecheck && pnpm run build"
+  },
+  "peerDependencies": {
+    "react": "^19.3.1",
+    "react-dom": "^19.3.1"
+  },
+  "dependencies": {
+    "@sekolaos/shared-schema": "^1.5.0",
+    "@tanstack/react-query": "^5.59.16",
+    "axios": "^1.7.7"
+  },
+  "devDependencies": {
+    "@types/node": "^22.9.0",
+    "@types/react": "19.0.0",
+    "@types/react-dom": "19.0.0",
+    "react": "19.3.1",
+    "react-dom": "19.3.1",
+    "rimraf": "^6.0.1",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "keywords": [
+    "sekolaos",
+    "http-client",
+    "axios",
+    "tanstack-query",
+    "query-key-factory"
+  ]
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.