@crombolo/delivery-client 0.39.0 → 0.40.0

package/dist/index.d.ts

@@ -213,8 +213,14 @@ export interface ApiImageCropper {
 export interface DeliverySchema {
     content: object;
     media: object;
+    /** The aliases of the site's settings types (story 058), when it has any. */
+    settings?: string;
 }
 type Aliases<Map> = Extract<keyof Map, string>;
+/** The site's settings page: of its settings type when the schema names one, else any page. */
+export type SettingsItem<Schema extends DeliverySchema = DeliverySchema> = Schema extends {
+    settings: infer Alias extends Aliases<Schema['content']>;
+} ? ApiContentResponse<Alias, Schema['content'][Alias]> : ContentItem<Schema>;
 /** Any page the site serves, told apart by `contentType`. */
 export type ContentItem<Schema extends DeliverySchema = DeliverySchema> = DeliverySchema extends Schema ? ApiContentResponse : {
     [Alias in Aliases<Schema['content']>]: ApiContentResponse<Alias, Schema['content'][Alias]>;
@@ -435,13 +441,23 @@ export interface DeliveryClient<Schema extends DeliverySchema = DeliverySchema>
     media<Options extends MediaQuery>(query: Options): Promise<Paged<Fielded<MediaItem<Schema>, Options>>>;
     /** Published pages matching every word of the term, best first. */
     search(term: string, options?: SearchOptions): Promise<Paged<SearchHit<Schema>>>;
+    /** A menu by its alias, in the culture asked for; undefined when there is none. */
+    menu(alias: string, options?: Pick<RequestOptions, 'culture' | 'signal'>): Promise<ApiMenu | undefined>;
+    /**
+     * Every dictionary item in the culture asked for, as key to text, each falling
+     * back as a template's `dictionary()` does; `keys` narrows it (story 058).
+     */
+    dictionary(keys?: readonly string[], options?: Pick<RequestOptions, 'culture' | 'signal'>): Promise<Record<string, string>>;
+    /**
+     * The site's settings page, under `startItem`'s root or the first; undefined
+     * when it has none (story 058).
+     */
+    settings<Options extends Omit<RequestOptions, 'seo'>>(options?: Options): Promise<Fielded<SettingsItem<Schema>, Options> | undefined>;
     /**
      * What the site would answer at a visitor's address — the page, a redirect, or
      * not found — for an app's router. `host` picks the root and culture as the
      * site's domains do.
      */
-    /** A menu by its alias, in the culture asked for; undefined when there is none. */
-    menu(alias: string, options?: Pick<RequestOptions, 'culture' | 'signal'>): Promise<ApiMenu | undefined>;
     route(path: string, options?: Omit<RequestOptions, 'culture' | 'fields'> & {
         host?: string;
     }): Promise<RouteAnswer<Schema>>;

package/dist/index.js

@@ -197,6 +197,8 @@ function createDeliveryClient(options) {
     mediaItems: (keys, request) => get("media/items", [...ids(keys), ...shaping(request ?? {})], request ?? {}, "throw"),
     media: (query) => get("media", [["fetch", query.fetch], ...paging(query), ...shaping(query)], query, "throw"),
     menu: (alias, request = {}) => get(`menus/${encodeURIComponent(alias)}`, [], request, "undefined"),
+    dictionary: (keys, request = {}) => get("dictionary", keys && keys.length > 0 ? [["keys", keys.join(",")]] : [], request, "body"),
+    settings: (request) => get("settings", shaping(request ?? {}), request ?? {}, "undefined"),
     route: (path, request = {}) => get("route", [
       ["path", path],
       ...request.host ? [["host", request.host]] : [],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crombolo/delivery-client",
-  "version": "0.39.0",
+  "version": "0.40.0",
   "description": "A typed client for a crombolo site's Delivery API, for apps in the browser, Node or Bun. No dependencies.",
   "license": "MIT",
   "author": "Crombolo",