@carlonicora/nextjs-jsonapi 6.20.5 → 6.20.6

package/dist/lib/direction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"direction.d.ts","sourceRoot":"","sources":["../../src/lib/direction.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC;AAC/D,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,OAAO,GAAG,KAAK,CAAC;AAEzD,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,KAAK,GAAG,KAAK,GAAG,YAAY,CAIvF"}

package/dist/lib/utils.d.ts

@@ -0,0 +1,3 @@
+export { cn } from "../utils/cn";
+export type { ClassValue } from "clsx";
+//# sourceMappingURL=utils.d.ts.map

package/dist/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/lib/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AACjC,YAAY,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC"}

package/dist/login/config.d.ts

@@ -0,0 +1,15 @@
+export type RegistrationMode = "open" | "closed" | "waitlist";
+export interface LoginConfig {
+    discordClientId?: string;
+    googleClientId?: string;
+    useInternalAuth?: boolean;
+    allowRegistration?: boolean;
+    registrationMode?: RegistrationMode;
+}
+export declare function configureLogin(params: LoginConfig): void;
+export declare function isDiscordAuthEnabled(): boolean;
+export declare function isGoogleAuthEnabled(): boolean;
+export declare function isInternalAuthEnabled(): boolean;
+export declare function isRegistrationAllowed(): boolean;
+export declare function getRegistrationMode(): RegistrationMode;
+//# sourceMappingURL=config.d.ts.map

package/dist/login/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/login/config.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE9D,MAAM,WAAW,WAAW;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAMxD;AAED,wBAAgB,oBAAoB,IAAI,OAAO,CAE9C;AAED,wBAAgB,mBAAmB,IAAI,OAAO,CAE7C;AAED,wBAAgB,qBAAqB,IAAI,OAAO,CAE/C;AAED,wBAAgB,qBAAqB,IAAI,OAAO,CAE/C;AAED,wBAAgB,mBAAmB,IAAI,gBAAgB,CAEtD"}

package/dist/login/index.d.ts

@@ -0,0 +1,3 @@
+export { configureLogin, isDiscordAuthEnabled, isGoogleAuthEnabled, isInternalAuthEnabled, isRegistrationAllowed, } from "./config";
+export type { LoginConfig } from "./config";
+//# sourceMappingURL=index.d.ts.map

package/dist/login/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/login/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,UAAU,CAAC;AAClB,YAAY,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC"}

package/dist/next-config/csp.d.ts

@@ -0,0 +1,26 @@
+export type CspDirective = "script-src" | "style-src" | "img-src" | "font-src" | "connect-src" | "frame-src" | "worker-src";
+/**
+ * Third-party services an app may load. Each one adds its hosts to the
+ * directives it needs; nothing is allowed unless the app names it.
+ *
+ * - `stripe`: the billing feature (`@carlonicora/nextjs-jsonapi/billing`).
+ * - `googleMaps`: `FormPlaceAutocomplete` (Places API) and Maps JS/static tiles.
+ * - `turnstile`: Cloudflare Turnstile widgets (contact and waitlist forms).
+ * - `discord`: Discord avatars shown for users who log in with Discord.
+ * - `googleFonts`: fonts linked at runtime from Google Fonts. Not needed for
+ *   `next/font/google`, which self-hosts at build time.
+ */
+export type CspService = "stripe" | "googleMaps" | "turnstile" | "discord" | "googleFonts";
+export interface CspOptions {
+    services?: CspService[];
+    csp?: Partial<Record<CspDirective, string[]>>;
+}
+/**
+ * Origins of the app's own servers, the API and the corpus, from
+ * `NEXT_PUBLIC_API_URL` and `NEXT_PUBLIC_CORPUS_URL`. They serve every stored
+ * object link, so images and frames must be allowed from them. Unset or invalid
+ * URLs are skipped; the result has no duplicates.
+ */
+export declare function listAppOrigins(env: NodeJS.ProcessEnv): string[];
+export declare function buildCsp(options: CspOptions, env: NodeJS.ProcessEnv): string;
+//# sourceMappingURL=csp.d.ts.map

package/dist/next-config/csp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"csp.d.ts","sourceRoot":"","sources":["../../src/next-config/csp.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,YAAY,GACtB,YAAY,GAAG,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,aAAa,GAAG,WAAW,GAAG,YAAY,CAAC;AAEnG;;;;;;;;;;GAUG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,GAAG,SAAS,GAAG,aAAa,CAAC;AAE3F,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IACxB,GAAG,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;CAC/C;AAgCD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,UAAU,GAAG,MAAM,EAAE,CAY/D;AAKD,wBAAgB,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,CAAC,UAAU,GAAG,MAAM,CAuE5E"}

