@adonis-agora/cms-client 0.1.0 → 0.2.1

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,8 +1,15 @@
1
+ import { type OffsetPage } from '@adonis-agora/filter-client';
1
2
  export type ContentQuery = {
2
- where?: Record<string, unknown>;
3
+ /**
4
+ * Sent as `filter[field]=…`: a value means equals, an array means any of them, and an object maps
5
+ * operators to operands (`{ views: { gte: 10 } }`).
6
+ */
7
+ filter?: Record<string, unknown>;
8
+ /** `-publishedAt,title`. */
3
9
  sort?: string;
4
- limit?: number;
10
+ /** 1-based. */
5
11
  page?: number;
12
+ size?: number;
6
13
  depth?: number;
7
14
  locale?: string;
8
15
  select?: string;
@@ -10,15 +17,8 @@ export type ContentQuery = {
10
17
  export type ContentDocument = Record<string, unknown> & {
11
18
  id: string;
12
19
  };
13
- export type ContentList<T> = {
14
- docs: T[];
15
- totalDocs: number;
16
- limit: number;
17
- page: number;
18
- totalPages: number;
19
- hasNextPage: boolean;
20
- hasPrevPage: boolean;
21
- };
20
+ /** `{ data, meta: { total, perPage, currentPage, lastPage, firstPage } }`. */
21
+ export type ContentList<T> = OffsetPage<T>;
22
22
  export type ContentClientOptions = {
23
23
  baseUrl: string;
24
24
  /** App token. The tenant is bound to it server-side — the client never chooses it. */
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvE,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,sFAAsF;IACtF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAEF,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,YAAY,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAMxC;CACF;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,SAAS,MAAM,GAAG,MAAM,EACrE,OAAO,EAAE,oBAAoB;IAgB3B,UAAU,CAAC,IAAI,SAAS,WAAW,GAAG,MAAM,GAAG,MAAM,QAAQ,IAAI;QAE7D,IAAI,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,UACvC,YAAY,GAClB,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAI1B,QAAQ,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,MAC9C,MAAM,UACH,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,QAAQ,CAAC,GAC5C,OAAO,CAAC,CAAC,CAAC;;IAMjB,MAAM,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,QAAQ,IAAI;QAE3C,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC;;EAMrF;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAsBpD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,KAAK,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAEvF,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,4BAA4B;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,eAAe;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvE,8EAA8E;AAC9E,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;AAE3C,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,sFAAsF;IACtF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAEF,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,YAAY,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAMxC;CACF;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,SAAS,MAAM,GAAG,MAAM,EACrE,OAAO,EAAE,oBAAoB;IAgB3B,UAAU,CAAC,IAAI,SAAS,WAAW,GAAG,MAAM,GAAG,MAAM,QAAQ,IAAI;QAE7D,IAAI,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,UACvC,YAAY,GAClB,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAI1B,QAAQ,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,MAC9C,MAAM,UACH,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,QAAQ,CAAC,GAC5C,OAAO,CAAC,CAAC,CAAC;;IAMjB,MAAM,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,QAAQ,IAAI;QAE3C,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC;;EAMrF;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAoBpD"}
package/dist/index.js CHANGED
@@ -1,3 +1,4 @@
1
+ import { flatObjectToQueryString } from '@adonis-agora/filter-client';
1
2
  export class ContentClientError extends Error {
2
3
  status;
3
4
  code;
@@ -49,25 +50,23 @@ export function createContentClient(options) {
49
50
  };
50
51
  }
51
52
  export function toSearch(query) {
53
+ const parts = [];
52
54
  const params = new URLSearchParams();
53
55
  for (const [key, value] of Object.entries(query)) {
54
56
  if (value === undefined)
55
57
  continue;
56
- if (key === 'where') {
57
- for (const [field, condition] of Object.entries(value)) {
58
- if (condition && typeof condition === 'object' && !Array.isArray(condition)) {
59
- for (const [operator, operand] of Object.entries(condition)) {
60
- params.set(`where[${field}][${operator}]`, String(operand));
61
- }
62
- continue;
63
- }
64
- params.set(`where[${field}][equals]`, String(condition));
65
- }
58
+ if (key === 'filter') {
59
+ const filter = Object.entries(value).map(([field, condition]) => [`filter[${field}]`, condition]);
60
+ const encoded = flatObjectToQueryString(Object.fromEntries(filter));
61
+ if (encoded)
62
+ parts.push(encoded);
66
63
  continue;
67
64
  }
68
65
  params.set(key, String(value));
69
66
  }
70
- const search = params.toString();
71
- return search ? `?${search}` : '';
67
+ const rest = params.toString();
68
+ if (rest)
69
+ parts.push(rest);
70
+ return parts.length > 0 ? `?${parts.join('&')}` : '';
72
71
  }
73
72
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA8BA,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAClC,MAAM,CAAS;IACf,IAAI,CAAS;IAEtB,YAAY,MAAc,EAAE,IAAa;QACvC,MAAM,KAAK,GAAI,IAAwD,EAAE,KAAK,CAAC;QAC/E,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,8BAA8B,MAAM,EAAE,CAAC,CAAC;QAChE,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,IAAI,IAAI,UAAU,CAAC;IACxC,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAA6B;IAE7B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACnD,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAErE,KAAK,UAAU,OAAO,CAAI,IAAY;QACpC,MAAM,OAAO,GAA2B,EAAE,MAAM,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3F,IAAI,OAAO,CAAC,KAAK;YAAE,OAAO,CAAC,aAAa,GAAG,UAAU,OAAO,CAAC,KAAK,EAAE,CAAC;QAErE,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,OAAO,GAAG,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QACnE,MAAM,OAAO,GAAY,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,IAAI,kBAAkB,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACzE,OAAO,OAAY,CAAC;IACtB,CAAC;IAED,OAAO;QACL,UAAU,CAA6C,IAAU;YAC/D,OAAO;gBACL,IAAI,CACF,KAAK,GAAiB,EAAE;oBAExB,OAAO,OAAO,CAAiB,gBAAgB,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAC3E,CAAC;gBAED,QAAQ,CACN,EAAU,EACV,KAAK,GAA2C,EAAE;oBAElD,OAAO,OAAO,CAAI,gBAAgB,IAAI,IAAI,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACpE,CAAC;aACF,CAAC;QACJ,CAAC;QAED,MAAM,CAA+B,IAAU;YAC7C,OAAO;gBACL,GAAG;oBACD,OAAO,OAAO,CAAI,YAAY,IAAI,EAAE,CAAC,CAAC;gBACxC,CAAC;aACF,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAmB;IAC1C,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IAErC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;YACpB,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,EAAE,CAAC;gBAClF,IAAI,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC5E,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAoC,CAAC,EAAE,CAAC;wBACvF,MAAM,CAAC,GAAG,CAAC,SAAS,KAAK,KAAK,QAAQ,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;oBAC9D,CAAC;oBACD,SAAS;gBACX,CAAC;gBACD,MAAM,CAAC,GAAG,CAAC,SAAS,KAAK,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;YAC3D,CAAC;YACD,SAAS;QACX,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;IACjC,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACpC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAmB,MAAM,6BAA6B,CAAC;AA+BvF,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAClC,MAAM,CAAS;IACf,IAAI,CAAS;IAEtB,YAAY,MAAc,EAAE,IAAa;QACvC,MAAM,KAAK,GAAI,IAAwD,EAAE,KAAK,CAAC;QAC/E,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,8BAA8B,MAAM,EAAE,CAAC,CAAC;QAChE,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,IAAI,IAAI,UAAU,CAAC;IACxC,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAA6B;IAE7B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACnD,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAErE,KAAK,UAAU,OAAO,CAAI,IAAY;QACpC,MAAM,OAAO,GAA2B,EAAE,MAAM,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3F,IAAI,OAAO,CAAC,KAAK;YAAE,OAAO,CAAC,aAAa,GAAG,UAAU,OAAO,CAAC,KAAK,EAAE,CAAC;QAErE,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,OAAO,GAAG,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QACnE,MAAM,OAAO,GAAY,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,IAAI,kBAAkB,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACzE,OAAO,OAAY,CAAC;IACtB,CAAC;IAED,OAAO;QACL,UAAU,CAA6C,IAAU;YAC/D,OAAO;gBACL,IAAI,CACF,KAAK,GAAiB,EAAE;oBAExB,OAAO,OAAO,CAAiB,gBAAgB,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAC3E,CAAC;gBAED,QAAQ,CACN,EAAU,EACV,KAAK,GAA2C,EAAE;oBAElD,OAAO,OAAO,CAAI,gBAAgB,IAAI,IAAI,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACpE,CAAC;aACF,CAAC;QACJ,CAAC;QAED,MAAM,CAA+B,IAAU;YAC7C,OAAO;gBACL,GAAG;oBACD,OAAO,OAAO,CAAI,YAAY,IAAI,EAAE,CAAC,CAAC;gBACxC,CAAC;aACF,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAmB;IAC1C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IAErC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;YACrB,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,CAAC,GAAG,CACjE,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC,UAAU,KAAK,GAAG,EAAE,SAAS,CAAU,CACjE,CAAC;YACF,MAAM,OAAO,GAAG,uBAAuB,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;YACpE,IAAI,OAAO;gBAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACjC,SAAS;QACX,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC/B,IAAI,IAAI;QAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3B,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACvD,CAAC"}
package/package.json CHANGED
@@ -1,7 +1,12 @@
1
1
  {
2
2
  "name": "@adonis-agora/cms-client",
3
- "version": "0.1.0",
3
+ "version": "0.2.1",
4
4
  "description": "Read-only content client for a @adonis-agora/cms server — token-bound tenant, filter wire format, no Adonis dependency.",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "git+https://github.com/DavideCarvalho/adonis-agora-cms.git",
8
+ "directory": "packages/client"
9
+ },
5
10
  "license": "MIT",
6
11
  "type": "module",
7
12
  "main": "./dist/index.js",
@@ -25,6 +30,9 @@
25
30
  "engines": {
26
31
  "node": ">=20.6.0"
27
32
  },
33
+ "dependencies": {
34
+ "@adonis-agora/filter-client": "^1.0.0-rc.1"
35
+ },
28
36
  "scripts": {
29
37
  "build": "tsc -p tsconfig.json",
30
38
  "test": "vitest run --passWithNoTests",