@nvisy/sdk 0.53.0 → 0.55.0

package/dist/standalone/index.js

@@ -1,153 +0,0 @@
-import { n as DEFAULTS, t as errorMiddleware } from "../error-D_h2zq6T.js";
-import createClient from "openapi-fetch";
-
-//#region src/standalone/http.ts
-/**
-* @fileoverview Shared openapi-fetch client factory for the SDK's standalone
-* operations (auth, health) that run before a {@link Nvisy} client exists.
-*
-* @module http
-* @internal
-*/
-/**
-* Build an unauthenticated openapi-fetch client from a {@link PublicConfig}.
-*
-* Applies the shared base URL / user-agent / header / fetch resolution used by
-* both the auth helpers and the health check.
-*/
-function createPublicClient(config, { json = false, errorHandling = true } = {}) {
-	const headers = {
-		"User-Agent": config?.userAgent ?? DEFAULTS.USER_AGENT,
-		...json ? { "Content-Type": "application/json" } : {},
-		...config?.headers
-	};
-	const client = createClient({
-		baseUrl: config?.baseUrl ?? DEFAULTS.BASE_URL,
-		headers,
-		fetch: config?.fetch,
-		...config?.credentials ? { credentials: config.credentials } : {}
-	});
-	if (errorHandling) client.use(errorMiddleware);
-	return client;
-}
-
-//#endregion
-//#region src/standalone/auth.ts
-/**
-* Creates an unauthenticated API client for auth operations.
-*
-* @param config - Optional configuration options
-* @returns A configured openapi-fetch client without authentication
-* @internal
-*/
-function createAuthClient(config) {
-	return createPublicClient(config, { json: true });
-}
-/**
-* Login with email and password, starting a browser session.
-*
-* A standalone function that needs no existing {@link Client}. Sets HttpOnly
-* session and CSRF cookies; returns no body. For a programmatic client, create
-* an API token instead and pass it as `apiToken` when constructing the client.
-*
-* @param credentials - Login credentials (identifier and password)
-* @param config - Optional configuration (baseUrl, credentials, headers,
-*   userAgent, fetch); pass `credentials: "include"` for a cross-origin session
-* @returns Promise that resolves once the session is started
-* @throws {ApiError} If the credentials are invalid or the request fails
-*
-* @example
-* ```typescript
-* import { login } from "@nvisy/sdk/standalone";
-*
-* await login(
-*   { identifier: "user@example.com", password: "your-password" },
-*   { credentials: "include" },
-* );
-* ```
-*/
-async function login(credentials, config) {
-	await createAuthClient(config).POST("/auth/login", { body: credentials });
-}
-/**
-* Sign up a new account, starting a browser session.
-*
-* A standalone function that needs no existing {@link Client}. Sets HttpOnly
-* session and CSRF cookies; returns no body. For a programmatic client, create
-* an API token instead and pass it as `apiToken` when constructing the client.
-*
-* @param details - Signup details (username, emailAddress, password, etc.)
-* @param config - Optional configuration (baseUrl, credentials, headers,
-*   userAgent, fetch); pass `credentials: "include"` for a cross-origin session
-* @returns Promise that resolves once the session is started
-* @throws {ApiError} If the signup fails (e.g., email already exists)
-*
-* @example
-* ```typescript
-* import { signup } from "@nvisy/sdk/standalone";
-*
-* await signup(
-*   {
-*     username: "johndoe",
-*     emailAddress: "john@example.com",
-*     password: "secure-password",
-*   },
-*   { credentials: "include" },
-* );
-* ```
-*/
-async function signup(details, config) {
-	await createAuthClient(config).POST("/auth/signup", { body: details });
-}
-/**
-* Begin an OpenID Connect sign-in with a provider.
-*
-* A standalone function that needs no existing {@link Client}. Returns the
-* provider authorize URL to redirect the user to; on consent the provider
-* redirects to the callback, which signs the user in.
-*
-* @param provider - The identity provider to sign in with
-* @param query - Optional frontend URL to return to once done
-* @param config - Optional configuration (baseUrl, headers, userAgent, fetch)
-* @returns Promise that resolves with the provider authorize URL
-* @throws {ApiError} If the request fails
-*
-* @example
-* ```typescript
-* import { startOidcSignIn } from "@nvisy/sdk/standalone";
-*
-* const { authorizeUrl } = await startOidcSignIn("google", {
-*   redirectUri: "https://app.example.com/after-login",
-* });
-* window.location.href = authorizeUrl;
-* ```
-*/
-async function startOidcSignIn(provider, query, config) {
-	const { data } = await createAuthClient(config).GET("/auth/{provider}/start", { params: {
-		path: { provider },
-		query
-	} });
-	return data;
-}
-
-//#endregion
-//#region src/standalone/health.ts
-/**
-* Check the health status of the API, without an API token or a client.
-*
-* The health endpoint is public: an unauthenticated request returns a cached
-* status, an authenticated one performs a real-time check. This function sends
-* no token; pass one via `config.headers` if a real-time check is desired.
-*
-* @param config - Optional configuration (baseUrl, headers, userAgent, fetch)
-* @returns Promise that resolves with the API health status (for both the
-*   healthy `200` and degraded `503` responses)
-*/
-async function checkHealth(config) {
-	const { data, error } = await createPublicClient(config, { errorHandling: false }).GET("/health");
-	return data ?? error;
-}
-
-//#endregion
-export { checkHealth, login, signup, startOidcSignIn };
-//# sourceMappingURL=index.js.map

