@iglo.tech/iglo.base 0.0.0-stage → 1.0.0

package/dist/types/src/tools/dtos.d.ts

@@ -0,0 +1,122 @@
+import type { Loose, LooseObject } from "./loose.js";
+export interface ListResult<T> {
+    page: number;
+    perPage: number;
+    totalItems: number;
+    totalPages: number;
+    items: Array<T>;
+}
+export interface BaseModel {
+    [key: string]: Loose;
+    id: string;
+}
+export interface LogModel extends BaseModel {
+    level: string;
+    message: string;
+    created: string;
+    updated: string;
+    data: LooseObject;
+}
+export interface RecordModel extends BaseModel {
+    collectionId: string;
+    collectionName: string;
+    expand?: LooseObject;
+}
+export interface CollectionField {
+    [key: string]: Loose;
+    id: string;
+    name: string;
+    type: string;
+    system: boolean;
+    hidden: boolean;
+    presentable: boolean;
+}
+export interface TokenConfig {
+    duration: number;
+    secret?: string;
+}
+export interface AuthAlertConfig {
+    enabled: boolean;
+    emailTemplate: EmailTemplate;
+}
+export interface OTPConfig {
+    enabled: boolean;
+    duration: number;
+    length: number;
+    emailTemplate: EmailTemplate;
+}
+export interface MFAConfig {
+    enabled: boolean;
+    duration: number;
+    rule: string;
+}
+export interface PasswordAuthConfig {
+    enabled: boolean;
+    identityFields: Array<string>;
+}
+export interface OAuth2Provider {
+    pkce?: boolean;
+    clientId: string;
+    name: string;
+    clientSecret: string;
+    authURL: string;
+    tokenURL: string;
+    userInfoURL: string;
+    displayName: string;
+    logo: string;
+    extra?: LooseObject;
+}
+export interface ConfigurableOAuth2Provider {
+    name: string;
+    displayName: string;
+    logo: string;
+}
+export interface OAuth2Config {
+    enabled: boolean;
+    mappedFields: {
+        [key: string]: string;
+    };
+    providers: Array<OAuth2Provider>;
+}
+export interface EmailTemplate {
+    subject: string;
+    body: string;
+}
+interface collection extends BaseModel {
+    name: string;
+    fields: Array<CollectionField>;
+    indexes: Array<string>;
+    system: boolean;
+    listRule?: string;
+    viewRule?: string;
+    createRule?: string;
+    updateRule?: string;
+    deleteRule?: string;
+}
+export interface BaseCollectionModel extends collection {
+    type: "base";
+}
+export interface ViewCollectionModel extends collection {
+    type: "view";
+    viewQuery: string;
+}
+export interface AuthCollectionModel extends collection {
+    type: "auth";
+    authRule?: string;
+    manageRule?: string;
+    authAlert: AuthAlertConfig;
+    oauth2: OAuth2Config;
+    passwordAuth: PasswordAuthConfig;
+    mfa: MFAConfig;
+    otp: OTPConfig;
+    authToken: TokenConfig;
+    passwordResetToken: TokenConfig;
+    emailChangeToken: TokenConfig;
+    verificationToken: TokenConfig;
+    fileToken: TokenConfig;
+    verificationTemplate: EmailTemplate;
+    resetPasswordTemplate: EmailTemplate;
+    confirmEmailChangeTemplate: EmailTemplate;
+}
+export type CollectionModel = BaseCollectionModel | ViewCollectionModel | AuthCollectionModel;
+export {};

