@uniweb/core 0.24.2 → 0.24.4

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/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniweb/core",
3
- "version": "0.24.2",
3
+ "version": "0.24.4",
4
4
  "description": "Core classes for the Uniweb platform - Uniweb, Website, Page, Block",
5
5
  "type": "module",
6
6
  "exports": {
@@ -43,8 +43,8 @@
43
43
  "vitest": "^4.1.7"
44
44
  },
45
45
  "dependencies": {
46
- "@uniweb/semantic-parser": "^1.4.0",
47
- "@uniweb/theming": "^0.1.15"
46
+ "@uniweb/theming": "^0.1.15",
47
+ "@uniweb/semantic-parser": "^1.4.0"
48
48
  },
49
49
  "scripts": {
50
50
  "test": "vitest run"
package/src/services.js CHANGED
@@ -12,10 +12,14 @@ import { applyBasePath } from './base-path.js'
12
12
  * address comes from configuration, and there are exactly two places it can
13
13
  * come from:
14
14
  *
15
- * 1. **The site**, authored — `search:`, `submit:`, `assistant:`, `tracking:`
16
- * in site.yml. The operator's own declaration, and it wins.
17
- * 2. **The host**, served — `config.services.<name>` in the payload. What the
18
- * deployment offers, which the site never had to know about.
15
+ * 1. **The host**, served — `config.services.<name>` in the payload. What the
16
+ * deployment offers, which the site never had to know about. When a host
17
+ * offers a service, that is the answer: it is the authority on what a
18
+ * hosted site is given.
19
+ * 2. **The site**, authored — `search:`, `submit:`, `assistant:`, `tracking:`
20
+ * in site.yml. The operator's own declaration — used for anything the host
21
+ * does not provide, and on a static site, where no host speaks, the whole
22
+ * answer.
19
23
  *
20
24
  * Absent from both means the site has no such service, and the caller acts on
21
25
  * that rather than guessing an address. That is the same rule for every service,
@@ -117,7 +121,37 @@ const ABSOLUTE_URL_RE = /^(?:[a-z][a-z0-9+.-]*:|\/\/)/i
117
121
  * @param {*} declaration
118
122
  * @returns {string} the endpoint, or '' when there is none
119
123
  */
124
+ /**
125
+ * Has this declaration switched the service OFF?
126
+ *
127
+ * ⭐ `false`, or an object with `enabled: false` — on either tier, for every
128
+ * name. It is the spelling `search` has always honoured
129
+ * (`Website.isSearchEnabled`), now read for every service.
130
+ *
131
+ * ⛔ **Until 2026-09-10 this module read it for NO service** — so the same
132
+ * spelling behaved two ways: `search: false` turned search off, while
133
+ * `submit: false` or `submit: { endpoint, enabled: false }` drew the form
134
+ * anyway. On a static site the authored key is the only place a service can be
135
+ * declared, so there the switch worked for search alone.
136
+ *
137
+ * ⚖️ **A site's refusal does not override a host's offer** — step 3 of
138
+ * `resolveService` says why.
139
+ *
140
+ * Module-private on purpose: it is a rule of the two readers below, not a
141
+ * question a caller should ask. `resolveService` is the question.
142
+ */
143
+ function isServiceRefused(declaration) {
144
+ return (
145
+ declaration === false ||
146
+ (declaration !== null && typeof declaration === 'object' && declaration.enabled === false)
147
+ )
148
+ }
149
+
120
150
  export function readEndpoint(declaration) {
151
+ // A refused service offers no address, whatever else its block carries — so
152
+ // a host row with `enabled: false` reads as a decline, and the records lane
153
+ // (`records-service.js`) withholds its address the same way.
154
+ if (isServiceRefused(declaration)) return ''
121
155
  if (typeof declaration === 'string') return declaration.trim()
122
156
  if (typeof declaration?.endpoint === 'string') return declaration.endpoint.trim()
123
157
  return ''
@@ -168,28 +202,42 @@ export function resolveServiceUrl(endpoint, basePath = '') {
168
202
  * @param {string} name - service name, e.g. 'submit' · 'search' · 'tracking'
169
203
  * @returns {{ url: string|null, source: 'site'|'host'|null }}
170
204
  * `url` is the whole answer for acting. `source` says which declaration
171
- * answered — a diagnostic, and the thing to check when a host's value appears
172
- * not to be taking effect. `'host'` with a null `url` means the host answered
205
+ * answered — a diagnostic, and the thing to check when a value you set
206
+ * appears not to be taking effect. `'host'` with a null `url` means the host answered
173
207
  * and offered no address; `null` means nothing declared the service at all.
174
208
  */
175
209
  export function resolveService(website, name) {
176
210
  const config = website?.config
177
211
  const basePath = website?.basePath
178
212
 
179
- // 1 — the site's own declaration wins. An operator who named an endpoint
180
- // means it, including on a host that offers one.
181
- const authored = readEndpoint(config?.[name])
182
- if (authored) {
183
- return { url: resolveServiceUrl(authored, basePath), source: 'site' }
184
- }
185
-
186
- // 2 — what the host says it offers.
213
+ // 1 — what the host OFFERS. A host that returns an address is the authority
214
+ // on what a hosted site is given: nothing the site declares overrides it —
215
+ // not its own address (step 2), not its off switch (step 3).
187
216
  const hostDeclaration = config?.services?.[name]
188
217
  const hostEndpoint = readEndpoint(hostDeclaration)
189
218
  if (hostEndpoint) {
190
219
  return { url: resolveServiceUrl(hostEndpoint, basePath), source: 'host' }
191
220
  }
192
221
 
222
+ // 2 — the site's own ADDRESS, for a service the host does not provide: an
223
+ // operator bringing their own provider — a form service, self-hosted search
224
+ // on a host that does not sell it — keeps working. On a static site no host
225
+ // speaks, so this is the whole answer. (Until 2026-09-10 it came first and
226
+ // outranked a host's offer too.)
227
+ const authored = readEndpoint(config?.[name])
228
+ if (authored) {
229
+ return { url: resolveServiceUrl(authored, basePath), source: 'site' }
230
+ }
231
+
232
+ // 3 — ⛔ A SITE THAT SWITCHED THE SERVICE OFF — but only where no host offers
233
+ // it. A host that returns an address is the authority on what a hosted site
234
+ // is given: the site asked for the service where the host manages it, and a
235
+ // hosted service is turned off there — not with a second switch here that
236
+ // would hide a service the host is still providing. On a static site no host
237
+ // speaks, so this is the only switch there is, and it decides. (It briefly
238
+ // ran first, on 2026-09-10, and beat a host's offer — the wrong way round.)
239
+ if (isServiceRefused(config?.[name])) return { url: null, source: 'site' }
240
+
193
241
  // A host may declare the name while offering no address — a decline. It is
194
242
  // still the host answering, which is all a caller can use: any *wording* for
195
243
  // that state would be ours to invent, in one language, for a visitor who has
package/src/website.js CHANGED
@@ -16,6 +16,18 @@ import { resolveFetchConfigs } from './fetch-config.js'
16
16
  import { buildDetailConfig } from './detail-url.js'
17
17
  import { resolveService } from './services.js'
18
18
 
19
+ /**
20
+ * Services whose provider is not simply an address, keyed by name.
21
+ *
22
+ * ⭐ **Only `search` is here, and only because it has a LOCAL provider** — the
23
+ * prebuilt index answers with no address at all. Everything else resolves to
24
+ * `resolveService(website, name).url !== null`, so an entry here is the
25
+ * exception rather than the pattern. Read by `Website.isServiceEnabled`.
26
+ */
27
+ const SERVICE_RESOLVERS = {
28
+ search: (website) => website.isSearchEnabled(),
29
+ }
30
+
19
31
  /**
20
32
  * Website — orchestration root for a single site instance.
21
33
  *
@@ -1128,13 +1140,15 @@ export default class Website {
1128
1140
  * @returns {boolean}
1129
1141
  */
1130
1142
  isSearchEnabled() {
1131
- const search = this.config?.search
1132
- if (typeof search === 'boolean') {
1133
- if (!search) return false
1134
- } else if (search?.enabled === false) {
1135
- return false
1136
- }
1137
-
1143
+ // ⭐ THE ORDER IS resolveService's, the same for every service: the host's
1144
+ // offer, then the site's own endpoint, then the site's `false` /
1145
+ // `{ enabled: false }` — which decides only where no host offers search. So
1146
+ // an author's `search: false` turns the local index off on a static site
1147
+ // and does not hide search a host provides; a hosted service is turned off
1148
+ // where the host provides it. Until 2026-09-10 this method read the
1149
+ // author's switch FIRST, so `search: false` beat a host's offer — the one
1150
+ // service where it did, and the opposite of every other.
1151
+ //
1138
1152
  // ⭐ THE HOST GETS A SAY, and this is the half that reaches an already-
1139
1153
  // published foundation. A foundation bundles its own frozen copy of
1140
1154
  // `@uniweb/kit`, so a fix made in kit never reaches one built before it.
@@ -1152,17 +1166,62 @@ export default class Website {
1152
1166
  // error, and any text a visitor reads is site content — authored and
1153
1167
  // localized — never a string a service layer invents.
1154
1168
  //
1155
- // A site's OWN `search.endpoint` still wins: `resolveService` answers from
1156
- // the site tier first, so self-hosted search on a host that does not sell
1157
- // it is untouched.
1169
+ // A site's own `search.endpoint` still works where the host does not offer
1170
+ // search, so self-hosted search on a host that does not sell it is
1171
+ // untouched. Where the host offers search, its offer wins.
1158
1172
  const { url, source } = resolveService(this, 'search')
1159
- if (source === 'host' && !url) return false
1160
-
1161
- // Enabled by default — absent means enabled, and a host that publishes no
1162
- // services block at all has declined nothing (the static-host path).
1173
+ // An address from anyone — the site's own endpoint, or a host's offer.
1174
+ if (url) return true
1175
+ // 'site': switched off, with no host offering it. 'host': the host declines.
1176
+ if (source) return false
1177
+
1178
+ // Nobody spoke: enabled by default — absent means enabled, and a host that
1179
+ // publishes no services block at all has declined nothing (the static-host
1180
+ // path, where the build emits the local index).
1163
1181
  return true
1164
1182
  }
1165
1183
 
1184
+ /**
1185
+ * Is there a provider for this service?
1186
+ *
1187
+ * ⭐ **The one question a foundation asks before rendering UI for a service**,
1188
+ * and the single implementation behind `@uniweb/kit`'s no-argument predicates
1189
+ * (`isSearchEnabled()`, `isSubmitEnabled()`, …). Those resolve the active
1190
+ * website and call this; they add no logic of their own.
1191
+ *
1192
+ * ⛔ **"Is there a provider", not "is there an address".** For every service
1193
+ * but one those are the same question, because the only possible provider is
1194
+ * reached at an address. **Search has two** — an address, or the prebuilt
1195
+ * index that needs none (`search.provider: index`) — so `search` resolves
1196
+ * through `isSearchEnabled()` above, which also honours the author's switch
1197
+ * and a host's decline. ⇒ A service is enabled when *something* provides it.
1198
+ *
1199
+ * ⚖️ That is a branch in a generic function on purpose. If it lived in the
1200
+ * callers instead, `isServiceEnabled('search')` would be a legal call
1201
+ * returning `false` on a static site carrying an index — the wrong answer for
1202
+ * rendering, on the standalone lane, reachable by anyone using the general
1203
+ * form. Here no caller can reach the wrong answer.
1204
+ *
1205
+ * ⛔ **No explanatory string, ever.** `false` means draw nothing — not a
1206
+ * disabled control and not an apology. Not-provisioned is not an error, and
1207
+ * any wording would be ours to invent, in one language, for a visitor with no
1208
+ * stake in it (`core/src/services.js`).
1209
+ *
1210
+ * The registry is open: any name resolves, whether or not the framework ships
1211
+ * a client for it.
1212
+ *
1213
+ * @param {string} name - the service name — `search`, `submit`, `api`, …
1214
+ * @returns {boolean}
1215
+ */
1216
+ isServiceEnabled(name) {
1217
+ if (typeof name !== 'string' || !name) return false
1218
+ // A map rather than an `if`, so the next service to gain a local provider is
1219
+ // an entry rather than a second branch.
1220
+ const special = SERVICE_RESOLVERS[name]
1221
+ if (special) return special(this)
1222
+ return resolveService(this, name).url !== null
1223
+ }
1224
+
1166
1225
  /**
1167
1226
  * Get search configuration
1168
1227
  * @returns {Object} Search configuration