package/dist/standalone/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/standalone/http.ts","../../src/standalone/auth.ts","../../src/standalone/health.ts"],"sourcesContent":["/**\n * @fileoverview Shared openapi-fetch client factory for the SDK's standalone\n * operations (auth, health) that run before a {@link Nvisy} client exists.\n *\n * @module http\n * @internal\n */\n\nimport createClient from \"openapi-fetch\";\nimport type { ClientConfig } from \"@/config.js\";\nimport { DEFAULTS } from \"@/config.js\";\nimport { errorMiddleware } from \"@/middleware/index.js\";\nimport type { paths } from \"@/schema/api.js\";\n\n/** Config accepted by a standalone (unauthenticated) client. */\nexport type PublicConfig = Omit<ClientConfig, \"apiToken\">;\n\ninterface PublicClientOptions {\n\t/** Send a JSON `Content-Type` header (for requests with a body). */\n\tjson?: boolean;\n\t/**\n\t * Throw {@link NvisyApiError} / {@link NvisyError} on non-2xx responses and\n\t * network failures. Off for endpoints where a non-2xx body is a valid\n\t * result (e.g. health `503`).\n\t *\n\t * @default true\n\t */\n\terrorHandling?: boolean;\n}\n\n/**\n * Build an unauthenticated openapi-fetch client from a {@link PublicConfig}.\n *\n * Applies the shared base URL / user-agent / header / fetch resolution used by\n * both the auth helpers and the health check.\n */\nexport function createPublicClient(\n\tconfig?: PublicConfig,\n\t{ json = false, errorHandling = true }: PublicClientOptions = {},\n) {\n\tconst headers: Record<string, string> = {\n\t\t\"User-Agent\": config?.userAgent ?? DEFAULTS.USER_AGENT,\n\t\t...(json ? { \"Content-Type\": \"application/json\" } : {}),\n\t\t...config?.headers,\n\t};\n\n\tconst client = createClient<paths>({\n\t\tbaseUrl: config?.baseUrl ?? DEFAULTS.BASE_URL,\n\t\theaders,\n\t\t// `undefined` falls back to the global fetch inside openapi-fetch.\n\t\tfetch: config?.fetch,\n\t\t// Forward `credentials` so login/signup can establish a cross-origin\n\t\t// cookie session (the browser stores Set-Cookie only with \"include\").\n\t\t...(config?.credentials ? { credentials: config.credentials } : {}),\n\t});\n\n\tif (errorHandling) client.use(errorMiddleware);\n\treturn client;\n}\n","/**\n * @fileoverview Standalone authentication functions.\n *\n * These functions start a browser session without an existing client: login\n * and signup set HttpOnly session and CSRF cookies (they return no body), and\n * `startOidcSignIn` returns a provider authorize URL to redirect to.\n *\n * For a programmatic (non-browser) client, do not use these to obtain a\n * credential — a cookie session is not replayed across SDK calls. Instead\n * create an API token (via the account's api-tokens endpoint) and pass it as\n * `apiToken` when constructing a {@link Client}.\n *\n * @module standalone/auth\n *\n * @example\n * ```typescript\n * import { login } from \"@nvisy/sdk/standalone\";\n *\n * // Browser: start a cookie session\n * await login(\n *   { identifier: \"user@example.com\", password: \"...\" },\n *   { credentials: \"include\" },\n * );\n * ```\n */\n\nimport type {\n\tIdentityProvider,\n\tLogin,\n\tOidcStartResponse,\n\tSignup,\n} from \"@/datatypes/index.js\";\nimport type { AuthConfig } from \"@/standalone/config.js\";\nimport { createPublicClient } from \"@/standalone/http.js\";\n\n/**\n * Creates an unauthenticated API client for auth operations.\n *\n * @param config - Optional configuration options\n * @returns A configured openapi-fetch client without authentication\n * @internal\n */\nfunction createAuthClient(config?: AuthConfig) {\n\treturn createPublicClient(config, { json: true });\n}\n\n/**\n * Login with email and password, starting a browser session.\n *\n * A standalone function that needs no existing {@link Client}. Sets HttpOnly\n * session and CSRF cookies; returns no body. For a programmatic client, create\n * an API token instead and pass it as `apiToken` when constructing the client.\n *\n * @param credentials - Login credentials (identifier and password)\n * @param config - Optional configuration (baseUrl, credentials, headers,\n *   userAgent, fetch); pass `credentials: \"include\"` for a cross-origin session\n * @returns Promise that resolves once the session is started\n * @throws {ApiError} If the credentials are invalid or the request fails\n *\n * @example\n * ```typescript\n * import { login } from \"@nvisy/sdk/standalone\";\n *\n * await login(\n *   { identifier: \"user@example.com\", password: \"your-password\" },\n *   { credentials: \"include\" },\n * );\n * ```\n */\nexport async function login(\n\tcredentials: Login,\n\tconfig?: AuthConfig,\n): Promise<void> {\n\tconst client = createAuthClient(config);\n\tawait client.POST(\"/auth/login\", {\n\t\tbody: credentials,\n\t});\n}\n\n/**\n * Sign up a new account, starting a browser session.\n *\n * A standalone function that needs no existing {@link Client}. Sets HttpOnly\n * session and CSRF cookies; returns no body. For a programmatic client, create\n * an API token instead and pass it as `apiToken` when constructing the client.\n *\n * @param details - Signup details (username, emailAddress, password, etc.)\n * @param config - Optional configuration (baseUrl, credentials, headers,\n *   userAgent, fetch); pass `credentials: \"include\"` for a cross-origin session\n * @returns Promise that resolves once the session is started\n * @throws {ApiError} If the signup fails (e.g., email already exists)\n *\n * @example\n * ```typescript\n * import { signup } from \"@nvisy/sdk/standalone\";\n *\n * await signup(\n *   {\n *     username: \"johndoe\",\n *     emailAddress: \"john@example.com\",\n *     password: \"secure-password\",\n *   },\n *   { credentials: \"include\" },\n * );\n * ```\n */\nexport async function signup(\n\tdetails: Signup,\n\tconfig?: AuthConfig,\n): Promise<void> {\n\tconst client = createAuthClient(config);\n\tawait client.POST(\"/auth/signup\", {\n\t\tbody: details,\n\t});\n}\n\n/**\n * Begin an OpenID Connect sign-in with a provider.\n *\n * A standalone function that needs no existing {@link Client}. Returns the\n * provider authorize URL to redirect the user to; on consent the provider\n * redirects to the callback, which signs the user in.\n *\n * @param provider - The identity provider to sign in with\n * @param query - Optional frontend URL to return to once done\n * @param config - Optional configuration (baseUrl, headers, userAgent, fetch)\n * @returns Promise that resolves with the provider authorize URL\n * @throws {ApiError} If the request fails\n *\n * @example\n * ```typescript\n * import { startOidcSignIn } from \"@nvisy/sdk/standalone\";\n *\n * const { authorizeUrl } = await startOidcSignIn(\"google\", {\n *   redirectUri: \"https://app.example.com/after-login\",\n * });\n * window.location.href = authorizeUrl;\n * ```\n */\nexport async function startOidcSignIn(\n\tprovider: IdentityProvider,\n\tquery?: { redirectUri?: string },\n\tconfig?: AuthConfig,\n): Promise<OidcStartResponse> {\n\tconst client = createAuthClient(config);\n\tconst { data } = await client.GET(\"/auth/{provider}/start\", {\n\t\tparams: { path: { provider }, query },\n\t});\n\treturn data!;\n}\n","/**\n * @fileoverview Standalone API health check.\n *\n * This module provides a `checkHealth` function that does not require an API\n * token or a {@link Nvisy} client. Use it as a pre-auth liveness probe.\n *\n * @module standalone/health\n *\n * @example\n * ```typescript\n * import { checkHealth } from \"@nvisy/sdk/standalone\";\n *\n * const health = await checkHealth();\n * if (health.status !== \"healthy\") {\n *   // back off, retry, alert, ...\n * }\n * ```\n */\n\nimport type { Health } from \"@/datatypes/index.js\";\nimport type { HealthConfig } from \"@/standalone/config.js\";\nimport { createPublicClient } from \"@/standalone/http.js\";\n\n/**\n * Check the health status of the API, without an API token or a client.\n *\n * The health endpoint is public: an unauthenticated request returns a cached\n * status, an authenticated one performs a real-time check. This function sends\n * no token; pass one via `config.headers` if a real-time check is desired.\n *\n * @param config - Optional configuration (baseUrl, headers, userAgent, fetch)\n * @returns Promise that resolves with the API health status (for both the\n *   healthy `200` and degraded `503` responses)\n */\nexport async function checkHealth(config?: HealthConfig): Promise<Health> {\n\t// `errorHandling: false` — the health endpoint returns a `Health` body on\n\t// both `200` (healthy) and `503` (degraded); a degraded status is a valid\n\t// result to return, not an error to throw.\n\tconst client = createPublicClient(config, { errorHandling: false });\n\n\tconst { data, error } = await client.GET(\"/health\");\n\t// `data` on 200, `error` on 503 — both carry a `Health` body.\n\treturn (data ?? error) as Health;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAoCA,SAAgB,mBACf,QACA,EAAE,OAAO,OAAO,gBAAgB,SAA8B,CAAC,GAC9D;CACD,MAAM,UAAkC;EACvC,cAAc,QAAQ,aAAa,SAAS;EAC5C,GAAI,OAAO,EAAE,gBAAgB,mBAAmB,IAAI,CAAC;EACrD,GAAG,QAAQ;CACZ;CAEA,MAAM,SAAS,aAAoB;EAClC,SAAS,QAAQ,WAAW,SAAS;EACrC;EAEA,OAAO,QAAQ;EAGf,GAAI,QAAQ,cAAc,EAAE,aAAa,OAAO,YAAY,IAAI,CAAC;CAClE,CAAC;CAED,IAAI,eAAe,OAAO,IAAI,eAAe;CAC7C,OAAO;AACR;;;;;;;;;;;AChBA,SAAS,iBAAiB,QAAqB;CAC9C,OAAO,mBAAmB,QAAQ,EAAE,MAAM,KAAK,CAAC;AACjD;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,eAAsB,MACrB,aACA,QACgB;CAEhB,MADe,iBAAiB,MACrB,CAAC,CAAC,KAAK,eAAe,EAChC,MAAM,YACP,CAAC;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,eAAsB,OACrB,SACA,QACgB;CAEhB,MADe,iBAAiB,MACrB,CAAC,CAAC,KAAK,gBAAgB,EACjC,MAAM,QACP,CAAC;AACF;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,eAAsB,gBACrB,UACA,OACA,QAC6B;CAE7B,MAAM,EAAE,SAAS,MADF,iBAAiB,MACJ,CAAC,CAAC,IAAI,0BAA0B,EAC3D,QAAQ;EAAE,MAAM,EAAE,SAAS;EAAG;CAAM,EACrC,CAAC;CACD,OAAO;AACR;;;;;;;;;;;;;;;ACnHA,eAAsB,YAAY,QAAwC;CAMzE,MAAM,EAAE,MAAM,UAAU,MAFT,mBAAmB,QAAQ,EAAE,eAAe,MAAM,CAE9B,CAAC,CAAC,IAAI,SAAS;CAElD,OAAQ,QAAQ;AACjB"}