package/dist/types/src/tools/formdata.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Checks if the specified value is a file (aka. File, Blob, RN file object).
+ */
+export declare function isFile(val: unknown): boolean;
+/**
+ * Loosely checks if the specified body is a FormData instance.
+ */
+export declare function isFormData(body: unknown): boolean;
+/**
+ * Checks if the submitted body object has at least one Blob/File field value.
+ */
+export declare function hasFileField(body: unknown): boolean;
+/**
+ * Converts analyzes the provided body and converts it to FormData
+ * in case a plain object with File/Blob values is used.
+ */
+export declare function convertToFormDataIfNeeded(body: unknown): unknown;
+/**
+ * Converts the provided FormData instance into a plain object.
+ *
+ * For consistency with the server multipart/form-data inferring,
+ * the following normalization rules are applied for plain multipart string values:
+ *   - "true" is converted to the json "true"
+ *   - "false" is converted to the json "false"
+ *   - numeric strings are converted to json number ONLY if the resulted
+ *     minimal number string representation is the same as the provided raw string
+ *     (aka. scientific notations, "Infinity", "0.0", "0001", etc. are kept as string)
+ *   - any other string (empty string too) is left as it is
+ */
+export declare function convertFormDataToObject(formData: FormData): Record<string, unknown>;

package/dist/types/src/tools/jwt.d.ts

@@ -0,0 +1,14 @@
+import type { LooseObject } from "./loose.js";
+/**
+ * Returns JWT token's payload data.
+ */
+export declare function getTokenPayload(token: string): LooseObject;
+/**
+ * Checks whether a JWT token is expired or not.
+ * Tokens without `exp` payload key are considered valid.
+ * Tokens with empty payload (eg. invalid token strings) are considered expired.
+ *
+ * @param token The token to check.
+ * @param [expirationThreshold] Time in seconds that will be subtracted from the token `exp` property.
+ */
+export declare function isTokenExpired(token: string, expirationThreshold?: number): boolean;

package/dist/types/src/tools/legacy.d.ts

@@ -0,0 +1,2 @@
+import { type SendOptions } from "./options.js";
+export declare function normalizeLegacyOptionsArgs(legacyWarn: string, baseOptions: SendOptions, bodyOrOptions?: unknown, query?: unknown): SendOptions;

package/dist/types/src/tools/loose.d.ts

@@ -0,0 +1,5 @@
+export type Loose = any;
+/** Open object bag used by public request and response shapes. */
+export type LooseObject = {
+    [key: string]: Loose;
+};

package/dist/types/src/tools/options.d.ts

@@ -0,0 +1,91 @@
+import type { Loose, LooseObject } from "./loose.js";
+export interface SendOptions extends RequestInit {
+    [key: string]: Loose;
+    /**
+     * Optional custom fetch function to use for sending the request.
+     */
+    fetch?: (url: RequestInfo | URL, config?: RequestInit) => Promise<Response>;
+    /**
+     * Custom headers to send with the requests.
+     */
+    headers?: {
+        [key: string]: string;
+    };
+    /**
+     * The body of the request (serialized automatically for json requests).
+     */
+    body?: Loose;
+    /**
+     * Query parameters that will be appended to the request url.
+     */
+    query?: LooseObject;
+    /**
+     * @deprecated use `query` instead
+     *
+     * for backward-compatibility `params` values are merged with `query`,
+     * but this option may get removed in the final v1 release
+     */
+    params?: LooseObject;
+    /**
+     * The request identifier that can be used to cancel pending requests.
+     */
+    requestKey?: string | null;
+    /**
+     * @deprecated use `requestKey:string` instead
+     */
+    $cancelKey?: string;
+    /**
+     * @deprecated use `requestKey:null` instead
+     */
+    $autoCancel?: boolean;
+}
+export interface CommonOptions extends SendOptions {
+    fields?: string;
+}
+export interface ListOptions extends CommonOptions {
+    page?: number;
+    perPage?: number;
+    sort?: string;
+    filter?: string;
+    skipTotal?: boolean;
+}
+export interface FullListOptions extends ListOptions {
+    batch?: number;
+}
+export interface RecordOptions extends CommonOptions {
+    expand?: string;
+}
+export interface RecordListOptions extends ListOptions, RecordOptions {
+}
+export interface RecordFullListOptions extends FullListOptions, RecordOptions {
+}
+export interface RecordSubscribeOptions extends SendOptions {
+    fields?: string;
+    filter?: string;
+    expand?: string;
+}
+export interface LogStatsOptions extends CommonOptions {
+    filter?: string;
+}
+export interface FileOptions extends CommonOptions {
+    thumb?: string;
+    download?: boolean;
+}
+export interface AuthOptions extends CommonOptions {
+    /**
+     * If autoRefreshThreshold is set it will take care to auto refresh
+     * when necessary the auth data before each request to ensure that
+     * the auth state is always valid.
+     *
+     * The value must be in seconds, aka. the amount of seconds
+     * that will be subtracted from the current token `exp` claim in order
+     * to determine whether it is going to expire within the specified time threshold.
+     *
+     * For example, if you want to auto refresh the token if it is
+     * going to expire in the next 30mins (or already has expired),
+     * it can be set to `1800`
+     */
+    autoRefreshThreshold?: number;
+}
+export declare function normalizeUnknownQueryParams(options?: SendOptions): void;
+export declare function serializeQueryParams(params: LooseObject): string;

