@pylo/react 0.7.0

package/dist/index.d.ts

@@ -0,0 +1,87 @@
+import { EntityName, EntitySelect, EntityResult } from '@pylo/core';
+export { AggregateFilterInput, AggregateFunction, AggregateGroupByInput, AggregateInput, AggregateInterval, AggregateIntervalUnit, AggregateMetricInput, AggregateOptions, AggregateResult, AggregateRow, AggregateRows, AggregateSortInput, AggregateSortKey, AggregateTotal, ByIdOptions, CallableEntityName, CreateUploadInput, CreateUploadUrlOptions, DimensionInput, DimensionValue, EntityAggregateApi, EntityCapability, EntityFields, EntityMethodName, EntityName, EntityNameWith, EntityRelationPath, EntityRelations, EntityResult, EntitySelect, EventAggregateOptions, EventGroupByInput, EventListFilterInput, EventListOptions, EventMetricInput, FieldName, FilesClient, FilterInput, HasCapability, IngestEvents, ListOptions, ListResult, Me, MetricValue, MutationRequestOptions, NumericFieldName, PaginationData, PaginationInput, PyloError, PyloEvent, PyloEventFieldValue, PyloEventFieldValuesOptions, PyloEventInput, PyloEventListResult, PyloEventProperty, PyloEventPropertyKeysOptions, PyloUploadedFile, QueryInput, QueryInputCondition, QueryOperator, RequestOptions, RowKeyOf, SearchValueInput, SortInput, SortOrder, SystemEntityName, TimeBucketInput, UploadAttachTarget, UploadOptions, UploadProgress, UploadSource, UploadUrl, UpsertInput, VirtualEntityName } from '@pylo/core';
+import { P as PyloStorage } from './provider-DTTtfhib.js';
+export { a as PyloAuth, b as PyloProvider, c as PyloProviderProps, d as createLocalStorageAdapter, e as createMemoryStorage, u as usePyloAuth, f as usePyloClient, g as usePyloTransport } from './provider-DTTtfhib.js';
+import { AuthResult } from '@pylo/auth';
+export { AuthResult, PyloUser } from '@pylo/auth';
+export { D as DirectTransportOptions, T as Transport, c as createDirectTransport } from './transport-55cSrvQo.js';
+export { InfiniteListOptions, ListHookResult, StartUploadOptions, UploadHookOptions, UploadHookResult, createPyloHooks } from './hooks.js';
+import 'react/jsx-runtime';
+import 'react';
+import '@tanstack/react-query';
+
+type SessionStatus = "loading" | "signedIn" | "signedOut";
+interface SessionState {
+    status: SessionStatus;
+    token: string | null;
+}
+interface SessionStoreOptions {
+    endpoint: string;
+    storage: PyloStorage;
+    appId?: string;
+    /** Namespaces the storage keys, for apps holding more than one session. */
+    keyPrefix?: string;
+    onSignOut?: () => void;
+    /** Called after a successful login, not after a refresh. */
+    onSignIn?: () => void;
+}
+interface SessionStore {
+    getState(): SessionState;
+    subscribe(listener: () => void): () => void;
+    init(): Promise<void>;
+    /** The token to send, refreshed first if it is close enough to expiry. */
+    getToken(): Promise<string | null>;
+    /** Forces a refresh regardless of expiry. Used after a rejected request. */
+    refresh(): Promise<string | null>;
+    login(email: string, password: string): Promise<AuthResult>;
+    logout(): Promise<void>;
+}
+declare function createSessionStore(options: SessionStoreOptions): SessionStore;
+
+/**
+ * Augmentable registry that pins the schema type for the `PyloSelect` /
+ * `PyloResult` helpers. Generated code augments it, e.g.:
+ *
+ *   declare module "@pylo/react" {
+ *     interface PyloRegister { schema: PyloSchema }
+ *   }
+ *
+ * With no augmentation the helpers fall back to an untyped (`any`) schema.
+ */
+interface PyloRegister {
+}
+type RegisteredSchema = PyloRegister extends {
+    schema: infer S;
+} ? S : any;
+/**
+ * Entity keys available on the registered schema — e.g. `"contact"`. Use as the
+ * type parameter for {@link PyloSelect} / {@link PyloResult}.
+ */
+type PyloEntity = EntityName<RegisteredSchema>;
+/**
+ * A reusable, type-safe selection for one entity on the registered schema.
+ * Lets you define what to fetch once and reuse it across hooks.
+ *
+ * Declare the selection with `satisfies` (not a plain `: PyloSelect<…>`
+ * annotation) so the exact set of selected fields is preserved — that's what
+ * keeps {@link PyloResult} precise:
+ *
+ * ```ts
+ * const contactSelect = {
+ *   name: true,
+ *   email: true,
+ *   company: { select: { name: true } },
+ * } satisfies PyloSelect<"contact">;
+ *
+ * const { data } = usePyloList("contact", { select: contactSelect });
+ * type Contact = PyloResult<"contact", typeof contactSelect>;
+ * ```
+ */
+type PyloSelect<E extends PyloEntity> = EntitySelect<RegisteredSchema, E>;
+/**
+ * The row type returned for a given entity and selection. Pair with
+ * `typeof <yourSelect>` (see {@link PyloSelect}) for an exact result type.
+ */
+type PyloResult<E extends PyloEntity, Sel extends PyloSelect<E>> = EntityResult<RegisteredSchema, E, Sel>;
+
+export { type PyloEntity, type PyloRegister, type PyloResult, type PyloSelect, PyloStorage, type RegisteredSchema, type SessionState, type SessionStatus, type SessionStore, type SessionStoreOptions, createSessionStore };

