@dani-builder/strapi-client 0.16.0 → 1.0.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/AGENTS.md +42 -32
- package/README.md +7 -2
- package/dist/api/form.d.ts +8 -0
- package/dist/api/form.d.ts.map +1 -0
- package/dist/api/form.js +83 -0
- package/dist/api/form.js.map +1 -0
- package/dist/api/index.d.ts +3 -1
- package/dist/api/index.d.ts.map +1 -1
- package/dist/api/index.js +2 -1
- package/dist/api/index.js.map +1 -1
- package/dist/api/legal-documents.d.ts +19 -0
- package/dist/api/legal-documents.d.ts.map +1 -0
- package/dist/api/legal-documents.js +29 -0
- package/dist/api/legal-documents.js.map +1 -0
- package/dist/api/pages.d.ts +1 -1
- package/dist/api/pages.js +1 -1
- package/dist/index.d.ts +3 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/types/components/blocks.d.ts +12 -10
- package/dist/types/components/blocks.d.ts.map +1 -1
- package/dist/types/components/blocks.js +1 -0
- package/dist/types/components/blocks.js.map +1 -1
- package/dist/types/components/shared.d.ts +1 -2
- package/dist/types/components/shared.d.ts.map +1 -1
- package/dist/types/components/shared.js +1 -1
- package/dist/types/content-types/form.d.ts +66 -0
- package/dist/types/content-types/form.d.ts.map +1 -0
- package/dist/types/content-types/form.js +2 -0
- package/dist/types/content-types/form.js.map +1 -0
- package/dist/types/content-types/index.d.ts +3 -1
- package/dist/types/content-types/index.d.ts.map +1 -1
- package/dist/types/content-types/inquiry.d.ts +0 -16
- package/dist/types/content-types/inquiry.d.ts.map +1 -1
- package/dist/types/content-types/legal-document.d.ts +12 -0
- package/dist/types/content-types/legal-document.d.ts.map +1 -0
- package/dist/types/content-types/legal-document.js +4 -0
- package/dist/types/content-types/legal-document.js.map +1 -0
- package/dist/types/content-types/page.d.ts +4 -1
- package/dist/types/content-types/page.d.ts.map +1 -1
- package/dist/types/index.d.ts +1 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/strapi.d.ts +4 -0
- package/dist/types/strapi.d.ts.map +1 -1
- package/docs/api-guide.md +78 -43
- package/docs/block-reference.md +2 -1
- package/docs/content-types.md +45 -2
- package/package.json +4 -4
- package/dist/api/inquiry.d.ts +0 -7
- package/dist/api/inquiry.d.ts.map +0 -1
- package/dist/api/inquiry.js +0 -9
- package/dist/api/inquiry.js.map +0 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../../src/types/components/shared.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAMjE,MAAM,WAAW,IAAK,SAAQ,eAAe,CAAC,aAAa,CAAC;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAMD,MAAM,WAAW,eAAgB,SAAQ,eAAe,CAAC,yBAAyB,CAAC;IACjF,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAMD;;;;;GAKG;AACH,MAAM,WAAW,KAAM,SAAQ,eAAe,CAAC,cAAc,CAAC;IAC5D,KAAK,EAAE,WAAW,CAAC;IACnB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CACnC;AAMD,MAAM,WAAW,GAAI,SAAQ,eAAe,CAAC,YAAY,CAAC;IACxD,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC;CAC5E;AAMD,MAAM,WAAW,WAAY,SAAQ,eAAe,CAAC,qBAAqB,CAAC;IACzE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,0BAA0B;IAC1B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,6CAA6C;IAC7C,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB;AAMD,MAAM,WAAW,aAAc,SAAQ,eAAe,CAAC,uBAAuB,CAAC;IAC7E,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,0BAA0B;IAC1B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,EAAE,KAAK,CAAC;IACb,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB;AAMD,MAAM,WAAW,UAAW,SAAQ,eAAe,CAAC,oBAAoB,CAAC;IACvE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd;AAMD,MAAM,WAAW,SAAU,SAAQ,eAAe,CAAC,mBAAmB,CAAC;IACrE,kFAAkF;IAClF,IAAI,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,IAAI,CAAC;IACrC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB;AAMD,MAAM,WAAW,eAAgB,SAAQ,eAAe,CAAC,yBAAyB,CAAC;IACjF,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAMD,MAAM,WAAW,QAAS,SAAQ,eAAe,CAAC,kBAAkB,CAAC;IACnE,IAAI,EAAE,WAAW,CAAC;IAClB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB;AAMD,MAAM,WAAW,QAAS,SAAQ,eAAe,CAAC,kBAAkB,CAAC;IACnE,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAMD,MAAM,WAAW,WAAY,SAAQ,eAAe,CAAC,qBAAqB,CAAC;IACzE,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,0BAA0B;IAC1B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,EAAE,IAAI,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;CACtB;AAMD,MAAM,WAAW,UAAW,SAAQ,eAAe,CAAC,oBAAoB,CAAC;IACvE,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,KAAK,EAAE,WAAW,GAAG,IAAI,CAAC;IAC1B,WAAW,EAAE,IAAI,EAAE,CAAC;CACrB;AAMD,MAAM,WAAW,WAAY,SAAQ,eAAe,CAAC,qBAAqB,CAAC;IACzE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAMD,MAAM,WAAW,gBAAiB,SAAQ,eAAe,CAAC,0BAA0B,CAAC;IACnF,QAAQ,EAAE,oBAAoB,GAAG,kBAAkB,GAAG,QAAQ,CAAC;IAC/D,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;CAClB;AAMD,MAAM,WAAW,cAAe,SAAQ,eAAe,CAAC,wBAAwB,CAAC;IAC/E,QAAQ,EAAE,cAAc,GAAG,SAAS,GAAG,UAAU,CAAC;IAClD,KAAK,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../../src/types/components/shared.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAMjE,MAAM,WAAW,IAAK,SAAQ,eAAe,CAAC,aAAa,CAAC;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAMD,MAAM,WAAW,eAAgB,SAAQ,eAAe,CAAC,yBAAyB,CAAC;IACjF,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAMD;;;;;GAKG;AACH,MAAM,WAAW,KAAM,SAAQ,eAAe,CAAC,cAAc,CAAC;IAC5D,KAAK,EAAE,WAAW,CAAC;IACnB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CACnC;AAMD,MAAM,WAAW,GAAI,SAAQ,eAAe,CAAC,YAAY,CAAC;IACxD,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC;CAC5E;AAMD,MAAM,WAAW,WAAY,SAAQ,eAAe,CAAC,qBAAqB,CAAC;IACzE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,0BAA0B;IAC1B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,6CAA6C;IAC7C,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB;AAMD,MAAM,WAAW,aAAc,SAAQ,eAAe,CAAC,uBAAuB,CAAC;IAC7E,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,0BAA0B;IAC1B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,EAAE,KAAK,CAAC;IACb,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB;AAMD,MAAM,WAAW,UAAW,SAAQ,eAAe,CAAC,oBAAoB,CAAC;IACvE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd;AAMD,MAAM,WAAW,SAAU,SAAQ,eAAe,CAAC,mBAAmB,CAAC;IACrE,kFAAkF;IAClF,IAAI,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,IAAI,CAAC;IACrC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB;AAMD,MAAM,WAAW,eAAgB,SAAQ,eAAe,CAAC,yBAAyB,CAAC;IACjF,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAMD,MAAM,WAAW,QAAS,SAAQ,eAAe,CAAC,kBAAkB,CAAC;IACnE,IAAI,EAAE,WAAW,CAAC;IAClB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB;AAMD,MAAM,WAAW,QAAS,SAAQ,eAAe,CAAC,kBAAkB,CAAC;IACnE,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAMD,MAAM,WAAW,WAAY,SAAQ,eAAe,CAAC,qBAAqB,CAAC;IACzE,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,0BAA0B;IAC1B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,EAAE,IAAI,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;CACtB;AAMD,MAAM,WAAW,UAAW,SAAQ,eAAe,CAAC,oBAAoB,CAAC;IACvE,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,KAAK,EAAE,WAAW,GAAG,IAAI,CAAC;IAC1B,WAAW,EAAE,IAAI,EAAE,CAAC;CACrB;AAMD,MAAM,WAAW,WAAY,SAAQ,eAAe,CAAC,qBAAqB,CAAC;IACzE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAMD,MAAM,WAAW,gBAAiB,SAAQ,eAAe,CAAC,0BAA0B,CAAC;IACnF,QAAQ,EAAE,oBAAoB,GAAG,kBAAkB,GAAG,QAAQ,CAAC;IAC/D,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;CAClB;AAMD,uEAAuE;AACvE,MAAM,WAAW,cAAe,SAAQ,eAAe,CAAC,wBAAwB,CAAC;IAC/E,QAAQ,EAAE,cAAc,GAAG,SAAS,GAAG,UAAU,CAAC;IAClD,KAAK,EAAE,MAAM,CAAC;CACf;AAMD,MAAM,WAAW,gBAAiB,SAAQ,eAAe,CAAC,0BAA0B,CAAC;IACnF,OAAO,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IAChD,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB;AAMD,8EAA8E;AAC9E,MAAM,WAAW,YAAa,SAAQ,eAAe,CAAC,qBAAqB,CAAC;IAC1E,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,IAAI,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,uDAAuD;IACvD,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,OAAO,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;CAChC;AAMD,MAAM,WAAW,aAAc,SAAQ,eAAe,CAAC,uBAAuB,CAAC;IAC7E,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B"}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/** The public form response; target and notification configuration stay server-side. */
|
|
2
|
+
export interface FormDefinition {
|
|
3
|
+
fields: FormField[];
|
|
4
|
+
consent: {
|
|
5
|
+
label: string;
|
|
6
|
+
version: string;
|
|
7
|
+
};
|
|
8
|
+
version: number;
|
|
9
|
+
}
|
|
10
|
+
export interface FormField {
|
|
11
|
+
name: string;
|
|
12
|
+
type: 'string' | 'text' | 'email' | 'integer' | 'decimal' | 'boolean' | 'enumeration' | 'date' | 'datetime';
|
|
13
|
+
label: string;
|
|
14
|
+
required: boolean;
|
|
15
|
+
visibility: 'form' | 'hidden';
|
|
16
|
+
placeholder?: string;
|
|
17
|
+
help?: string;
|
|
18
|
+
options?: {
|
|
19
|
+
value: string;
|
|
20
|
+
label: string;
|
|
21
|
+
}[];
|
|
22
|
+
maxLength?: number;
|
|
23
|
+
min?: number;
|
|
24
|
+
max?: number;
|
|
25
|
+
}
|
|
26
|
+
export interface SubmissionInput {
|
|
27
|
+
fields: Record<string, string | number | boolean>;
|
|
28
|
+
consent: true;
|
|
29
|
+
idempotencyKey: string;
|
|
30
|
+
formVersion: number;
|
|
31
|
+
}
|
|
32
|
+
export interface SubmissionReceipt {
|
|
33
|
+
id: string;
|
|
34
|
+
receivedAt: string;
|
|
35
|
+
}
|
|
36
|
+
export interface SubmissionFieldError {
|
|
37
|
+
field: string;
|
|
38
|
+
code: string;
|
|
39
|
+
}
|
|
40
|
+
interface SubmissionErrorBase extends Error {
|
|
41
|
+
code: string;
|
|
42
|
+
cause: unknown;
|
|
43
|
+
}
|
|
44
|
+
/** Narrow with isSubmissionError(error), then switch on kind. */
|
|
45
|
+
export type SubmissionError = SubmissionErrorBase & ({
|
|
46
|
+
kind: 'validation';
|
|
47
|
+
status: 400;
|
|
48
|
+
fieldErrors: SubmissionFieldError[];
|
|
49
|
+
} | {
|
|
50
|
+
kind: 'form_outdated';
|
|
51
|
+
status: 409;
|
|
52
|
+
code: 'form_outdated';
|
|
53
|
+
} | {
|
|
54
|
+
kind: 'rate_limited';
|
|
55
|
+
status: 429;
|
|
56
|
+
code: 'rate_limited';
|
|
57
|
+
} | {
|
|
58
|
+
kind: 'rejected';
|
|
59
|
+
status: number;
|
|
60
|
+
} | {
|
|
61
|
+
kind: 'transport';
|
|
62
|
+
status: undefined;
|
|
63
|
+
code: 'transport_error';
|
|
64
|
+
});
|
|
65
|
+
export {};
|
|
66
|
+
//# sourceMappingURL=form.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../../src/types/content-types/form.ts"],"names":[],"mappings":"AAAA,wFAAwF;AACxF,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5C,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EACA,QAAQ,GACR,MAAM,GACN,OAAO,GACP,SAAS,GACT,SAAS,GACT,SAAS,GACT,aAAa,GACb,MAAM,GACN,UAAU,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IAClD,OAAO,EAAE,IAAI,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,UAAU,mBAAoB,SAAQ,KAAK;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,iEAAiE;AACjE,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAC/C,CACI;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,MAAM,EAAE,GAAG,CAAC;IAAC,WAAW,EAAE,oBAAoB,EAAE,CAAA;CAAE,GACxE;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,GAC7D;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,cAAc,CAAA;CAAE,GAC3D;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACpC;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,MAAM,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,iBAAiB,CAAA;CAAE,CACpE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"form.js","sourceRoot":"","sources":["../../../src/types/content-types/form.ts"],"names":[],"mappings":""}
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
export type { Page, PageDocument, PageBlocks } from './page.js';
|
|
2
|
+
export type { LegalDocument, LegalDocumentDocument } from './legal-document.js';
|
|
2
3
|
export type { Article, ArticleDocument } from './article.js';
|
|
3
4
|
export type { Faq, FaqDocument } from './faq.js';
|
|
4
|
-
export type { Inquiry, InquiryDocument
|
|
5
|
+
export type { Inquiry, InquiryDocument } from './inquiry.js';
|
|
5
6
|
export type { Category, CategoryDocument } from './category.js';
|
|
6
7
|
export type { Tag, TagDocument } from './tag.js';
|
|
7
8
|
export type { Author, AuthorDocument } from './author.js';
|
|
@@ -9,4 +10,5 @@ export type { Series, SeriesDocument } from './series.js';
|
|
|
9
10
|
export type { Navigation, NavigationDocument } from './navigation.js';
|
|
10
11
|
export type { Global, GlobalDocument, SiteWideBlocks } from './global.js';
|
|
11
12
|
export type { SiteSettings, SiteSettingsDocument } from './site-settings.js';
|
|
13
|
+
export type { FormDefinition, FormField, SubmissionInput, SubmissionReceipt, SubmissionFieldError, SubmissionError, } from './form.js';
|
|
12
14
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/content-types/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAChE,YAAY,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC7D,YAAY,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACjD,YAAY,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/content-types/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAChE,YAAY,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAChF,YAAY,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC7D,YAAY,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACjD,YAAY,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC7D,YAAY,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAChE,YAAY,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACjD,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC1D,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC1D,YAAY,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACtE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC1E,YAAY,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE7E,YAAY,EACV,cAAc,EACd,SAAS,EACT,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,GAChB,MAAM,WAAW,CAAC"}
|
|
@@ -12,20 +12,4 @@ export interface Inquiry {
|
|
|
12
12
|
processingStatus: 'received' | 'reviewing' | 'responded' | 'closed' | null;
|
|
13
13
|
}
|
|
14
14
|
export type InquiryDocument = StrapiDocument & Inquiry;
|
|
15
|
-
/** POST body for creating an inquiry via API */
|
|
16
|
-
export interface InquiryFormData {
|
|
17
|
-
name: string;
|
|
18
|
-
consent: true;
|
|
19
|
-
consentVersion: string;
|
|
20
|
-
/** Stable per submission intent; omit only for integrations without retries. */
|
|
21
|
-
idempotencyKey?: string;
|
|
22
|
-
email?: string;
|
|
23
|
-
phone?: string;
|
|
24
|
-
subject?: string;
|
|
25
|
-
message?: string;
|
|
26
|
-
}
|
|
27
|
-
/** Public receipt contains no submission data or document identifiers. */
|
|
28
|
-
export interface InquiryReceipt {
|
|
29
|
-
accepted: true;
|
|
30
|
-
}
|
|
31
15
|
//# sourceMappingURL=inquiry.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"inquiry.d.ts","sourceRoot":"","sources":["../../../src/types/content-types/inquiry.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAEnD,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,8EAA8E;IAC9E,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,gBAAgB,EAAE,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,GAAG,IAAI,CAAC;CAC5E;AAED,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG,OAAO,CAAC
|
|
1
|
+
{"version":3,"file":"inquiry.d.ts","sourceRoot":"","sources":["../../../src/types/content-types/inquiry.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAEnD,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,8EAA8E;IAC9E,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,gBAAgB,EAAE,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,GAAG,IAAI,CAAC;CAC5E;AAED,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG,OAAO,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { StrapiI18nDocument, BlocksContent, LocalizationRef } from '../strapi.js';
|
|
2
|
+
export interface LegalDocument {
|
|
3
|
+
title: string;
|
|
4
|
+
slug: string;
|
|
5
|
+
summary: string | null;
|
|
6
|
+
body: BlocksContent;
|
|
7
|
+
effectiveDate: string | null;
|
|
8
|
+
/** Sibling-locale refs — only present when `localizations` is populated. */
|
|
9
|
+
localizations?: LocalizationRef[];
|
|
10
|
+
}
|
|
11
|
+
export type LegalDocumentDocument = StrapiI18nDocument & LegalDocument;
|
|
12
|
+
//# sourceMappingURL=legal-document.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"legal-document.d.ts","sourceRoot":"","sources":["../../../src/types/content-types/legal-document.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,kBAAkB,EAClB,aAAa,EACb,eAAe,EAChB,MAAM,cAAc,CAAC;AAEtB,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,EAAE,aAAa,CAAC;IACpB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,4EAA4E;IAC5E,aAAa,CAAC,EAAE,eAAe,EAAE,CAAC;CACnC;AAED,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,GAAG,aAAa,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"legal-document.js","sourceRoot":"","sources":["../../../src/types/content-types/legal-document.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,6FAA6F"}
|
|
@@ -18,7 +18,10 @@ export interface Page {
|
|
|
18
18
|
seo: Seo | null;
|
|
19
19
|
blocks: PageBlocks[];
|
|
20
20
|
headerMode: 'overlay' | 'offset';
|
|
21
|
-
/**
|
|
21
|
+
/**
|
|
22
|
+
* Sibling locale/slug refs, always included by Smart getPage, getPageBySlug,
|
|
23
|
+
* listPages, and listPagesRest; standard REST includes them only when populated.
|
|
24
|
+
*/
|
|
22
25
|
localizations?: LocalizationRef[];
|
|
23
26
|
}
|
|
24
27
|
export type PageDocument = StrapiI18nDocument & Page;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"page.d.ts","sourceRoot":"","sources":["../../../src/types/content-types/page.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACxE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,KAAK,EACV,SAAS,EACT,aAAa,EACb,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,QAAQ,EACR,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,SAAS,EACV,MAAM,yBAAyB,CAAC;AAEjC,KAAK,iBAAiB,GAClB,OAAO,GACP,SAAS,GACT,aAAa,GACb,QAAQ,GACR,WAAW,GACX,gBAAgB,GAChB,QAAQ,GACR,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,cAAc,GACd,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,SAAS,CAAC;AAEd,gFAAgF;AAChF,MAAM,MAAM,UAAU,CACpB,WAAW,SAAS;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAAG,KAAK,IAE7D,OAAO,CAAC,iBAAiB,EAAE;IAAE,WAAW,EAAE,WAAW,CAAC,aAAa,CAAC,CAAA;CAAE,CAAC,GACvE,WAAW,CAAC;AAEhB,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,8EAA8E;IAC9E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC;IAChB,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,UAAU,EAAE,SAAS,GAAG,QAAQ,CAAC;IACjC
|
|
1
|
+
{"version":3,"file":"page.d.ts","sourceRoot":"","sources":["../../../src/types/content-types/page.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACxE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,KAAK,EACV,SAAS,EACT,aAAa,EACb,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,QAAQ,EACR,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,SAAS,EACV,MAAM,yBAAyB,CAAC;AAEjC,KAAK,iBAAiB,GAClB,OAAO,GACP,SAAS,GACT,aAAa,GACb,QAAQ,GACR,WAAW,GACX,gBAAgB,GAChB,QAAQ,GACR,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,cAAc,GACd,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,SAAS,CAAC;AAEd,gFAAgF;AAChF,MAAM,MAAM,UAAU,CACpB,WAAW,SAAS;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAAG,KAAK,IAE7D,OAAO,CAAC,iBAAiB,EAAE;IAAE,WAAW,EAAE,WAAW,CAAC,aAAa,CAAC,CAAA;CAAE,CAAC,GACvE,WAAW,CAAC;AAEhB,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,8EAA8E;IAC9E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC;IAChB,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,UAAU,EAAE,SAAS,GAAG,QAAQ,CAAC;IACjC;;;OAGG;IACH,aAAa,CAAC,EAAE,eAAe,EAAE,CAAC;CACnC;AAED,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,IAAI,CAAC"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export type { StrapiDocument, StrapiI18nDocument, LocalizationRef, StrapiComponent, StrapiResponse, StrapiCollectionResponse, StrapiPagination, StrapiError, StrapiMedia, StrapiMediaFormat, BlocksContent, BlockNode, BlockParagraph, BlockHeading, BlockList, BlockListItem, BlockQuote, BlockCode, BlockImage, BlockInlineNode, BlockTextChild, BlockLinkChild, } from './strapi.js';
|
|
2
2
|
export type { Link, NavigationGroup, Image, Seo, Organization, PostalAddress, FeatureItem, HighlightItem, SliderItem, BentoItem, TestimonialItem, LogoItem, StatItem, PricingTier, TeamMember, AnalyticsSetting, ChatbotSetting, SiteVerification, BrandColors, Section, Footer, HeroBlock, FeaturesBlock, CtaBlock, SliderBlock, InquiryFormBlock, FaqBlock, HighlightsBlock, BentoGridBlock, TestimonialsBlock, LogoCloudBlock, StatsBlock, PricingBlock, ContentBlock, TeamBlock, } from './components/index.js';
|
|
3
|
-
export type { Page, PageDocument, PageBlocks, Article, ArticleDocument, Faq, FaqDocument, Inquiry, InquiryDocument,
|
|
3
|
+
export type { Page, PageDocument, PageBlocks, LegalDocument, LegalDocumentDocument, Article, ArticleDocument, Faq, FaqDocument, Inquiry, InquiryDocument, FormDefinition, FormField, SubmissionInput, SubmissionReceipt, SubmissionFieldError, SubmissionError, Category, CategoryDocument, Tag, TagDocument, Author, AuthorDocument, Series, SeriesDocument, Navigation, NavigationDocument, Global, GlobalDocument, SiteWideBlocks, SiteSettings, SiteSettingsDocument, } from './content-types/index.js';
|
|
4
4
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,gBAAgB,EAChB,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,aAAa,EACb,SAAS,EACT,cAAc,EACd,YAAY,EACZ,SAAS,EACT,aAAa,EACb,UAAU,EACV,SAAS,EACT,UAAU,EACV,eAAe,EACf,cAAc,EACd,cAAc,GACf,MAAM,aAAa,CAAC;AAErB,YAAY,EACV,IAAI,EACJ,eAAe,EACf,KAAK,EACL,GAAG,EACH,YAAY,EACZ,aAAa,EACb,WAAW,EACX,aAAa,EACb,UAAU,EACV,SAAS,EACT,eAAe,EACf,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,OAAO,EACP,MAAM,EACN,SAAS,EACT,aAAa,EACb,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,QAAQ,EACR,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,SAAS,GACV,MAAM,uBAAuB,CAAC;AAE/B,YAAY,EACV,IAAI,EACJ,YAAY,EACZ,UAAU,EACV,OAAO,EACP,eAAe,EACf,GAAG,EACH,WAAW,EACX,OAAO,EACP,eAAe,EACf,eAAe,EACf,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,gBAAgB,EAChB,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,aAAa,EACb,SAAS,EACT,cAAc,EACd,YAAY,EACZ,SAAS,EACT,aAAa,EACb,UAAU,EACV,SAAS,EACT,UAAU,EACV,eAAe,EACf,cAAc,EACd,cAAc,GACf,MAAM,aAAa,CAAC;AAErB,YAAY,EACV,IAAI,EACJ,eAAe,EACf,KAAK,EACL,GAAG,EACH,YAAY,EACZ,aAAa,EACb,WAAW,EACX,aAAa,EACb,UAAU,EACV,SAAS,EACT,eAAe,EACf,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,OAAO,EACP,MAAM,EACN,SAAS,EACT,aAAa,EACb,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,QAAQ,EACR,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,SAAS,GACV,MAAM,uBAAuB,CAAC;AAE/B,YAAY,EACV,IAAI,EACJ,YAAY,EACZ,UAAU,EACV,aAAa,EACb,qBAAqB,EACrB,OAAO,EACP,eAAe,EACf,GAAG,EACH,WAAW,EACX,OAAO,EACP,eAAe,EACf,cAAc,EACd,SAAS,EACT,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,EACf,QAAQ,EACR,gBAAgB,EAChB,GAAG,EACH,WAAW,EACX,MAAM,EACN,cAAc,EACd,MAAM,EACN,cAAc,EACd,UAAU,EACV,kBAAkB,EAClB,MAAM,EACN,cAAc,EACd,cAAc,EACd,YAAY,EACZ,oBAAoB,GACrB,MAAM,0BAA0B,CAAC"}
|
package/dist/types/strapi.d.ts
CHANGED
|
@@ -93,6 +93,10 @@ export interface BlockTextChild {
|
|
|
93
93
|
export interface BlockLinkChild {
|
|
94
94
|
type: 'link';
|
|
95
95
|
url: string;
|
|
96
|
+
/** Strapi blocks editor free input; unset values may be an empty string. */
|
|
97
|
+
target?: string;
|
|
98
|
+
/** Strapi blocks editor free input; unset values may be an empty string. */
|
|
99
|
+
rel?: string;
|
|
96
100
|
children: BlockTextChild[];
|
|
97
101
|
}
|
|
98
102
|
export type BlockInlineNode = BlockTextChild | BlockLinkChild;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"strapi.d.ts","sourceRoot":"","sources":["../../src/types/strapi.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAMD,MAAM,WAAW,eAAe,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM;IAC3D,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,IAAI,CAAC;CACnB;AAMD,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,IAAI,EAAE,CAAC,CAAC;IACR,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACzC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,IAAI,EAAE;QACJ,UAAU,EAAE,gBAAgB,CAAC;KAC9B,CAAC;CACH;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAMD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE;QACL,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAClC,CAAC;CACH;AAMD,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;QACf,SAAS,EAAE,iBAAiB,CAAC;QAC7B,KAAK,EAAE,iBAAiB,CAAC;QACzB,MAAM,EAAE,iBAAiB,CAAC;QAC1B,KAAK,EAAE,iBAAiB,CAAC;KAC1B,CAAC,CAAC;IACH,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAMD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,cAAc,EAAE,CAAC;CAC5B;AAED,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG,cAAc,CAAC;AAE9D,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAChC,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,cAAc,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,WAAW,CAAC;IACnB,QAAQ,EAAE,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,EAAE,CAAA;KAAE,CAAC,CAAC;CACxC;AAED,MAAM,MAAM,SAAS,GACjB,cAAc,GACd,YAAY,GACZ,SAAS,GACT,UAAU,GACV,SAAS,GACT,UAAU,CAAC;AAEf,wCAAwC;AACxC,MAAM,MAAM,aAAa,GAAG,SAAS,EAAE,CAAC"}
|
|
1
|
+
{"version":3,"file":"strapi.d.ts","sourceRoot":"","sources":["../../src/types/strapi.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAMD,MAAM,WAAW,eAAe,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM;IAC3D,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,IAAI,CAAC;CACnB;AAMD,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,IAAI,EAAE,CAAC,CAAC;IACR,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACzC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,IAAI,EAAE;QACJ,UAAU,EAAE,gBAAgB,CAAC;KAC9B,CAAC;CACH;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAMD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE;QACL,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAClC,CAAC;CACH;AAMD,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;QACf,SAAS,EAAE,iBAAiB,CAAC;QAC7B,KAAK,EAAE,iBAAiB,CAAC;QACzB,MAAM,EAAE,iBAAiB,CAAC;QAC1B,KAAK,EAAE,iBAAiB,CAAC;KAC1B,CAAC,CAAC;IACH,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAMD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,4EAA4E;IAC5E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4EAA4E;IAC5E,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,cAAc,EAAE,CAAC;CAC5B;AAED,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG,cAAc,CAAC;AAE9D,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAChC,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,cAAc,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,WAAW,CAAC;IACnB,QAAQ,EAAE,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,EAAE,CAAA;KAAE,CAAC,CAAC;CACxC;AAED,MAAM,MAAM,SAAS,GACjB,cAAc,GACd,YAAY,GACZ,SAAS,GACT,UAAU,GACV,SAAS,GACT,UAAU,CAAC;AAEf,wCAAwC;AACxC,MAAM,MAAM,aAAa,GAAG,SAAS,EAAE,CAAC"}
|
package/docs/api-guide.md
CHANGED
|
@@ -22,15 +22,17 @@ const client = createStrapiClient({
|
|
|
22
22
|
|
|
23
23
|
| Function | Method | Endpoint | Returns | Notes |
|
|
24
24
|
|----------|--------|----------|---------|-------|
|
|
25
|
-
| `getPage(client, docId, opts?)` | GET | `/api/builder/pages/:docId` | `PageDocument` | Smart endpoint |
|
|
26
|
-
| `getPageBySlug(client, slug, opts?)` | GET | `/api/builder/pages`, then `/api/builder/pages/:docId` | `PageDocument \| null` | Slug lookup, then deep Smart read |
|
|
27
|
-
| `listPages(client, opts?)` | GET | `/api/builder/pages` | `{ data, meta }` | Smart, no blocks; pagination: `page`, `pageSize` |
|
|
28
|
-
| `listPagesRest(client, opts?)` | GET | `/api/builder/pages` | `{ data, meta }` |
|
|
25
|
+
| `getPage(client, docId, opts?)` | GET | `/api/builder/pages/:docId` | `PageDocument` | Smart endpoint; see [공개 조회 규칙](#공개-조회-규칙) |
|
|
26
|
+
| `getPageBySlug(client, slug, opts?)` | GET | `/api/builder/pages`, then `/api/builder/pages/:docId` | `PageDocument \| null` | Slug lookup, then deep Smart read; see [공개 조회 규칙](#공개-조회-규칙) |
|
|
27
|
+
| `listPages(client, opts?)` | GET | `/api/builder/pages` | `{ data, meta }` | Smart, no blocks; see [공개 조회 규칙](#공개-조회-규칙); pagination: `page`, `pageSize` |
|
|
28
|
+
| `listPagesRest(client, opts?)` | GET | `/api/builder/pages` | `{ data, meta }` | Legacy name; Smart list ignores client populate; pagination: `page`, `pageSize` |
|
|
29
|
+
| `listLegalDocuments(client, opts?)` | GET | `/api/builder/legal-documents` | `{ data, meta }` | Locale; sort: title:asc; pagination: `page`, `pageSize` |
|
|
30
|
+
| `getLegalDocumentBySlug(client, slug, opts?)` | GET | `/api/builder/legal-documents` | `LegalDocumentDocument \| null` | Locale and slug filter; authenticated `status: 'draft'` for previews |
|
|
29
31
|
| `getArticle(client, docId, opts?)` | GET | `/api/builder/articles/:docId` | `ArticleDocument` | REST, full populate |
|
|
30
32
|
| `getArticleBySlug(client, slug, opts?)` | GET | `/api/builder/articles` | `ArticleDocument \| null` | REST, filter by slug |
|
|
31
33
|
| `listArticles(client, opts?)` | GET | `/api/builder/articles` | `{ data, meta }` | Filter: category, tag, author, series; pagination: `page`, `pageSize` |
|
|
32
34
|
| `getGlobal(client, opts?)` | GET | `/api/builder/global` | `GlobalDocument` | Smart endpoint |
|
|
33
|
-
| `getGlobalRest(client, opts?)` | GET | `/api/builder/global` | `GlobalDocument` |
|
|
35
|
+
| `getGlobalRest(client, opts?)` | GET | `/api/builder/global` | `GlobalDocument` | Legacy name; Smart Global ignores client populate |
|
|
34
36
|
| `getNavigation(client, opts?)` | GET | `/api/builder/navigation` | `NavigationDocument` | REST |
|
|
35
37
|
| `getSiteSettings(client)` | GET | `/api/builder/site-setting` | `SiteSettingsDocument` | No locale, no draftAndPublish |
|
|
36
38
|
| `listFaqs(client, opts?)` | GET | `/api/builder/faqs` | `{ data, meta }` | Filter: category; sort: sortOrder:asc; pagination: `page`, `pageSize` |
|
|
@@ -40,27 +42,41 @@ const client = createStrapiClient({
|
|
|
40
42
|
| `getAuthorBySlug(client, slug)` | GET | `/api/builder/authors` | `AuthorDocument \| null` | Filter by slug |
|
|
41
43
|
| `listSeries(client, opts?)` | GET | `/api/builder/all-series` | `{ data, meta }` | Note: `/all-series` not `/series`; pagination: `page`, `pageSize` |
|
|
42
44
|
| `getSeriesBySlug(client, slug, locale?)` | GET | `/api/builder/all-series` | `SeriesDocument \| null` | Filter by slug |
|
|
43
|
-
| `
|
|
45
|
+
| `getForm(client, slug)` | GET | `/api/builder/forms/:slug` | `FormDefinition` | Public fields, consent and version |
|
|
46
|
+
| `submitForm(client, slug, input)` | POST | `/api/builder/forms/:slug/submissions` | `SubmissionReceipt` | Body: `{ data: SubmissionInput }` |
|
|
47
|
+
| `isSubmissionError(error)` | — | — | `error is SubmissionError` | Type guard for `submitForm` failures, including transport errors |
|
|
44
48
|
|
|
45
49
|
## Smart vs REST
|
|
46
50
|
|
|
47
|
-
|
|
51
|
+
Page list/detail (`/api/builder/pages`, `/api/builder/pages/:docId`) and Global
|
|
52
|
+
(`/api/builder/global`) use fixed server-side populate. `listPagesRest` and
|
|
53
|
+
`getGlobalRest` retain legacy names and send client populate parameters, but the
|
|
54
|
+
Smart handlers ignore those parameters. Passing `customBlocks` cannot override
|
|
55
|
+
server population; register custom block populate on the CMS.
|
|
48
56
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
| `/api/builder/pages` | `/api/builder/pages` (list, no blocks) |
|
|
52
|
-
| `/api/builder/pages/:docId` | `/api/builder/pages/:docId` (single, full blocks) |
|
|
53
|
-
| `/api/builder/global` | `/api/builder/global` (full populate) |
|
|
57
|
+
Other collections use Builder core REST endpoints with client-side populate.
|
|
58
|
+
The `/api/builder/` prefix alone does not distinguish Smart from core REST.
|
|
54
59
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
60
|
+
`getPageBySlug` first uses the limited Smart list endpoint to resolve the slug,
|
|
61
|
+
then loads the document through Smart detail. This keeps list reads inexpensive
|
|
62
|
+
while returning deeply populated core and server-registered custom blocks.
|
|
58
63
|
|
|
59
|
-
|
|
64
|
+
### 공개 조회 규칙
|
|
65
|
+
|
|
66
|
+
Page 조회는 기본적으로 published이며, `status: 'draft'`는 인증된 요청에만 적용된다.
|
|
67
|
+
공개 `listPages`/`listPagesRest` 결과에는 `directAccess: false` 페이지가 없고,
|
|
68
|
+
`getPageBySlug`는 해당 페이지에 `null`을 반환한다. `getPage(client, documentId)`와
|
|
69
|
+
인증된 draft 조회에는 이 directAccess 필터가 적용되지 않는다.
|
|
70
|
+
|
|
71
|
+
0.16.0부터 루트 `/` 페이지는 `Global.home` 관계로 선택한다.
|
|
72
|
+
`home` slug로 조회하는 fallback은 없다. 루트 렌더링은 `getGlobal`의 `home`을 사용한다.
|
|
73
|
+
|
|
74
|
+
Both legal-document helpers populate only `localizations` with `locale` and `slug` fields. The slug helper returns the first match or `null`; omitted or `'published'` status uses Strapi's default published read. Draft reads require an authenticated editor. `LegalDocumentDocument.body` is Blocks JSON, with nullable `summary` and `effectiveDate`.
|
|
60
75
|
|
|
61
76
|
## Populate Builders
|
|
62
77
|
|
|
63
|
-
|
|
78
|
+
Nine populate builders construct nested `populate` parameters for core REST queries
|
|
79
|
+
or consumer/server integration. Smart Page/Global handlers keep their own populate:
|
|
64
80
|
|
|
65
81
|
| Builder | Used For |
|
|
66
82
|
|---------|----------|
|
|
@@ -123,32 +139,10 @@ const global = await getGlobal(client, { locale: 'ko' });
|
|
|
123
139
|
|
|
124
140
|
### Submit inquiry
|
|
125
141
|
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
consentVersion: "1",
|
|
131
|
-
idempotencyKey: crypto.randomUUID(),
|
|
132
|
-
email: "john@example.com",
|
|
133
|
-
subject: "General inquiry",
|
|
134
|
-
message: "Hello...",
|
|
135
|
-
});
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
The response is only `{ accepted: true }`, including on replay; it contains no
|
|
139
|
-
submission fields, IDs, or keys. `InquiryDocument` describes internal/admin
|
|
140
|
-
records, whose audit fields may be null for legacy submissions. Public Inquiry
|
|
141
|
-
read, update, and delete routes are unavailable.
|
|
142
|
-
|
|
143
|
-
Consent must be literal `true`, with a nonempty printable ASCII version identifier
|
|
144
|
-
(up to 120 characters) identifying the notice shown to the submitter. Keep the
|
|
145
|
-
same idempotency key across retries of unchanged input. Keys are trimmed, case
|
|
146
|
-
sensitive, at most 128 characters, and use letters, digits, `.`, `_`, `:`, or `-`
|
|
147
|
-
(starting with a letter or digit). A changed payload using an existing key gets
|
|
148
|
-
the original acceptance receipt without overwriting the record. Generate a new
|
|
149
|
-
key for a new submission. Keys are optional for older integrations, but omitted
|
|
150
|
-
keys are stored as SQL NULL and every such request creates an independent row.
|
|
151
|
-
See [consumer configuration and migration](../../../docs/guides/extending-builder.md#inquiry-validation-and-additive-fields).
|
|
142
|
+
Use `submitForm(client, slug, input)` with a configured form targeting Inquiry;
|
|
143
|
+
see [dynamic forms](#dynamic-forms) and [consumer setup](../../../docs/guides/extending-builder.md#forms-and-fixed-inquiry-proxies).
|
|
144
|
+
`Inquiry` and `InquiryDocument` describe storage records. Legacy `postInquiry`,
|
|
145
|
+
`InquiryFormData`, and `InquiryReceipt` are removed.
|
|
152
146
|
|
|
153
147
|
## Media URL Resolution
|
|
154
148
|
|
|
@@ -203,6 +197,7 @@ try {
|
|
|
203
197
|
| Content Type | i18n | Base Type |
|
|
204
198
|
|-------------|------|-----------|
|
|
205
199
|
| Page | yes | `StrapiI18nDocument` |
|
|
200
|
+
| Legal Document | yes | `StrapiI18nDocument` |
|
|
206
201
|
| Article | yes | `StrapiI18nDocument` |
|
|
207
202
|
| FAQ | yes | `StrapiI18nDocument` |
|
|
208
203
|
| Category | yes | `StrapiI18nDocument` |
|
|
@@ -246,3 +241,43 @@ export const fetchGlobal = (locale?: string) =>
|
|
|
246
241
|
Many FAQs can share one category. `FaqDocument.category` remains a single category or `null`. Category lists omit the reverse relation by default; request it with `listCategories(client, { populateFaqs: true, locale: 'en' })`. When populated, `CategoryDocument.faqs` is an array, including `[]` for a category with no visible FAQs. `getCategoryPopulate()` returns `{ faqs: { populate: { category: true } } }` for custom REST queries; nested categories omit their own FAQs, so population stays finite. Normal Strapi publication, locale, and authorization rules apply to populated FAQs.
|
|
247
242
|
|
|
248
243
|
Upgrading the builder plugin preserves existing links during schema synchronization on SQLite and PostgreSQL. Take a database backup before upgrading and confirm FAQ categories after the first boot. Once categories have multiple FAQs, a downgrade to the previous one-to-one schema is unsafe; restore the backup or first reduce each category to one FAQ document, checking draft/published and locale records.
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
## Dynamic forms
|
|
247
|
+
|
|
248
|
+
```ts
|
|
249
|
+
import { getForm, submitForm, isSubmissionError } from '@dani-builder/strapi-client/api';
|
|
250
|
+
|
|
251
|
+
const form = await getForm(client, 'contact');
|
|
252
|
+
// form contains fields, consent and version; admin configuration stays private.
|
|
253
|
+
// Keep this key for retries of this intent; create a new key for a new submission.
|
|
254
|
+
const idempotencyKey = crypto.randomUUID();
|
|
255
|
+
try {
|
|
256
|
+
const receipt = await submitForm(client, 'contact', {
|
|
257
|
+
fields: { email: 'reader@example.com' },
|
|
258
|
+
consent: true,
|
|
259
|
+
idempotencyKey,
|
|
260
|
+
formVersion: form.version,
|
|
261
|
+
});
|
|
262
|
+
console.log(receipt.id, receipt.receivedAt);
|
|
263
|
+
} catch (error) {
|
|
264
|
+
if (!isSubmissionError(error)) throw error;
|
|
265
|
+
switch (error.kind) {
|
|
266
|
+
case 'validation': console.log(error.fieldErrors); break;
|
|
267
|
+
case 'form_outdated': console.log('Reload the form before submitting again'); break;
|
|
268
|
+
case 'rate_limited': console.log('Please try again later'); break;
|
|
269
|
+
case 'rejected': console.log(error.status, error.code, error.message); break;
|
|
270
|
+
case 'transport': console.log(error.message); break;
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
Field values are strings, numbers, or booleans. Render `fields` using their type,
|
|
276
|
+
label, visibility, options and constraints, and present `consent.label` before
|
|
277
|
+
collecting consent. `form.version` is the submission's `formVersion`;
|
|
278
|
+
`consent.version` identifies the consent text. A 409 `idempotency_conflict` has
|
|
279
|
+
kind `rejected`, while an outdated form has kind `form_outdated`. Hook rejections
|
|
280
|
+
preserve the server status, code and message. Native Strapi 429 responses are
|
|
281
|
+
normalized to code `rate_limited`. Transport failures have no HTTP status.
|
|
282
|
+
|
|
283
|
+
`Inquiry` and `InquiryDocument` remain storage types; submissions use `submitForm`.
|
package/docs/block-reference.md
CHANGED
|
@@ -117,7 +117,7 @@ lives inside the nested `section` component, not at the block root.
|
|
|
117
117
|
|
|
118
118
|
## Inquiry Form
|
|
119
119
|
|
|
120
|
-
`blocks.inquiry-form` —
|
|
120
|
+
`blocks.inquiry-form` — Renders a published Builder form by slug
|
|
121
121
|
|
|
122
122
|
| Attribute | Type | Required | Default | Notes |
|
|
123
123
|
|---|---|---|---|---|
|
|
@@ -126,6 +126,7 @@ lives inside the nested `section` component, not at the block root.
|
|
|
126
126
|
| `errorMessage` | text | — | — | — |
|
|
127
127
|
| `consentLabel` | text | — | — | — |
|
|
128
128
|
| `consentVersion` | string | — | — | maxLength 120 |
|
|
129
|
+
| `form` | string | — | — | — |
|
|
129
130
|
|
|
130
131
|
## Logo Cloud
|
|
131
132
|
|
package/docs/content-types.md
CHANGED
|
@@ -5,6 +5,9 @@ generated: true
|
|
|
5
5
|
generator: .claude/skills/docs-steward/scripts/gen-reference.mjs
|
|
6
6
|
sources:
|
|
7
7
|
- packages/strapi-plugin-builder/server/src/content-types/*/schema.json
|
|
8
|
+
- packages/strapi-plugin-builder/server/src/routes/content-api.ts
|
|
9
|
+
- packages/strapi-client/src/types/content-types/form.ts
|
|
10
|
+
- packages/strapi-client/src/api/form.ts
|
|
8
11
|
---
|
|
9
12
|
|
|
10
13
|
<!-- DO NOT EDIT. Run `pnpm docs:gen` after changing the schemas. -->
|
|
@@ -14,7 +17,7 @@ sources:
|
|
|
14
17
|
Every content type provided by `@dani-builder/strapi-plugin-builder`.
|
|
15
18
|
REST endpoints use `singularName` for single types and `pluralName` for collection types.
|
|
16
19
|
Series' `pluralName` must differ from its `singularName`, hence `/api/builder/all-series`.
|
|
17
|
-
|
|
20
|
+
Public REST routes are mounted under `/api/builder/` and use plugin-owned UIDs; private models have no content API endpoint.
|
|
18
21
|
|
|
19
22
|
## Overview
|
|
20
23
|
|
|
@@ -24,15 +27,25 @@ All routes are mounted under `/api/builder/` and use plugin-owned UIDs.
|
|
|
24
27
|
| Author | collection | `plugin::builder.author` | `api/builder/authors` | — | — |
|
|
25
28
|
| Category | collection | `plugin::builder.category` | `api/builder/categories` | yes | — |
|
|
26
29
|
| FAQ | collection | `plugin::builder.faq` | `api/builder/faqs` | yes | yes |
|
|
30
|
+
| Form | collection | `plugin::builder.form` | — (private) | — | — |
|
|
27
31
|
| Global | single | `plugin::builder.global` | `api/builder/global` | yes | yes |
|
|
28
|
-
| Inquiry | collection | `plugin::builder.inquiry` |
|
|
32
|
+
| Inquiry | collection | `plugin::builder.inquiry` | — (private) | — | — |
|
|
29
33
|
| Legal Document | collection | `plugin::builder.legal-document` | `api/builder/legal-documents` | yes | yes |
|
|
30
34
|
| Navigation | single | `plugin::builder.navigation` | `api/builder/navigation` | yes | yes |
|
|
31
35
|
| Page | collection | `plugin::builder.page` | `api/builder/pages` | yes | yes |
|
|
32
36
|
| Series | collection | `plugin::builder.series` | `api/builder/all-series` | yes | — |
|
|
33
37
|
| Site Settings | single | `plugin::builder.site-setting` | `api/builder/site-setting` | — | — |
|
|
38
|
+
| Submission | collection | `plugin::builder.submission` | — (private) | — | — |
|
|
34
39
|
| Tag | collection | `plugin::builder.tag` | `api/builder/tags` | yes | — |
|
|
35
40
|
|
|
41
|
+
## Public form client contract
|
|
42
|
+
|
|
43
|
+
`getForm(client, slug)` returns only `{ fields, consent, version }` from `GET /api/builder/forms/:slug`. The public `FormDefinition` excludes admin name, target UID, and notification configuration.
|
|
44
|
+
`FormField.type` supports string, text, email, integer, decimal, boolean, enumeration, date, and datetime. Fields carry label, required, form/hidden visibility, optional placeholder/help, enumeration options, and maxLength/min/max constraints.
|
|
45
|
+
`submitForm(client, slug, { fields, consent: true, idempotencyKey, formVersion })` posts a data wrapper to `/api/builder/forms/:slug/submissions` and returns a `SubmissionReceipt` containing only id and receivedAt. Field values are string, number, or boolean.
|
|
46
|
+
`isSubmissionError(error)` narrows to `SubmissionError`; switch on kind for validation (400, fieldErrors), form_outdated (409), rate_limited (429), rejected (including hook status/code/message and idempotency_conflict), or transport (no HTTP status).
|
|
47
|
+
`Inquiry` and `InquiryDocument` remain storage types. The legacy `postInquiry`, `InquiryFormData`, and `InquiryReceipt` contracts are removed; use `submitForm`.
|
|
48
|
+
|
|
36
49
|
## Article
|
|
37
50
|
|
|
38
51
|
Blog/news post with rich text body and relations
|
|
@@ -94,6 +107,20 @@ Frequently asked question entry
|
|
|
94
107
|
| `sortOrder` | integer | — | — | — |
|
|
95
108
|
| `category` | relation `manyToOne` → `plugin::builder.category` | — | — | — |
|
|
96
109
|
|
|
110
|
+
## Form
|
|
111
|
+
|
|
112
|
+
Form definitions managed through authenticated Builder admin routes. Public GET /api/builder/forms/:slug exposes fields, consent and version only.
|
|
113
|
+
|
|
114
|
+
| Attribute | Type | Required | Default | Notes |
|
|
115
|
+
|---|---|---|---|---|
|
|
116
|
+
| `slug` | string | yes | — | maxLength 120 |
|
|
117
|
+
| `name` | string | yes | — | maxLength 120 |
|
|
118
|
+
| `targetUid` | string | yes | — | — |
|
|
119
|
+
| `fields` | json | yes | — | — |
|
|
120
|
+
| `consent` | json | yes | — | — |
|
|
121
|
+
| `version` | integer | yes | `1` | — |
|
|
122
|
+
| `notifications` | json | — | `[object Object]` | — |
|
|
123
|
+
|
|
97
124
|
## Global
|
|
98
125
|
|
|
99
126
|
Site-wide content, theme settings, footer, and common blocks
|
|
@@ -193,6 +220,22 @@ Operational settings for analytics, chatbot, and site verification
|
|
|
193
220
|
| `siteVerifications` | component `shared.site-verification` (repeatable) | — | — | — |
|
|
194
221
|
| `brandColors` | component `shared.brand-colors` | — | — | — |
|
|
195
222
|
|
|
223
|
+
## Submission
|
|
224
|
+
|
|
225
|
+
Private submission ledger. Public POST /api/builder/forms/:slug/submissions returns a receipt only; no ledger read or update endpoint.
|
|
226
|
+
|
|
227
|
+
| Attribute | Type | Required | Default | Notes |
|
|
228
|
+
|---|---|---|---|---|
|
|
229
|
+
| `form` | string | yes | — | — |
|
|
230
|
+
| `idempotencyKey` | string | yes | — | maxLength 128 |
|
|
231
|
+
| `payloadHash` | string | yes | — | — |
|
|
232
|
+
| `consentAt` | datetime | yes | — | — |
|
|
233
|
+
| `consentVersion` | string | yes | — | — |
|
|
234
|
+
| `status` | enumeration | yes | `received` | `received`, `reviewing`, `responded`, `closed` |
|
|
235
|
+
| `targetUid` | string | yes | — | — |
|
|
236
|
+
| `targetDocumentId` | string | — | — | — |
|
|
237
|
+
| `deliveries` | json | — | `` | — |
|
|
238
|
+
|
|
196
239
|
## Tag
|
|
197
240
|
|
|
198
241
|
Article tag with optional color
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dani-builder/strapi-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "TypeScript client for Daniworks Builder CMS (Strapi v5)",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -58,7 +58,7 @@
|
|
|
58
58
|
"directory": "packages/strapi-client"
|
|
59
59
|
},
|
|
60
60
|
"dependencies": {
|
|
61
|
-
"axios": "^1.
|
|
61
|
+
"axios": "^1.20.0",
|
|
62
62
|
"qs": "^6.15.3",
|
|
63
63
|
"@dani-builder/agent-contract": ">=0.5.0 <1"
|
|
64
64
|
},
|
|
@@ -68,8 +68,8 @@
|
|
|
68
68
|
"typescript": "^6.0.3",
|
|
69
69
|
"@types/node": "^26",
|
|
70
70
|
"@dani-builder/agent-contract-build": "npm:@dani-builder/agent-contract@0.6.0",
|
|
71
|
-
"@repo/
|
|
72
|
-
"@repo/
|
|
71
|
+
"@repo/eslint-config": "0.0.0",
|
|
72
|
+
"@repo/typescript-config": "0.0.0"
|
|
73
73
|
},
|
|
74
74
|
"keywords": [
|
|
75
75
|
"strapi",
|
package/dist/api/inquiry.d.ts
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import type { AxiosInstance } from 'axios';
|
|
2
|
-
import type { InquiryReceipt, InquiryFormData } from '../types/content-types/inquiry.js';
|
|
3
|
-
/**
|
|
4
|
-
* Submit an inquiry form (POST).
|
|
5
|
-
*/
|
|
6
|
-
export declare function postInquiry<Data extends InquiryFormData>(client: AxiosInstance, data: Data): Promise<InquiryReceipt>;
|
|
7
|
-
//# sourceMappingURL=inquiry.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"inquiry.d.ts","sourceRoot":"","sources":["../../src/api/inquiry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EAChB,MAAM,mCAAmC,CAAC;AAE3C;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,SAAS,eAAe,EACtD,MAAM,EAAE,aAAa,EACrB,IAAI,EAAE,IAAI,2BAKX"}
|
package/dist/api/inquiry.js
DELETED
package/dist/api/inquiry.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"inquiry.js","sourceRoot":"","sources":["../../src/api/inquiry.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,UAAU,WAAW,CACzB,MAAqB,EACrB,IAAU;IAEV,OAAO,MAAM;SACV,IAAI,CAAiC,wBAAwB,EAAE,EAAE,IAAI,EAAE,CAAC;SACxE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC"}
|