@agence-zef/sdk 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import type { ConfigCollections, ConfigGlobals, Registry, ZefConfig } from "@agence-zef/schema";
1
+ import type { ConfigCollections, Registry, ZefConfig } from "@agence-zef/schema";
2
2
  import type { ApiItem, ApiLayout, ApiLink, ApiList, ApiPage, ApiPageEntry, ApiPreviewDocument, ApiRedirect, ApiSection, ApiSite, ApiSyncResult } from "./types.js";
3
3
  export type * from "./types.js";
4
4
  /** Erreur renvoyée par l'API (clé invalide, schéma refusé…). */
@@ -15,13 +15,12 @@ export type ClientOptions = {
15
15
  fetch?: typeof fetch;
16
16
  };
17
17
  type Collections<C extends ZefConfig> = ZefConfig extends C ? Record<string, ApiItem> : ConfigCollections<C>;
18
- type Globals<C extends ZefConfig> = ZefConfig extends C ? Record<string, Record<string, unknown>> : ConfigGlobals<C>;
19
18
  type LocaleOption = {
20
19
  locale?: string;
21
20
  };
22
21
  /**
23
22
  * Client typé de l'API d'un site. Le type du registre (`typeof config`) donne
24
- * les noms de collections et de globals et la forme de leurs données.
23
+ * les noms de collections et la forme de leurs données.
25
24
  */
26
25
  export declare function createClient<C extends ZefConfig = ZefConfig>(options: ClientOptions): {
27
26
  /** Nom du site, langues, version du registre. */
@@ -35,7 +34,6 @@ export declare function createClient<C extends ZefConfig = ZefConfig>(options: C
35
34
  offset?: number;
36
35
  }) => Promise<ApiList<Collections<C>[K]>>;
37
36
  item: <K extends keyof Collections<C> & string>(name: K, slug: string, opts?: LocaleOption) => Promise<Collections<C>[K] | null>;
38
- global: <K extends keyof Globals<C> & string>(name: K, opts?: LocaleOption) => Promise<Globals<C>[K]>;
39
37
  /** Header et footer du site (sections partagées par toutes les pages). */
40
38
  layout: (opts?: LocaleOption) => Promise<ApiLayout>;
41
39
  /** Aperçu : header et footer en brouillon, champs marqués pour l'overlay. */
package/dist/index.js CHANGED
@@ -13,7 +13,7 @@ export class ZefApiError extends Error {
13
13
  }
14
14
  /**
15
15
  * Client typé de l'API d'un site. Le type du registre (`typeof config`) donne
16
- * les noms de collections et de globals et la forme de leurs données.
16
+ * les noms de collections et la forme de leurs données.
17
17
  */
18
18
  export function createClient(options) {
19
19
  const base = `${options.url.replace(/\/$/, "")}/api/v1`;
@@ -61,7 +61,6 @@ export function createClient(options) {
61
61
  query: opts,
62
62
  }), `Collection « ${name} »`),
63
63
  item: (name, slug, opts = {}) => request(`/collections/${encodeURIComponent(name)}/${encodeURIComponent(slug)}`, { query: opts }),
64
- global: async (name, opts = {}) => required(await request(`/globals/${encodeURIComponent(name)}`, { query: opts }), `Global « ${name} »`),
65
64
  /** Header et footer du site (sections partagées par toutes les pages). */
66
65
  layout: async (opts = {}) => required(await request("/layout", { query: opts }), "Header et footer"),
67
66
  /** Aperçu : header et footer en brouillon, champs marqués pour l'overlay. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agence-zef/sdk",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "description": "Client typé de l'API d'un CMS ZEF (client.agence-zef.fr/api/v1).",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -17,7 +17,7 @@
17
17
  "access": "public"
18
18
  },
19
19
  "dependencies": {
20
- "@agence-zef/schema": "0.1.0"
20
+ "@agence-zef/schema": "0.2.0"
21
21
  },
22
22
  "homepage": "https://agence-zef.fr",
23
23
  "scripts": {