@aglyn/plugins-forms 1.24.0 → 1.26.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aglyn/plugins-forms",
3
- "version": "1.24.0",
3
+ "version": "1.26.0",
4
4
  "license": "Apache-2.0",
5
5
  "homepage": "https://aglyn.com",
6
6
  "repository": {
@@ -25,19 +25,19 @@
25
25
  "./package.json": "./package.json"
26
26
  },
27
27
  "dependencies": {
28
- "@aglyn/aglyn": "1.24.0",
29
- "@aglyn/shared-data-enums": "1.24.0",
30
- "@aglyn/shared-data-mdi": "1.24.0",
31
- "@aglyn/shared-ui-jsx": "1.24.0",
32
- "@aglyn/shared-ui-jsx-forms": "1.24.0",
33
- "@aglyn/shared-ui-snackstack": "1.24.0",
34
- "@aglyn/shared-util-email": "1.24.0",
35
- "@aglyn/shared-util-http": "1.24.0",
36
- "@aglyn/shared-util-timestamp": "1.24.0",
37
- "@aglyn/shared-util-tools": "1.24.0",
38
- "@aglyn/tenant-data-admin": "1.24.0",
39
- "@aglyn/tenant-feature-instance": "1.24.0",
40
- "@aglyn/tenant-runtime": "1.24.0",
28
+ "@aglyn/aglyn": "1.26.0",
29
+ "@aglyn/shared-data-enums": "1.26.0",
30
+ "@aglyn/shared-data-mdi": "1.26.0",
31
+ "@aglyn/shared-ui-jsx": "1.26.0",
32
+ "@aglyn/shared-ui-jsx-forms": "1.26.0",
33
+ "@aglyn/shared-ui-snackstack": "1.26.0",
34
+ "@aglyn/shared-util-email": "1.26.0",
35
+ "@aglyn/shared-util-http": "1.26.0",
36
+ "@aglyn/shared-util-timestamp": "1.26.0",
37
+ "@aglyn/shared-util-tools": "1.26.0",
38
+ "@aglyn/tenant-data-admin": "1.26.0",
39
+ "@aglyn/tenant-feature-instance": "1.26.0",
40
+ "@aglyn/tenant-runtime": "1.26.0",
41
41
  "@swc/helpers": "0.5.24"
42
42
  },
43
43
  "peerDependencies": {
@@ -13,7 +13,7 @@
13
13
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
14
  * See the License for the specific language governing permissions and
15
15
  * limitations under the License.
16
- */ import { booleanField as bool, objectKindField as OBJECT_FIELD, openObjectField as objectOf, queryParam as q, RECORD_STAMPS as STAMPS, stringField as str } from "@aglyn/tenant-data-admin/server/api-v1-description";
16
+ */ import { booleanField as bool, objectKindField as OBJECT_FIELD, openObjectField as objectOf, queryParam as q, RECORD_STAMPS as STAMPS, stringField as str, SITE_ID_PATH_PARAM } from "@aglyn/tenant-data-admin/server/api-v1-description";
17
17
  /**
18
18
  * `/v1/sites/{siteId}/form-submissions` as the customer API's OpenAPI
19
19
  * document describes it — what the console's builder turns into paths, a tag
@@ -23,6 +23,7 @@
23
23
  * documentation promises.
24
24
  */ export const FORM_SUBMISSIONS_API_V1_DESCRIPTION = {
25
25
  tag: 'Form submissions',
26
+ docsPage: 'form-submissions',
26
27
  description: 'What visitors sent through a site’s forms.',
27
28
  schemaName: 'FormSubmission',
28
29
  required: [
@@ -53,10 +54,10 @@
53
54
  path: '/v1/sites/{siteId}/form-submissions',
54
55
  method: 'get',
55
56
  operationId: 'listFormSubmissions',
56
- summary: 'List submissions',
57
+ summary: 'List a site’s form entries',
57
58
  list: true,
58
59
  returns: 'FormSubmission',
59
- description: 'Combining `form`/`formId` with `read` narrows on the form and checks `read` on the page, so pages can come back short.',
60
+ description: 'Lists what visitors sent through one site’s forms, with each entry’s fields and whether it has been read. Needs `siteId` from List sites. Filter by form or by read state.',
60
61
  filters: [
61
62
  q('form', 'Form name.'),
62
63
  q('formId', 'Form id.'),
@@ -69,23 +70,18 @@
69
70
  })
70
71
  ],
71
72
  pathParams: [
72
- {
73
- name: 'siteId',
74
- description: 'Site id.'
75
- }
73
+ SITE_ID_PATH_PARAM
76
74
  ]
77
75
  },