package/dist/types/src/tools/refresh.d.ts

@@ -0,0 +1,3 @@
+import Client from "../Client.js";
+export declare function resetAutoRefresh(client: Client): void;
+export declare function registerAutoRefresh(client: Client, threshold: number, refreshFunc: () => Promise<unknown>, reauthenticateFunc: () => Promise<unknown>): void;

package/package.json

@@ -1,6 +1,75 @@
 {
   "name": "@iglo.tech/iglo.base",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "JavaScript SDK for iglo.base (fork of the PocketBase JavaScript SDK v0.28.1)",
+  "keywords": [
+    "iglo.base",
+    "javascript-sdk",
+    "js-sdk",
+    "pocketbase",
+    "pocketbase-js"
+  ],
+  "license": "MIT",
+  "author": "Gani Georgiev",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/iglo-tech/iglo.base.git",
+    "directory": "sdk"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/iglo-base.es.mjs",
+  "module": "./dist/iglo-base.es.mjs",
+  "types": "./dist/types/src/index.d.ts",
+  "react-native": "./dist/iglo-base.es.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/types/src/index.d.ts",
+      "default": "./dist/iglo-base.es.mjs"
+    },
+    "./ssr": {
+      "types": "./dist/types/src/ssr/index.d.ts",
+      "browser": "./dist/ssr-browser.es.mjs",
+      "default": "./dist/ssr.es.mjs"
+    },
+    "./ssr/browser": {
+      "types": "./dist/types/src/ssr/browser-client.d.ts",
+      "default": "./dist/ssr-browser-client.es.mjs"
+    },
+    "./ssr/next": {
+      "types": "./dist/types/src/ssr/next.d.ts",
+      "browser": "./dist/ssr-browser.es.mjs",
+      "default": "./dist/ssr-next.es.mjs"
+    },
+    "./ssr/sveltekit": {
+      "types": "./dist/types/src/ssr/sveltekit.d.ts",
+      "browser": "./dist/ssr-browser.es.mjs",
+      "default": "./dist/ssr-sveltekit.es.mjs"
+    },
+    "./ssr/nuxt": {
+      "types": "./dist/types/src/ssr/nuxt.d.ts",
+      "browser": "./dist/ssr-browser.es.mjs",
+      "default": "./dist/ssr-nuxt.es.mjs"
+    },
+    "./ssr/astro": {
+      "types": "./dist/types/src/ssr/astro.d.ts",
+      "browser": "./dist/ssr-browser.es.mjs",
+      "default": "./dist/ssr-astro.es.mjs"
+    },
+    "./ssr/react-router": {
+      "types": "./dist/types/src/ssr/react-router.d.ts",
+      "browser": "./dist/ssr-browser.es.mjs",
+      "default": "./dist/ssr-react-router.es.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}