package/dist/index.js

@@ -0,0 +1,28 @@
+import {
+  createPyloHooks
+} from "./chunk-DOPZ5GRU.js";
+import {
+  PyloProvider,
+  createDirectTransport,
+  createLocalStorageAdapter,
+  createMemoryStorage,
+  createSessionStore,
+  usePyloAuth,
+  usePyloClient,
+  usePyloTransport
+} from "./chunk-IKQ52QLH.js";
+
+// src/index.ts
+import { PyloError } from "@pylo/core";
+export {
+  PyloError,
+  PyloProvider,
+  createDirectTransport,
+  createLocalStorageAdapter,
+  createMemoryStorage,
+  createPyloHooks,
+  createSessionStore,
+  usePyloAuth,
+  usePyloClient,
+  usePyloTransport
+};

package/dist/provider-DTTtfhib.d.ts

@@ -0,0 +1,50 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { PyloClient } from '@pylo/core';
+import { PyloUser, AuthResult } from '@pylo/auth';
+import { T as Transport } from './transport-55cSrvQo.js';
+
+/**
+ * The three operations a session needs from a key-value store. Async because
+ * the native implementations are: Expo's SecureStore has no synchronous API.
+ */
+interface PyloStorage {
+    getItem(key: string): Promise<string | null>;
+    setItem(key: string, value: string): Promise<void>;
+    removeItem(key: string): Promise<void>;
+}
+declare function createMemoryStorage(): PyloStorage;
+/**
+ * Persists to `localStorage`, falling back to memory where it is missing or
+ * blocked — server rendering, and Safari's private mode, which throws on write.
+ * Falling back means the session lasts the page's lifetime rather than failing
+ * outright, so a read consults memory whenever the web store comes up empty.
+ */
+declare function createLocalStorageAdapter(): PyloStorage;
+
+interface PyloProviderProps {
+    children: ReactNode;
+    endpoint?: string;
+    appId?: string;
+    storage?: PyloStorage;
+    keyPrefix?: string;
+    /**
+     * Escape hatch for apps whose auth lives elsewhere. Supplying it disables the
+     * session entirely: no login, no logout, no refresh.
+     */
+    getToken?: () => Promise<string | null>;
+}
+declare function PyloProvider(props: PyloProviderProps): react_jsx_runtime.JSX.Element;
+declare function usePyloTransport(): Transport;
+declare function usePyloClient<S>(): PyloClient<S>;
+interface PyloAuth {
+    isLoading: boolean;
+    isSignedIn: boolean;
+    user: PyloUser | undefined;
+    login: (email: string, password: string) => Promise<AuthResult>;
+    logout: () => Promise<void>;
+    getToken: () => Promise<string | null>;
+}
+declare function usePyloAuth(): PyloAuth;
+
+export { type PyloStorage as P, type PyloAuth as a, PyloProvider as b, type PyloProviderProps as c, createLocalStorageAdapter as d, createMemoryStorage as e, usePyloClient as f, usePyloTransport as g, usePyloAuth as u };