package/dist/next-config/headers.d.ts

@@ -0,0 +1,15 @@
+import { type CspOptions } from "./csp";
+export interface SecurityHeaderOptions extends CspOptions {
+    permissionsPolicy?: {
+        camera?: "none" | "self";
+    };
+}
+export interface HeaderRule {
+    source: string;
+    headers: {
+        key: string;
+        value: string;
+    }[];
+}
+export declare function buildSecurityHeaders(options: SecurityHeaderOptions, env: NodeJS.ProcessEnv): HeaderRule[];
+//# sourceMappingURL=headers.d.ts.map

package/dist/next-config/headers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"headers.d.ts","sourceRoot":"","sources":["../../src/next-config/headers.ts"],"names":[],"mappings":"AACA,OAAO,EAAY,KAAK,UAAU,EAAE,MAAM,OAAO,CAAC;AAElD,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD,iBAAiB,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAClD;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC3C;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,EAAE,GAAG,EAAE,MAAM,CAAC,UAAU,GAAG,UAAU,EAAE,CAgDzG"}

package/dist/next-config/index.d.ts

@@ -1,32 +1,8 @@
-import { NextConfig } from 'next';
-
-type CspDirective = "script-src" | "style-src" | "img-src" | "font-src" | "connect-src" | "frame-src" | "worker-src";
-/**
- * Third-party services an app may load. Each one adds its hosts to the
- * directives it needs; nothing is allowed unless the app names it.
- *
- * - `stripe`: the billing feature (`@carlonicora/nextjs-jsonapi/billing`).
- * - `googleMaps`: `FormPlaceAutocomplete` (Places API) and Maps JS/static tiles.
- * - `turnstile`: Cloudflare Turnstile widgets (contact and waitlist forms).
- * - `discord`: Discord avatars shown for users who log in with Discord.
- * - `googleFonts`: fonts linked at runtime from Google Fonts. Not needed for
- *   `next/font/google`, which self-hosts at build time.
- */
-type CspService = "stripe" | "googleMaps" | "turnstile" | "discord" | "googleFonts";
-interface CspOptions {
-    services?: CspService[];
-    csp?: Partial<Record<CspDirective, string[]>>;
-}
-/**
- * Origins of the app's own servers, the API and the corpus, from
- * `NEXT_PUBLIC_API_URL` and `NEXT_PUBLIC_CORPUS_URL`. They serve every stored
- * object link, so images and frames must be allowed from them. Unset or invalid
- * URLs are skipped; the result has no duplicates.
- */
-declare function listAppOrigins(env: NodeJS.ProcessEnv): string[];
-declare function buildCsp(options: CspOptions, env: NodeJS.ProcessEnv): string;
-
-interface NjaNextConfigOptions {
+import type { NextConfig } from "next";
+import { buildCsp, listAppOrigins, type CspDirective, type CspService } from "./csp";
+export { buildCsp, listAppOrigins };
+export type { CspDirective, CspService };
+export interface NjaNextConfigOptions {
     devOrigins: string[];
     /** Third-party services the app loads; each adds its own hosts to the CSP. Nothing is allowed by default. */
     services?: CspService[];
@@ -44,6 +20,5 @@ interface NjaNextConfigOptions {
     rewrites?: NextConfig["rewrites"];
     extend?: (config: NextConfig) => NextConfig;
 }
-declare function createNextConfig(options: NjaNextConfigOptions): NextConfig;
-
-export { type CspDirective, type CspService, type NjaNextConfigOptions, buildCsp, createNextConfig, listAppOrigins };
+export declare function createNextConfig(options: NjaNextConfigOptions): NextConfig;
+//# sourceMappingURL=index.d.ts.map

package/dist/next-config/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/next-config/index.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,KAAK,YAAY,EAAE,KAAK,UAAU,EAAE,MAAM,OAAO,CAAC;AAGrF,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC;AACpC,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC;AAEzC,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,6GAA6G;IAC7G,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IACxB,0EAA0E;IAC1E,GAAG,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC9C,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,iBAAiB,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACjD,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;IAClC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,UAAU,CAAC;CAC7C;AAwBD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,oBAAoB,GAAG,UAAU,CA+D1E"}

package/dist/offline/config.d.ts

@@ -0,0 +1,79 @@
+import type { DeviceStore } from "./store/DeviceStore";
+import { NeedsConnectionError, type OfflineConfig, type OfflineRootKind } from "./types";
+/**
+ * The signed-in user's device store cannot be used: it could not be opened (opfs-sahpool holds
+ * one connection per origin, so a second tab cannot open it) or the user logged out. A request
+ * answered from the device copy then needs a connection (503 "needs-connection").
+ */
+export declare class DeviceStoreUnavailableError extends NeedsConnectionError {
+    constructor(message?: string);
+}
+/**
+ * This browser cannot keep the device copy at all: not a secure context (https or `localhost`),
+ * no private file storage (`navigator.storage.getDirectory`), or the worker reports the OPFS
+ * APIs missing. Offline mode switches off for the page (`markOfflineUnavailable`). A failure on
+ * a browser that can keep the copy (the file held by another tab) is a `DeviceStoreUnavailableError`.
+ */
+export declare class OfflineUnavailableError extends DeviceStoreUnavailableError {
+    constructor(reason: string);
+}
+/**
+ * Switches offline mode off for this page, once: one console warning, `available: false` in the
+ * offline state. From then on `isOfflineConfigured()` answers false, so no request, sync, drain,
+ * write-through or lock check touches the device copy again.
+ */
+export declare function markOfflineUnavailable(error: OfflineUnavailableError): void;
+/** Whether this browser can keep the device copy (true until found otherwise). */
+export declare function isOfflineAvailable(): boolean;
+/** Logout: the user's store is never opened again in this page until `unblockOfflineStore`. */
+export declare function blockOfflineStore(userId: string): void;
+/** A sign-in (`onUserSignedIn`): the user's store may be opened again. */
+export declare function unblockOfflineStore(userId: string): void;
+export declare function isOfflineStoreBlocked(userId: string): boolean;
+/** Opts the app into offline mode. Without this call nothing offline runs. */
+export declare function configureOffline(config: OfflineConfig): void;
+/**
+ * Configured, the browser can keep the device copy (see `markOfflineUnavailable`), and offline
+ * mode is on on this device for the signed-in user (see `requireOptIn`).
+ */
+export declare function isOfflineConfigured(): boolean;
+/**
+ * Whether offline mode is on on this device for `userId`. Always true without
+ * `OfflineConfig.requireOptIn`; otherwise the stored switch, false with no user.
+ */
+export declare function isOfflineEnabledOnDevice(userId?: string | null): boolean;
+/** Stores the device switch for `userId` (`turnOnOffline` / `turnOffOffline`). */
+export declare function setOfflineEnabledOnDevice(userId: string, enabled: boolean): void;
+/** When `userId`'s last full sync on this device finished (epoch ms), or null. */
+export declare function readOfflineLastSync(userId: string): number | null;
+/** Stores, or with null removes, when `userId`'s last full sync finished. */
+export declare function writeOfflineLastSync(userId: string, at: number | null): void;
+/**
+ * Reads the device switch and the last sync time of the signed-in user into the offline state
+ * (`enabled`, `lastSyncedAt`). Does nothing before `configureOffline`.
+ */
+export declare function refreshOfflineDeviceState(): void;
+/**
+ * Every kind of root record: the primary one (`rootModule` + `listSyncRoots`) first, then
+ * `extraRootKinds`. Library-internal (not exported from the entry).
+ */
+export declare function rootKinds(config: OfflineConfig): OfflineRootKind[];
+export declare function getOfflineConfig(): OfflineConfig;
+/** The browser opener, set by the `./offline` entry's `configureOffline`. */
+export declare function setDefaultDeviceStoreOpener(opener: (userId: string) => Promise<DeviceStore>): void;
+/** The URL the device worker loads SQLite from (`OfflineConfig.sqliteModuleUrl`). */
+export declare function getSqliteModuleUrl(): string;
+/** The URL the device worker is started from (`OfflineConfig.deviceWorkerUrl`). */
+export declare function getDeviceWorkerUrl(): string;
+/** Replaces how a user's device store is opened (tests pass `openMemoryDeviceStore`). */
+export declare function setDeviceStoreOpener(opener: ((userId: string) => Promise<DeviceStore>) | null): void;
+/**
+ * The signed-in user's device store, opened once per user id. Only the signed-in user's file is
+ * ever opened; with no signed-in user the request needs a connection.
+ */
+export declare function getOfflineStore(): Promise<DeviceStore>;
+/** Forgets the opened store of a user (logout, deleted file). */
+export declare function forgetOfflineStore(userId: string): void;
+/** Test helper: back to "not configured". */
+export declare function resetOfflineConfig(): void;
+//# sourceMappingURL=config.d.ts.map

package/dist/offline/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/offline/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAGL,oBAAoB,EACpB,KAAK,aAAa,EAClB,KAAK,eAAe,EACrB,MAAM,SAAS,CAAC;AAqCjB;;;;GAIG;AACH,qBAAa,2BAA4B,SAAQ,oBAAoB;gBACvD,OAAO,GAAE,MAAuD;CAI7E;AAED;;;;;GAKG;AACH,qBAAa,uBAAwB,SAAQ,2BAA2B;gBAC1D,MAAM,EAAE,MAAM;CAI3B;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,uBAAuB,GAAG,IAAI,CAI3E;AAED,kFAAkF;AAClF,wBAAgB,kBAAkB,IAAI,OAAO,CAE5C;AAED,+FAA+F;AAC/F,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAGtD;AAED,0EAA0E;AAC1E,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAExD;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAE7D;AAED,8EAA8E;AAC9E,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAI5D;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,OAAO,CAE7C;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CASxE;AAED,kFAAkF;AAClF,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAGhF;AAED,kFAAkF;AAClF,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAGjE;AAED,6EAA6E;AAC7E,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAE5E;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,IAAI,CAQhD;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,aAAa,GAAG,eAAe,EAAE,CAElE;AAED,wBAAgB,gBAAgB,IAAI,aAAa,CAGhD;AAED,6EAA6E;AAC7E,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI,CAElG;AAED,qFAAqF;AACrF,wBAAgB,kBAAkB,IAAI,MAAM,CAE3C;AAED,mFAAmF;AACnF,wBAAgB,kBAAkB,IAAI,MAAM,CAE3C;AAED,yFAAyF;AACzF,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAGpG;AAED;;;GAGG;AACH,wBAAsB,eAAe,IAAI,OAAO,CAAC,WAAW,CAAC,CAuB5D;AAED,iEAAiE;AACjE,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAEvD;AAED,6CAA6C;AAC7C,wBAAgB,kBAAkB,IAAI,IAAI,CAMzC"}

package/dist/offline/configure.d.ts

@@ -0,0 +1,8 @@
+import type { OfflineConfig } from "./types";
+/**
+ * Opts the app into offline mode (the `./offline` entry's `configureOffline`). It also registers
+ * the browser device-store opener, so the store, the worker and SQLite are reachable only from
+ * this entry, never from the request path every other entry shares.
+ */
+export declare function configureOffline(config: OfflineConfig): void;
+//# sourceMappingURL=configure.d.ts.map

package/dist/offline/configure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configure.d.ts","sourceRoot":"","sources":["../../src/offline/configure.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAK5D"}

package/dist/offline/device-switch.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Turns offline mode on on this device for the signed-in user (`OfflineConfig.requireOptIn`).
+ * It does not start the runtime: the app starts it once `enabled` is true in the offline state.
+ */
+export declare function turnOnOffline(): Promise<void>;
+/**
+ * Turns offline mode off on this device for the signed-in user and deletes this device's copy
+ * (database and cached images). Refuses, changing nothing, while the copy has changes still to
+ * send: the answer then carries how many.
+ */
+export declare function turnOffOffline(): Promise<{
+    turnedOff: true;
+} | {
+    turnedOff: false;
+    pending: number;
+}>;
+//# sourceMappingURL=device-switch.d.ts.map

package/dist/offline/device-switch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-switch.d.ts","sourceRoot":"","sources":["../../src/offline/device-switch.ts"],"names":[],"mappings":"AAkBA;;;GAGG;AACH,wBAAsB,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAUnD;AAED;;;;GAIG;AACH,wBAAsB,cAAc,IAAI,OAAO,CAAC;IAAE,SAAS,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,SAAS,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CAmC3G"}

package/dist/offline/generic-answers.d.ts

@@ -0,0 +1,108 @@
+import type { DeviceStore, StoredLink, StoredRecord } from "./store/DeviceStore";
+import type { LocalAnswerContext, OfflineAnswer, OfflineConfig, OfflineRoute, OfflineTypeConfig } from "./types";
+/** A JSON:API errors document with one error, answered with `status`. */
+export declare function errorAnswer(status: number, title: string, detail: string, code?: string): OfflineAnswer;
+export declare function needsConnectionAnswer(detail?: string): OfflineAnswer;
+export declare function notFoundAnswer(detail: string): OfflineAnswer;
+/** A single document of one stored record, with `included` (`includedFor`). */
+export declare function singleAnswer(store: DeviceStore, record: StoredRecord, status?: number): Promise<OfflineAnswer>;
+export declare function isRootWriteLocked(rootId: string | undefined): boolean;
+/**
+ * The `included` of a local answer: the stored records linked to `records` (the synced links),
+ * then the stored records their relationships point to, and one level further the stored records
+ * the relationships of those included records point to (an NPC's root record, then the root record's
+ * owner), so a model reads the same nested relationships it reads from the server.
+ *
+ * Stored resources point at each other (a root record at its owner, the owner at the root record's
+ * company, the company back at the owner); `RehydrationFactory` skips a resource met again inside
+ * its own chain, so those circles never recurse.
+ */
+export declare function includedFor(store: DeviceStore, records: StoredRecord[]): Promise<any[]>;
+/** The server's default list order (`defineEntity` sets `defaultOrderBy: "updatedAt DESC"`). */
+export declare const SERVER_DEFAULT_ORDER_BY = "updatedAt DESC";
+export type ListOptions = {
+    /** The string attributes the server's fulltext index covers (default: every string attribute). */
+    searchFields?: string[];
+    /** The order with no `orderBy` (default `updatedAt DESC`, the server's). */
+    defaultOrderBy?: string;
+};
+/**
+ * `search` as the server runs it: the term is split into letter/digit tokens and a record
+ * matches when every token appears, case-insensitive, inside one of its indexed string
+ * attributes (the fulltext query `*token* AND ...`).
+ */
+export declare function searchRecords(records: StoredRecord[], query: URLSearchParams, options?: ListOptions): StoredRecord[];
+/**
+ * Orders records as the server's `ORDER BY` does for `orderBy` (`field` or `field ASC|DESC`),
+ * or for the default order when there is none. `null` when the server would refuse the
+ * `orderBy` (400).
+ */
+export declare function orderRecords(records: StoredRecord[], query: URLSearchParams, options?: ListOptions): StoredRecord[] | null;
+/**
+ * One list answer for a set of stored records, as the server answers a list: `search`, then
+ * `orderBy` (or the default order), then paged the way `JsonApiPaginator` pages (`fetchAll`,
+ * `page[size]`, `page[offset]`), with `included`. App answers pass the records they selected.
+ */
+export declare function listAnswer(ctx: LocalAnswerContext, records: StoredRecord[], options?: ListOptions): Promise<OfflineAnswer>;
+/**
+ * A list document of stored records in the order the caller settled, every record in one page,
+ * with `included`: for an app's custom list query that has its own `ORDER BY` and no paging.
+ */
+export declare function orderedListAnswer(store: DeviceStore, records: StoredRecord[]): Promise<OfflineAnswer>;
+/**
+ * A list document of resources the device computed rather than stored (a query-result
+ * projection such as a search hit, built by its model), answered as they are, nothing included.
+ */
+export declare function resourceListAnswer(resources: any[]): OfflineAnswer;
+/**
+ * The kind a link written on the device carries for relationship `name`: the Neo4j type the
+ * type config maps it to (the kind synced links carry), otherwise the name itself.
+ */
+export declare function linkKindFor(typeConfig: OfflineTypeConfig | undefined, name: string): string;
+/**
+ * Every kind a link of relationship `name` may carry on the device: the name (written on the
+ * device before a mapping existed) and the mapped Neo4j type (synced). `undefined` when the
+ * Neo4j type is not known: then a link of any kind may be the one.
+ */
+export declare function linkKindsOf(typeConfig: OfflineTypeConfig | undefined, name: string): string[] | undefined;
+/**
+ * The stored links of `id` whose kind is one of `kinds` (Neo4j types and/or relationship
+ * names). `out`: links from `id`; `in`: links to `id`; `both`: either.
+ */
+export declare function linksOfKind(store: DeviceStore, id: string, kinds: string[], direction?: "out" | "in" | "both"): Promise<StoredLink[]>;
+/**
+ * The root record a record belongs to: itself (the type of any root kind), a relationship to a
+ * root of any kind, or a related stored record.
+ */
+export declare function rootIdForResource(store: DeviceStore, config: OfflineConfig, resource: any): Promise<string | undefined>;
+/** The `data` of a JSON:API document a model built (`createJsonApi()` or a dedicated method). */
+export type ResourceDocumentData = {
+    attributes?: Record<string, unknown>;
+    relationships?: Record<string, unknown>;
+    meta?: Record<string, unknown>;
+};
+/**
+ * The resource a create document stands for, under `identity`: the document's attributes,
+ * relationships and meta, as the device stores a record it creates.
+ */
+export declare function resourceFromDocument(document: any, identity: {
+    type: string;
+    id: string;
+}): any;
+/**
+ * A stored resource with a document's `data` written over it: attributes and relationships merged
+ * by name, and meta merged when the document carries one, as the device applies an edit.
+ */
+export declare function mergeResource(before: any, identity: {
+    type: string;
+    id: string;
+}, data: ResourceDocumentData): any;
+/** The request path as `EndpointCreator` built it, query string included. */
+export declare function queuePath(ctx: Pick<LocalAnswerContext, "request">): string;
+/**
+ * One set of routes per configured type, in matching order: the root record list before the
+ * related list (both are `x/:id/<type>`), the related list last. These generic routes are not
+ * queued by the layer: each write answer queues itself, with its base.
+ */
+export declare function buildGenericRoutes(config: OfflineConfig): OfflineRoute[];
+//# sourceMappingURL=generic-answers.d.ts.map

package/dist/offline/generic-answers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generic-answers.d.ts","sourceRoot":"","sources":["../../src/offline/generic-answers.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,KAAK,EACV,kBAAkB,EAClB,aAAa,EACb,aAAa,EAGb,YAAY,EACZ,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAQjB,yEAAyE;AACzE,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,aAAa,CAKvG;AAED,wBAAgB,qBAAqB,CAAC,MAAM,GAAE,MAA6B,GAAG,aAAa,CAE1F;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,CAE5D;AAED,+EAA+E;AAC/E,wBAAsB,YAAY,CAChC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,MAAM,GAAE,MAAY,GACnB,OAAO,CAAC,aAAa,CAAC,CAExB;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAErE;AAiCD;;;;;;;;;GASG;AACH,wBAAsB,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAyB7F;AA4BD,gGAAgG;AAChG,eAAO,MAAM,uBAAuB,mBAAmB,CAAC;AA8BxD,MAAM,MAAM,WAAW,GAAG;IACxB,kGAAkG;IAClG,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,4EAA4E;IAC5E,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,YAAY,EAAE,EACvB,KAAK,EAAE,eAAe,EACtB,OAAO,GAAE,WAAgB,GACxB,YAAY,EAAE,CAkBhB;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,YAAY,EAAE,EACvB,KAAK,EAAE,eAAe,EACtB,OAAO,GAAE,WAAgB,GACxB,YAAY,EAAE,GAAG,IAAI,CAWvB;AAYD;;;;GAIG;AACH,wBAAsB,UAAU,CAC9B,GAAG,EAAE,kBAAkB,EACvB,OAAO,EAAE,YAAY,EAAE,EACvB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,aAAa,CAAC,CAgDxB;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAS3G;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,aAAa,CAElE;AAUD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,iBAAiB,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE3F;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,iBAAiB,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAGzG;AAED;;;GAGG;AACH,wBAAsB,WAAW,CAC/B,KAAK,EAAE,WAAW,EAClB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,EAAE,EACf,SAAS,GAAE,KAAK,GAAG,IAAI,GAAG,MAAe,GACxC,OAAO,CAAC,UAAU,EAAE,CAAC,CAgBvB;AA2FD;;;GAGG;AACH,wBAAsB,iBAAiB,CACrC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,aAAa,EACrB,QAAQ,EAAE,GAAG,GACZ,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAa7B;AAwCD,iGAAiG;AACjG,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG,GAAG,CAO/F;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,EAAE,IAAI,EAAE,oBAAoB,GAAG,GAAG,CAWlH;AAiHD,6EAA6E;AAC7E,wBAAgB,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,kBAAkB,EAAE,SAAS,CAAC,GAAG,MAAM,CAG1E;AAWD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,aAAa,GAAG,YAAY,EAAE,CAqCxE"}