naro-js 0.6.1 → 0.7.0

package/dist/invoke/body.d.ts

@@ -0,0 +1,19 @@
+export type PreparedBody = {
+    body: BodyInit | undefined;
+    /** The content-type to send when the caller gave none; null: the runtime's. */
+    contentType: string | null;
+};
+/** The body as it goes, or null when JSON cannot hold it (a BigInt, a cycle). */
+export declare function prepareBody(body: unknown): PreparedBody | null;
+export type ReadAnswer = {
+    data: unknown;
+} | {
+    unreadable: unknown;
+};
+/**
+ * A 2xx answer's data by its content-type: JSON (empty is null), a Blob for
+ * octet-stream and PDF, the Response itself for an event stream (read as it
+ * comes), FormData for multipart, text otherwise; nothing is read for 204
+ * or HEAD.
+ */
+export declare function readAnswer(response: Response, method: string): Promise<ReadAnswer>;

package/dist/invoke/client.d.ts

@@ -0,0 +1,52 @@
+import type { AuthClient } from "../auth/client.js";
+import { type HttpConfig } from "../http.js";
+import { type FunctionsError } from "./errors.js";
+export type FunctionInvokeOptions = {
+    /**
+     * An object or array goes as JSON, a string as text, a Blob or bytes as
+     * `application/octet-stream`; FormData, URLSearchParams and a
+     * ReadableStream go as they are. Your own `content-type` wins.
+     */
+    body?: string | number | boolean | object | null;
+    /** `apikey` is always the client's; an `authorization` of yours is sent instead of the user's. */
+    headers?: Record<string, string> | Headers;
+    /** Default POST. */
+    method?: "GET" | "HEAD" | "POST" | "PUT" | "PATCH" | "DELETE";
+    /**
+     * `timeout` (ms) counts the whole call — the wait for a sign-in the page
+     * URL carried, a token renewal and one retry included — until the final
+     * answer's headers arrive. The body is not timed. `signal` stops the
+     * call at any of these waits; the sign-in and the renewal go on for the
+     * rest of the page.
+     */
+    timeout?: number;
+    signal?: AbortSignal;
+    /** Taken and ignored, as supabase-js callers pass it: Naro runs a function where Cloudflare does. */
+    region?: string;
+};
+/** Like every call's: `{ data, error }`, with the Response when one came. */
+export type FunctionsResponse<T> = {
+    data: T;
+    error: null;
+    response: Response;
+} | {
+    data: null;
+    error: FunctionsError;
+    response?: Response;
+};
+/**
+ * `/functions/` + the name, encoded, + whatever path and query follow it,
+ * as they are (plan P4): an encoded subpath is not encoded twice.
+ */
+export declare function functionPath(name: string): string;
+/**
+ * `naro.functions` (original spec §12.1, design §9): calls the project's
+ * functions at `/_naro/v1/functions/<name>` with the anon key and the
+ * signed-in user's access token — the one Data API and Storage send,
+ * renewed the same way. Resolves in every case.
+ */
+export declare class FunctionsClient {
+    #private;
+    constructor(http: HttpConfig, auth: AuthClient);
+    invoke<T = unknown>(name: string, options?: FunctionInvokeOptions): Promise<FunctionsResponse<T>>;
+}

package/dist/invoke/errors.d.ts

@@ -0,0 +1,38 @@
+export declare class FunctionsError<Context = unknown> extends Error {
+    readonly code: string;
+    readonly details?: unknown;
+    readonly context: Context;
+    constructor(code: string, message: string, context: Context, details?: unknown);
+}
+/** The function answered 4xx or 5xx — its own answer, wrapper errors included. */
+export declare class FunctionsHttpError extends FunctionsError<Response> {
+    constructor(response: Response);
+}
+/** Naro answered instead of the function (`x-relay-error: true`): the dispatcher or the gate. */
+export declare class FunctionsRelayError extends FunctionsError<Response> {
+    constructor(code: string, message: string, response: Response, details?: unknown);
+}
+/**
+ * No answer came back, `invoke` could not send what it was given, or a 2xx
+ * body could not be read as its content type says (INVALID_RESPONSE — the
+ * response is beside it).
+ */
+export declare class FunctionsFetchError extends FunctionsError<unknown> {
+    constructor(code: string, message: string, cause: unknown, details?: unknown);
+}
+/** The SDK's own words for what never reached a function (plan P5). */
+export declare const FUNCTIONS_MESSAGES: {
+    readonly timeout: (ms: number) => string;
+    readonly aborted: "The function call was stopped before the function answered.";
+    readonly invalidBody: "functions.invoke could not send this body: JSON cannot hold it (a BigInt or a cycle). Pass a string, a Blob, bytes, FormData, URLSearchParams or a stream instead.";
+    readonly invalidTimeout: "functions.invoke's timeout is whole milliseconds from 1 to 2147483647.";
+    readonly invalidHeaders: "functions.invoke's headers are not valid HTTP header names and values.";
+    readonly invalidName: "functions.invoke's name is a string: the function's name, then any path and query.";
+    readonly unencodableName: "functions.invoke's name is not well-formed Unicode: it has a lone surrogate.";
+    readonly dotSegments: 'functions.invoke\'s name cannot be "." or "..", and ".." in its path cannot leave /functions/.';
+    readonly invalidSignal: "functions.invoke's signal is not an AbortSignal.";
+    readonly bodyWithGetOrHead: "functions.invoke cannot send a body with GET or HEAD.";
+    /** `RELAY_ERROR`: a HEAD answer has no body, so Naro's code is not in it. */
+    readonly headRelay: (status: number) => string;
+    readonly unreadable: (status: number) => string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "naro-js",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Auth, data and files for your Naro project, from the browser or the server.",
   "type": "module",
   "sideEffects": false,
@@ -8,10 +8,21 @@
     "dist"
   ],
   "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "functions": [
+        "./dist/functions.d.ts"
+      ]
+    }
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./functions": {
+      "types": "./dist/functions.d.ts",
+      "default": "./dist/functions.js"
     }
   },
   "publishConfig": {
@@ -25,8 +36,9 @@
     "vitest": "3.2.7",
     "@next-deploy/config": "0.1.0",
     "@next-deploy/data-core": "0.1.0",
-    "@next-deploy/backend-worker": "0.1.0",
-    "@next-deploy/sdk": "0.1.0"
+    "@next-deploy/sdk": "0.1.0",
+    "@next-deploy/functions-runtime": "0.1.0",
+    "@next-deploy/backend-worker": "0.1.0"
   },
   "scripts": {
     "build": "tsup && pnpm build:types",