package/dist/provider.d.ts

@@ -0,0 +1,6 @@
+import 'react/jsx-runtime';
+import 'react';
+import '@pylo/core';
+import '@pylo/auth';
+export { a as PyloAuth, b as PyloProvider, c as PyloProviderProps, u as usePyloAuth, f as usePyloClient, g as usePyloTransport } from './provider-DTTtfhib.js';
+import './transport-55cSrvQo.js';

package/dist/provider.js

@@ -0,0 +1,12 @@
+import {
+  PyloProvider,
+  usePyloAuth,
+  usePyloClient,
+  usePyloTransport
+} from "./chunk-IKQ52QLH.js";
+export {
+  PyloProvider,
+  usePyloAuth,
+  usePyloClient,
+  usePyloTransport
+};

package/dist/transport-55cSrvQo.d.ts

@@ -0,0 +1,14 @@
+/**
+ * How the hooks reach the API. `@pylo/react` talks to it directly; `@pylo/nextjs`
+ * posts to its route handler so the token can stay in an httpOnly cookie.
+ */
+type Transport = (query: string, variables: Record<string, unknown>, headers?: Record<string, string>) => Promise<unknown>;
+interface DirectTransportOptions {
+    endpoint: string;
+    getToken: () => Promise<string | null>;
+    /** Called once on an unauthorized response; returns the token to retry with. */
+    onUnauthorized?: () => Promise<string | null>;
+}
+declare function createDirectTransport(options: DirectTransportOptions): Transport;
+
+export { type DirectTransportOptions as D, type Transport as T, createDirectTransport as c };

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@pylo/react",
+  "version": "0.7.0",
+  "description": "Type-safe React SDK for Pylo — hooks, session provider, client",
+  "type": "module",
+  "bin": {
+    "pylo": "dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./codegen": {
+      "types": "./dist/codegen.d.ts",
+      "import": "./dist/codegen.js",
+      "default": "./dist/codegen.js"
+    },
+    "./hooks": {
+      "types": "./dist/hooks.d.ts",
+      "import": "./dist/hooks.js",
+      "default": "./dist/hooks.js"
+    },
+    "./provider": {
+      "types": "./dist/provider.d.ts",
+      "import": "./dist/provider.js",
+      "default": "./dist/provider.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@pylo/auth": "0.0.6",
+    "@pylo/core": "0.7.0"
+  },
+  "peerDependencies": {
+    "@tanstack/react-query": ">=5.0.0",
+    "react": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@tanstack/react-query": "^5.0.0",
+    "@types/node": "^22.15.21",
+    "@types/react": "^19.0.0",
+    "react": "^19.0.0",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  },
+  "keywords": [
+    "pylo",
+    "react",
+    "sdk"
+  ],
+  "author": "Okeano GmbH",
+  "license": "MIT",
+  "homepage": "https://github.com/Okeano-GmbH/pylo-sdks/tree/main/react#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Okeano-GmbH/pylo-sdks.git",
+    "directory": "react"
+  },
+  "bugs": {
+    "url": "https://github.com/Okeano-GmbH/pylo-sdks/issues"
+  },
+  "scripts": {
+    "build": "tsup",
+    "watch": "tsc -w"
+  }
+}