78
76
  {
79
77
  path: '/v1/sites/{siteId}/form-submissions/{submissionId}',
80
78
  method: 'get',
81
79
  operationId: 'getFormSubmission',
82
- summary: 'Retrieve a submission',
80
+ summary: 'Get a form entry',
81
+ description: 'Returns one form entry. Needs `siteId` from List sites and `submissionId` from List a site’s form entries.',
83
82
  returns: 'FormSubmission',
84
83
  pathParams: [
85
- {
86
- name: 'siteId',
87
- description: 'Site id.'
88
- },
84
+ SITE_ID_PATH_PARAM,
89
85
  {
90
86
  name: 'submissionId',
91
87
  description: 'Submission id.'
@@ -96,14 +92,12 @@
96
92
  path: '/v1/sites/{siteId}/form-submissions/{submissionId}',
97
93
  method: 'patch',
98
94
  operationId: 'updateFormSubmission',
99
- summary: 'Mark a submission read',
95
+ summary: 'Mark a form entry read or unread',
96
+ description: 'Sets whether a form entry has been read; nothing else about it can change. Needs `siteId` and `submissionId`. Returns the entry.',
100
97
  accepts: 'FormSubmissionWrite',
101
98
  returns: 'FormSubmission',
102
99
  pathParams: [
103
- {
104
- name: 'siteId',
105
- description: 'Site id.'
106
- },
100
+ SITE_ID_PATH_PARAM,
107
101
  {
108
102
  name: 'submissionId',
109
103
  description: 'Submission id.'
@@ -114,13 +108,11 @@
114
108
  path: '/v1/sites/{siteId}/form-submissions/{submissionId}',
115
109
  method: 'delete',
116
110
  operationId: 'deleteFormSubmission',
117
- summary: 'Delete a submission',
111
+ summary: 'Delete a form entry',
112
+ description: 'Deletes a form entry permanently. Needs `siteId` and `submissionId`.',
118
113
  returns: 'Deleted',
119
114
  pathParams: [
120
- {
121
- name: 'siteId',
122
- description: 'Site id.'
123
- },
115
+ SITE_ID_PATH_PARAM,
124
116
  {
125
117
  name: 'submissionId',
126
118
  description: 'Submission id.'
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../../../../../../libs/plugins/forms/src/lib/server/api-v1/openapi.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n type ApiV1ResourceDescription,\n booleanField as bool,\n objectKindField as OBJECT_FIELD,\n openObjectField as objectOf,\n queryParam as q,\n RECORD_STAMPS as STAMPS,\n stringField as str,\n} from '@aglyn/tenant-data-admin/server/api-v1-description'\n\n/**\n * `/v1/sites/{siteId}/form-submissions` as the customer API's OpenAPI\n * document describes it — what the console's builder turns into paths, a tag\n * and schemas, and the MCP tools derive from. Transcribed unchanged from the\n * builder's own list when the resource moved here (AGL-3080);\n * `api-v1-openapi.spec.ts` holds the document to every endpoint the\n * documentation promises.\n */\nexport const FORM_SUBMISSIONS_API_V1_DESCRIPTION: ApiV1ResourceDescription = {\n tag: 'Form submissions',\n description: 'What visitors sent through a site’s forms.',\n schemaName: 'FormSubmission',\n required: ['id', 'object', 'form_id', 'fields'],\n writable: ['read'],\n writeRequired: ['read'],\n fields: {\n id: str('Submission id.'),\n object: OBJECT_FIELD('form_submission'),\n form_id: str('Form id.'),\n form: str('Form name.'),\n path: str('Page path the form was submitted from.'),\n fields: objectOf('The submitted values, keyed by field name.'),\n read: bool('Whether the submission has been marked read.'),\n routing: objectOf('Where the submission was routed.'),\n created: STAMPS.created,\n },\n ops: [\n { path: '/v1/sites/{siteId}/form-submissions', method: 'get', operationId: 'listFormSubmissions', summary: 'List submissions', list: true, returns: 'FormSubmission', description: 'Combining `form`/`formId` with `read` narrows on the form and checks `read` on the page, so pages can come back short.', filters: [q('form', 'Form name.'), q('formId', 'Form id.'), q('read', 'Either `true` or `false`. Anything else is a 400.', { type: 'string', enum: ['true', 'false'] })], pathParams: [{ name: 'siteId', description: 'Site id.' }] },\n { path: '/v1/sites/{siteId}/form-submissions/{submissionId}', method: 'get', operationId: 'getFormSubmission', summary: 'Retrieve a submission', returns: 'FormSubmission', pathParams: [{ name: 'siteId', description: 'Site id.' }, { name: 'submissionId', description: 'Submission id.' }] },\n { path: '/v1/sites/{siteId}/form-submissions/{submissionId}', method: 'patch', operationId: 'updateFormSubmission', summary: 'Mark a submission read', accepts: 'FormSubmissionWrite', returns: 'FormSubmission', pathParams: [{ name: 'siteId', description: 'Site id.' }, { name: 'submissionId', description: 'Submission id.' }] },\n { path: '/v1/sites/{siteId}/form-submissions/{submissionId}', method: 'delete', operationId: 'deleteFormSubmission', summary: 'Delete a submission', returns: 'Deleted', pathParams: [{ name: 'siteId', description: 'Site id.' }, { name: 'submissionId', description: 'Submission id.' }] },\n ],\n}\n"],"names":["booleanField","bool","objectKindField","OBJECT_FIELD","openObjectField","objectOf","queryParam","q","RECORD_STAMPS","STAMPS","stringField","str","FORM_SUBMISSIONS_API_V1_DESCRIPTION","tag","description","schemaName","required","writable","writeRequired","fields","id","object","form_id","form","path","read","routing","created","ops","method","operationId","summary","list","returns","filters","type","enum","pathParams","name","accepts"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,SAEEA,gBAAgBC,IAAI,EACpBC,mBAAmBC,YAAY,EAC/BC,mBAAmBC,QAAQ,EAC3BC,cAAcC,CAAC,EACfC,iBAAiBC,MAAM,EACvBC,eAAeC,GAAG,QACb,qDAAoD;AAE3D;;;;;;;CAOC,GACD,OAAO,MAAMC,sCAAgE;IAC3EC,KAAK;IACLC,aAAa;IACbC,YAAY;IACZC,UAAU;QAAC;QAAM;QAAU;QAAW;KAAS;IAC/CC,UAAU;QAAC;KAAO;IAClBC,eAAe;QAAC;KAAO;IACvBC,QAAQ;QACNC,IAAIT,IAAI;QACRU,QAAQlB,aAAa;QACrBmB,SAASX,IAAI;QACbY,MAAMZ,IAAI;QACVa,MAAMb,IAAI;QACVQ,QAAQd,SAAS;QACjBoB,MAAMxB,KAAK;QACXyB,SAASrB,SAAS;QAClBsB,SAASlB,OAAOkB,OAAO;IACzB;IACAC,KAAK;QACH;YAAEJ,MAAM;YAAuCK,QAAQ;YAAOC,aAAa;YAAuBC,SAAS;YAAoBC,MAAM;YAAMC,SAAS;YAAkBnB,aAAa;YAA0HoB,SAAS;gBAAC3B,EAAE,QAAQ;gBAAeA,EAAE,UAAU;gBAAaA,EAAE,QAAQ,qDAAqD;oBAAE4B,MAAM;oBAAUC,MAAM;wBAAC;wBAAQ;qBAAQ;gBAAC;aAAG;YAAEC,YAAY;gBAAC;oBAAEC,MAAM;oBAAUxB,aAAa;gBAAW;aAAE;QAAC;QACjhB;YAAEU,MAAM;YAAsDK,QAAQ;YAAOC,aAAa;YAAqBC,SAAS;YAAyBE,SAAS;YAAkBI,YAAY;gBAAC;oBAAEC,MAAM;oBAAUxB,aAAa;gBAAW;gBAAG;oBAAEwB,MAAM;oBAAgBxB,aAAa;gBAAiB;aAAE;QAAC;QAC/R;YAAEU,MAAM;YAAsDK,QAAQ;YAASC,aAAa;YAAwBC,SAAS;YAA0BQ,SAAS;YAAuBN,SAAS;YAAkBI,YAAY;gBAAC;oBAAEC,MAAM;oBAAUxB,aAAa;gBAAW;gBAAG;oBAAEwB,MAAM;oBAAgBxB,aAAa;gBAAiB;aAAE;QAAC;QACrU;YAAEU,MAAM;YAAsDK,QAAQ;YAAUC,aAAa;YAAwBC,SAAS;YAAuBE,SAAS;YAAWI,YAAY;gBAAC;oBAAEC,MAAM;oBAAUxB,aAAa;gBAAW;gBAAG;oBAAEwB,MAAM;oBAAgBxB,aAAa;gBAAiB;aAAE;QAAC;KAC7R;AACH,EAAC"}
1
+ {"version":3,"sources":["../../../../../../../../libs/plugins/forms/src/lib/server/api-v1/openapi.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n type ApiV1ResourceDescription,\n booleanField as bool,\n objectKindField as OBJECT_FIELD,\n openObjectField as objectOf,\n queryParam as q,\n RECORD_STAMPS as STAMPS,\n stringField as str,\n SITE_ID_PATH_PARAM,\n} from '@aglyn/tenant-data-admin/server/api-v1-description'\n\n/**\n * `/v1/sites/{siteId}/form-submissions` as the customer API's OpenAPI\n * document describes it — what the console's builder turns into paths, a tag\n * and schemas, and the MCP tools derive from. Transcribed unchanged from the\n * builder's own list when the resource moved here (AGL-3080);\n * `api-v1-openapi.spec.ts` holds the document to every endpoint the\n * documentation promises.\n */\nexport const FORM_SUBMISSIONS_API_V1_DESCRIPTION: ApiV1ResourceDescription = {\n tag: 'Form submissions',\n docsPage: 'form-submissions',\n description: 'What visitors sent through a site’s forms.',\n schemaName: 'FormSubmission',\n required: ['id', 'object', 'form_id', 'fields'],\n writable: ['read'],\n writeRequired: ['read'],\n fields: {\n id: str('Submission id.'),\n object: OBJECT_FIELD('form_submission'),\n form_id: str('Form id.'),\n form: str('Form name.'),\n path: str('Page path the form was submitted from.'),\n fields: objectOf('The submitted values, keyed by field name.'),\n read: bool('Whether the submission has been marked read.'),\n routing: objectOf('Where the submission was routed.'),\n created: STAMPS.created,\n },\n ops: [\n { path: '/v1/sites/{siteId}/form-submissions', method: 'get', operationId: 'listFormSubmissions', summary: 'List a site’s form entries', list: true, returns: 'FormSubmission', description: 'Lists what visitors sent through one site’s forms, with each entry’s fields and whether it has been read. Needs `siteId` from List sites. Filter by form or by read state.', filters: [q('form', 'Form name.'), q('formId', 'Form id.'), q('read', 'Either `true` or `false`. Anything else is a 400.', { type: 'string', enum: ['true', 'false'] })], pathParams: [SITE_ID_PATH_PARAM] },\n { path: '/v1/sites/{siteId}/form-submissions/{submissionId}', method: 'get', operationId: 'getFormSubmission', summary: 'Get a form entry', description: 'Returns one form entry. Needs `siteId` from List sites and `submissionId` from List a site’s form entries.', returns: 'FormSubmission', pathParams: [SITE_ID_PATH_PARAM, { name: 'submissionId', description: 'Submission id.' }] },\n { path: '/v1/sites/{siteId}/form-submissions/{submissionId}', method: 'patch', operationId: 'updateFormSubmission', summary: 'Mark a form entry read or unread', description: 'Sets whether a form entry has been read; nothing else about it can change. Needs `siteId` and `submissionId`. Returns the entry.', accepts: 'FormSubmissionWrite', returns: 'FormSubmission', pathParams: [SITE_ID_PATH_PARAM, { name: 'submissionId', description: 'Submission id.' }] },\n { path: '/v1/sites/{siteId}/form-submissions/{submissionId}', method: 'delete', operationId: 'deleteFormSubmission', summary: 'Delete a form entry', description: 'Deletes a form entry permanently. Needs `siteId` and `submissionId`.', returns: 'Deleted', pathParams: [SITE_ID_PATH_PARAM, { name: 'submissionId', description: 'Submission id.' }] },\n ],\n}\n"],"names":["booleanField","bool","objectKindField","OBJECT_FIELD","openObjectField","objectOf","queryParam","q","RECORD_STAMPS","STAMPS","stringField","str","SITE_ID_PATH_PARAM","FORM_SUBMISSIONS_API_V1_DESCRIPTION","tag","docsPage","description","schemaName","required","writable","writeRequired","fields","id","object","form_id","form","path","read","routing","created","ops","method","operationId","summary","list","returns","filters","type","enum","pathParams","name","accepts"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,SAEEA,gBAAgBC,IAAI,EACpBC,mBAAmBC,YAAY,EAC/BC,mBAAmBC,QAAQ,EAC3BC,cAAcC,CAAC,EACfC,iBAAiBC,MAAM,EACvBC,eAAeC,GAAG,EAClBC,kBAAkB,QACb,qDAAoD;AAE3D;;;;;;;CAOC,GACD,OAAO,MAAMC,sCAAgE;IAC3EC,KAAK;IACLC,UAAU;IACVC,aAAa;IACbC,YAAY;IACZC,UAAU;QAAC;QAAM;QAAU;QAAW;KAAS;IAC/CC,UAAU;QAAC;KAAO;IAClBC,eAAe;QAAC;KAAO;IACvBC,QAAQ;QACNC,IAAIX,IAAI;QACRY,QAAQpB,aAAa;QACrBqB,SAASb,IAAI;QACbc,MAAMd,IAAI;QACVe,MAAMf,IAAI;QACVU,QAAQhB,SAAS;QACjBsB,MAAM1B,KAAK;QACX2B,SAASvB,SAAS;QAClBwB,SAASpB,OAAOoB,OAAO;IACzB;IACAC,KAAK;QACH;YAAEJ,MAAM;YAAuCK,QAAQ;YAAOC,aAAa;YAAuBC,SAAS;YAA8BC,MAAM;YAAMC,SAAS;YAAkBnB,aAAa;YAA8KoB,SAAS;gBAAC7B,EAAE,QAAQ;gBAAeA,EAAE,UAAU;gBAAaA,EAAE,QAAQ,qDAAqD;oBAAE8B,MAAM;oBAAUC,MAAM;wBAAC;wBAAQ;qBAAQ;gBAAC;aAAG;YAAEC,YAAY;gBAAC3B;aAAmB;QAAC;QACtjB;YAAEc,MAAM;YAAsDK,QAAQ;YAAOC,aAAa;YAAqBC,SAAS;YAAoBjB,aAAa;YAA8GmB,SAAS;YAAkBI,YAAY;gBAAC3B;gBAAoB;oBAAE4B,MAAM;oBAAgBxB,aAAa;gBAAiB;aAAE;QAAC;QAC5X;YAAEU,MAAM;YAAsDK,QAAQ;YAASC,aAAa;YAAwBC,SAAS;YAAoCjB,aAAa;YAAoIyB,SAAS;YAAuBN,SAAS;YAAkBI,YAAY;gBAAC3B;gBAAoB;oBAAE4B,MAAM;oBAAgBxB,aAAa;gBAAiB;aAAE;QAAC;QACvc;YAAEU,MAAM;YAAsDK,QAAQ;YAAUC,aAAa;YAAwBC,SAAS;YAAuBjB,aAAa;YAAwEmB,SAAS;YAAWI,YAAY;gBAAC3B;gBAAoB;oBAAE4B,MAAM;oBAAgBxB,aAAa;gBAAiB;aAAE;QAAC;KACzV;AACH,EAAC"}