@strapi/types 5.36.1 → 5.37.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.
@@ -7,9 +7,22 @@ export interface RestProp {
7
7
  defaultLimit?: number;
8
8
  maxLimit?: number;
9
9
  withCount?: boolean;
10
+ /**
11
+ * When true, REST query params are validated: only known top-level keys (and params registered via
12
+ * contentAPI.addQueryParams) are allowed. Unrecognized keys result in 400.
13
+ */
14
+ strictParams?: boolean;
15
+ }
16
+ export interface DocumentsProp {
17
+ /**
18
+ * When true, Document Service methods reject params with unrecognized root-level keys (e.g. invalid
19
+ * status, locale). When false or unset, unknown params are ignored.
20
+ */
21
+ strictParams?: boolean;
10
22
  }
11
23
  export interface Api {
12
24
  responses?: ResponsesProp;
13
25
  rest?: RestProp;
26
+ documents?: DocumentsProp;
14
27
  }
15
28
  //# sourceMappingURL=api.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/core/config/api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,GAAG;IAClB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB"}
1
+ {"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/core/config/api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,GAAG;IAClB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,SAAS,CAAC,EAAE,aAAa,CAAC;CAC3B"}
@@ -82,6 +82,7 @@ export interface Strapi extends Container {
82
82
  apis: Record<string, Core.Module>;
83
83
  api(name: string): Core.Module;
84
84
  auth: Modules.Auth.AuthenticationService;
85
+ /** Content API: permissions, route map, sanitize/validate, and registration of extra query/input params (see addQueryParams, addInputParams). */
85
86
  contentAPI: Modules.ContentAPI.ContentApi;
86
87
  sanitizers: Modules.Sanitizers.SanitizersRegistry;
87
88
  validators: Modules.Validators.ValidatorsRegistry;
@@ -1 +1 @@
1
- {"version":3,"file":"strapi.d.ts","sourceRoot":"","sources":["../../src/core/strapi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,KAAK,KAAK,IAAI,MAAM,GAAG,CAAC;AAC/B,OAAO,KAAK,KAAK,OAAO,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,KAAK,MAAM,MAAM,WAAW,CAAC;AAEzC,OAAO,KAAK,KAAK,GAAG,MAAM,QAAQ,CAAC;AAEnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,WAAW,MAAO,SAAQ,SAAS;IACvC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,QAAQ,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACpC,aAAa,EAAE,aAAa,CAAC;IAC7B,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/B,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC;IACnC;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC,eAAe,CAAC,eAAe,CAAC;IACzD,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC;IACnD;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC;IACrC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC;IAC5C,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC;IACtD,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC;IAChD,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;IAC3B,IAAI,EAAE,iBAAiB,CAAC;IACxB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,EAAE,EAAE,QAAQ,CAAC;IACb,GAAG,EAAE,GAAG,CAAC;IACT,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,EAAE,CAAC,EAAE;QACH,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;IACF,EAAE,EAAE;QACF,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QACjC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QAChC,IAAI,EAAE,OAAO,CAAC;QACd,OAAO,EAAE,OAAO,CAAC;QACjB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QACxC,eAAe,EAAE,CAAC,EAChB,MAAM,GACP,EAAE;YACD,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;SACrB,KAAK,OAAO,CAAC;YAAE,WAAW,EAAE,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC,CAAC;QAC9C,QAAQ,EAAE;YACR,SAAS,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;YACxC,IAAI,EAAE,MAAM;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,EAAE,CAAC;YACnD,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,GAAG;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,GAAG,SAAS,CAAC;SACrF,CAAC;KACH,CAAC;IACF,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC3C,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;IAC9B,MAAM,EAAE,QAAQ,CAAC;IACjB,MAAM,EAAE,cAAc,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACvC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IACxC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7C,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IACjD,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC;IAClC,WAAW,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,EACjD,IAAI,EAAE,eAAe,GACpB,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACpD,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC;IACjD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAClC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAC/B,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC;IACzC,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAC1C,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAClD,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAClD,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,qBAAqB,CAAC;IAC7D,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACxB,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACzB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,oBAAoB,IAAI,IAAI,CAAC;IAC7B,SAAS,CAAC,EAAE,aAAa,EAAE,EAAE;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAC/D,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,aAAa,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC3D,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC/B,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5B,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7B,oBAAoB,CAAC,aAAa,EAAE,UAAU,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzF,iBAAiB,CAAC,aAAa,EAAE,UAAU,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtF,QAAQ,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,EACpC,GAAG,EAAE,UAAU,GACd,UAAU,SAAS,GAAG,CAAC,WAAW,GACjC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,GAC9B,UAAU,SAAS,GAAG,CAAC,SAAS,GAC9B,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,GAC5B,KAAK,CAAC;IACZ,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,IAAI,IAAI,CAAC;CACV;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,IAAI,IAAI,CAAC;IACjB,sBAAsB,IAAI,IAAI,CAAC;IAC/B,wBAAwB,IAAI,IAAI,CAAC;IACjC,iBAAiB,CAAC,EAAE,aAAa,EAAE,EAAE;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CACxE;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzF,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5D;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACvD,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;IACtC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE;QACN,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,GAAG,EAAE;QACH,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH"}
1
+ {"version":3,"file":"strapi.d.ts","sourceRoot":"","sources":["../../src/core/strapi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,KAAK,KAAK,IAAI,MAAM,GAAG,CAAC;AAC/B,OAAO,KAAK,KAAK,OAAO,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,KAAK,MAAM,MAAM,WAAW,CAAC;AAEzC,OAAO,KAAK,KAAK,GAAG,MAAM,QAAQ,CAAC;AAEnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,WAAW,MAAO,SAAQ,SAAS;IACvC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,QAAQ,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACpC,aAAa,EAAE,aAAa,CAAC;IAC7B,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/B,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC;IACnC;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC,eAAe,CAAC,eAAe,CAAC;IACzD,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC;IACnD;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC;IACrC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC;IAC5C,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC;IACtD,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC;IAChD,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;IAC3B,IAAI,EAAE,iBAAiB,CAAC;IACxB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,EAAE,EAAE,QAAQ,CAAC;IACb,GAAG,EAAE,GAAG,CAAC;IACT,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,EAAE,CAAC,EAAE;QACH,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;IACF,EAAE,EAAE;QACF,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QACjC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QAChC,IAAI,EAAE,OAAO,CAAC;QACd,OAAO,EAAE,OAAO,CAAC;QACjB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QACxC,eAAe,EAAE,CAAC,EAChB,MAAM,GACP,EAAE;YACD,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;SACrB,KAAK,OAAO,CAAC;YAAE,WAAW,EAAE,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC,CAAC;QAC9C,QAAQ,EAAE;YACR,SAAS,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;YACxC,IAAI,EAAE,MAAM;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,EAAE,CAAC;YACnD,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,GAAG;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,GAAG,SAAS,CAAC;SACrF,CAAC;KACH,CAAC;IACF,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC3C,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;IAC9B,MAAM,EAAE,QAAQ,CAAC;IACjB,MAAM,EAAE,cAAc,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACvC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IACxC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7C,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IACjD,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC;IAClC,WAAW,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,EACjD,IAAI,EAAE,eAAe,GACpB,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACpD,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC;IACjD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAClC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAC/B,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC;IACzC,iJAAiJ;IACjJ,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAC1C,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAClD,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAClD,cAAc,EAAE,OAAO,CAAC,cAAc,CAAC,qBAAqB,CAAC;IAC7D,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACxB,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACzB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,oBAAoB,IAAI,IAAI,CAAC;IAC7B,SAAS,CAAC,EAAE,aAAa,EAAE,EAAE;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAC/D,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,aAAa,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC3D,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC/B,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5B,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7B,oBAAoB,CAAC,aAAa,EAAE,UAAU,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzF,iBAAiB,CAAC,aAAa,EAAE,UAAU,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtF,QAAQ,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,EACpC,GAAG,EAAE,UAAU,GACd,UAAU,SAAS,GAAG,CAAC,WAAW,GACjC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,GAC9B,UAAU,SAAS,GAAG,CAAC,SAAS,GAC9B,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,GAC5B,KAAK,CAAC;IACZ,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,IAAI,IAAI,CAAC;CACV;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,IAAI,IAAI,CAAC;IACjB,sBAAsB,IAAI,IAAI,CAAC;IAC/B,wBAAwB,IAAI,IAAI,CAAC;IACjC,iBAAiB,CAAC,EAAE,aAAa,EAAE,EAAE;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CACxE;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzF,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5D;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACvD,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;IACtC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE;QACN,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,GAAG,EAAE;QACH,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH"}
@@ -1,6 +1,34 @@
1
1
  import permissions from '@strapi/permissions';
2
2
  import { providerFactory, sanitize, validate } from '@strapi/utils';
3
+ import type { z } from 'zod/v4';
3
4
  import type { Route } from '../core';
5
+ /** Base Zod scalar types allowed for query params (no nested objects). */
6
+ type ZodScalarSchema = z.ZodString | z.ZodNumber | z.ZodBoolean | z.ZodEnum<Record<string, string>>;
7
+ /**
8
+ * Allowed Zod schema types for addQueryParams: scalars (string, number, boolean, enum) or arrays of scalars.
9
+ * Optional and default wrappers are allowed. Nested objects are not allowed for query params.
10
+ */
11
+ export type ZodQueryParamSchema = ZodScalarSchema | z.ZodOptional<ZodScalarSchema | z.ZodArray<ZodScalarSchema>> | z.ZodDefault<ZodScalarSchema | z.ZodArray<ZodScalarSchema>> | z.ZodArray<ZodScalarSchema>;
12
+ /** Zod namespace type (e.g. from `import * as z from 'zod/v4'`) passed to schema factory. */
13
+ export type ZodSchemaFactory = typeof z;
14
+ /** Schema + optional matchRoute for one query param. Keys in addQueryParams are the param names. */
15
+ export type QueryParamEntry = {
16
+ /** Zod schema or factory. Must be scalar or array of scalars (no nested objects). */
17
+ schema: ZodQueryParamSchema | ((z: ZodSchemaFactory) => ZodQueryParamSchema);
18
+ /** If provided, the param is only merged into routes for which this returns true. */
19
+ matchRoute?: (route: Route) => boolean;
20
+ };
21
+ /** Schema + optional matchRoute for one input param (root-level body.data). Keys in addInputParams are the param names. */
22
+ export type InputParamEntry = {
23
+ /** Zod schema or factory. Any Zod type allowed (scalars, objects, arrays). */
24
+ schema: z.ZodType | ((z: ZodSchemaFactory) => z.ZodType);
25
+ /** If provided, the param is only merged into routes for which this returns true. */
26
+ matchRoute?: (route: Route) => boolean;
27
+ };
28
+ /** Options for addQueryParams: keys are param names, values are schema + optional matchRoute. */
29
+ export type AddQueryParamsOptions = Record<string, QueryParamEntry>;
30
+ /** Options for addInputParams: keys are param names, values are schema + optional matchRoute. */
31
+ export type AddInputParamsOptions = Record<string, InputParamEntry>;
4
32
  export interface Condition {
5
33
  name: string;
6
34
  [key: string]: unknown;
@@ -23,10 +51,42 @@ export interface PermissionUtilities {
23
51
  }>;
24
52
  }
25
53
  export interface ContentApi {
54
+ /** Permissions engine and action/condition providers for the content API. */
26
55
  permissions: PermissionUtilities;
56
+ /** Returns a map of scope → {@link Route}[] for all content-api routes. */
27
57
  getRoutesMap: () => Promise<Record<string, Route[]>>;
58
+ /** Sanitizers for content-api input. */
28
59
  sanitize: sanitize.APISanitiers;
60
+ /** Validators for content-api input. */
29
61
  validate: validate.APIValidators;
62
+ /**
63
+ * Register extra query params to be merged into content-api route schemas.
64
+ * Query params accept only Zod scalar or array-of-scalar schemas (no nested objects); enforced at runtime. Use {@link ContentApi.addInputParams} for nested structures.
65
+ * Use `z` from `@strapi/utils` or `zod/v4` for compatibility.
66
+ *
67
+ * @param options - {@link AddQueryParamsOptions}: record of param name → {@link QueryParamEntry}. Each entry has:
68
+ * @param options.[paramName] - {@link QueryParamEntry} (key is the param name, e.g. `"search"`).
69
+ * @param options.[paramName].schema - {@link ZodQueryParamSchema} or `(z: {@link ZodSchemaFactory}) => {@link ZodQueryParamSchema}`. Must be scalar or array of scalars. No nested objects.
70
+ * @param options.[paramName].matchRoute - Optional. `(route: {@link Route}) => boolean`; if provided, this param is only added to routes for which it returns true.
71
+ */
72
+ addQueryParams: (options: AddQueryParamsOptions) => void;
73
+ /**
74
+ * Register extra input params (root-level body.data) to be merged into content-api route schemas.
75
+ * Any Zod type is allowed (scalars, objects, arrays). Enforced at runtime.
76
+ *
77
+ * @param options - {@link AddInputParamsOptions}: record of param name → {@link InputParamEntry}. Each entry has:
78
+ * @param options.[paramName] - {@link InputParamEntry} (key is the root-level key in body.data, e.g. `"metadata"`).
79
+ * @param options.[paramName].schema - `z.ZodType` or `(z: {@link ZodSchemaFactory}) => z.ZodType`. Any Zod type (e.g. z.object(), z.array(), scalars).
80
+ * @param options.[paramName].matchRoute - Optional. `(route: {@link Route}) => boolean`; if provided, this param is only added to routes for which it returns true.
81
+ */
82
+ addInputParams: (options: AddInputParamsOptions) => void;
83
+ /**
84
+ * Merge all registered extra params into the given routes (mutates in place). Used at route registration.
85
+ *
86
+ * @internal Used by the framework during route registration. Not intended for app or plugin code.
87
+ * @param routes - Array of {@link Route} objects to mutate with registered query/input params.
88
+ */
89
+ applyExtraParamsToRoutes: (routes: Route[]) => void;
30
90
  }
31
91
  export {};
32
92
  //# sourceMappingURL=content-api.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"content-api.d.ts","sourceRoot":"","sources":["../../src/modules/content-api.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEpE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,KAAK,iBAAiB,GAAG;IACvB,QAAQ,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACnD,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAEvC,KAAK,cAAc,GAAG;IACpB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/E,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAEvC,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAClD,SAAS,EAAE;QACT,MAAM,EAAE,cAAc,CAAC;QACvB,SAAS,EAAE,iBAAiB,CAAC;KAC9B,CAAC;IACF,eAAe,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,aAAa,EAAE,MAAM,MAAM,CACzB,MAAM,EACN;QACE,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;KACvC,CACF,CAAC;CACH;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,mBAAmB,CAAC;IACjC,YAAY,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACrD,QAAQ,EAAE,QAAQ,CAAC,YAAY,CAAC;IAChC,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAAC;CAClC"}
1
+ {"version":3,"file":"content-api.d.ts","sourceRoot":"","sources":["../../src/modules/content-api.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,0EAA0E;AAC1E,KAAK,eAAe,GAAG,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAEpG;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC3B,eAAe,GACf,CAAC,CAAC,WAAW,CAAC,eAAe,GAAG,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,GAC5D,CAAC,CAAC,UAAU,CAAC,eAAe,GAAG,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,GAC3D,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;AAEhC,6FAA6F;AAC7F,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,CAAC;AAExC,oGAAoG;AACpG,MAAM,MAAM,eAAe,GAAG;IAC5B,qFAAqF;IACrF,MAAM,EAAE,mBAAmB,GAAG,CAAC,CAAC,CAAC,EAAE,gBAAgB,KAAK,mBAAmB,CAAC,CAAC;IAC7E,qFAAqF;IACrF,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC;CACxC,CAAC;AAEF,2HAA2H;AAC3H,MAAM,MAAM,eAAe,GAAG;IAC5B,8EAA8E;IAC9E,MAAM,EAAE,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,gBAAgB,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;IACzD,qFAAqF;IACrF,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC;CACxC,CAAC;AAEF,iGAAiG;AACjG,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAEpE,iGAAiG;AACjG,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAEpE,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,KAAK,iBAAiB,GAAG;IACvB,QAAQ,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACnD,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAEvC,KAAK,cAAc,GAAG;IACpB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/E,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAEvC,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAClD,SAAS,EAAE;QACT,MAAM,EAAE,cAAc,CAAC;QACvB,SAAS,EAAE,iBAAiB,CAAC;KAC9B,CAAC;IACF,eAAe,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,aAAa,EAAE,MAAM,MAAM,CACzB,MAAM,EACN;QACE,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;KACvC,CACF,CAAC;CACH;AAED,MAAM,WAAW,UAAU;IACzB,6EAA6E;IAC7E,WAAW,EAAE,mBAAmB,CAAC;IACjC,2EAA2E;IAC3E,YAAY,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACrD,wCAAwC;IACxC,QAAQ,EAAE,QAAQ,CAAC,YAAY,CAAC;IAChC,wCAAwC;IACxC,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAAC;IACjC;;;;;;;;;OASG;IACH,cAAc,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,IAAI,CAAC;IACzD;;;;;;;;OAQG;IACH,cAAc,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,IAAI,CAAC;IACzD;;;;;OAKG;IACH,wBAAwB,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,IAAI,CAAC;CACrD"}
@@ -1,5 +1,6 @@
1
1
  export type Kind = 'draft' | 'published';
2
2
  export type Param = {
3
3
  status?: Kind;
4
+ hasPublishedVersion?: boolean;
4
5
  };
5
6
  //# sourceMappingURL=status.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../../../src/modules/documents/params/status.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,IAAI,GAAG,OAAO,GAAG,WAAW,CAAC;AAEzC,MAAM,MAAM,KAAK,GAAG;IAAE,MAAM,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC"}
1
+ {"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../../../src/modules/documents/params/status.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,IAAI,GAAG,OAAO,GAAG,WAAW,CAAC;AAEzC,MAAM,MAAM,KAAK,GAAG;IAAE,MAAM,CAAC,EAAE,IAAI,CAAC;IAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@strapi/types",
3
- "version": "5.36.1",
3
+ "version": "5.37.0",
4
4
  "description": "Shared typescript types for Strapi internal use",
5
5
  "keywords": [
6
6
  "strapi"
@@ -46,10 +46,10 @@
46
46
  "@casl/ability": "6.7.5",
47
47
  "@koa/cors": "5.0.0",
48
48
  "@koa/router": "12.0.2",
49
- "@strapi/database": "5.36.1",
50
- "@strapi/logger": "5.36.1",
51
- "@strapi/permissions": "5.36.1",
52
- "@strapi/utils": "5.36.1",
49
+ "@strapi/database": "5.37.0",
50
+ "@strapi/logger": "5.37.0",
51
+ "@strapi/permissions": "5.37.0",
52
+ "@strapi/utils": "5.37.0",
53
53
  "commander": "8.3.0",
54
54
  "json-logic-js": "2.0.5",
55
55
  "koa": "2.16.3",
@@ -67,9 +67,9 @@
67
67
  "@types/koa": "2.13.4",
68
68
  "@types/koa__router": "12.0.0",
69
69
  "@types/node-schedule": "2.1.7",
70
- "eslint-config-custom": "5.36.1",
71
- "lodash": "4.17.21",
72
- "tsconfig": "5.36.1",
70
+ "eslint-config-custom": "5.37.0",
71
+ "lodash": "4.17.23",
72
+ "tsconfig": "5.37.0",
73
73
  "typescript": "5.4.4",
74
74
  "undici": "6.23.0"
75
75
  },