@molecule/api-slug 0.0.0-stage → 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/LICENSE +202 -0
- package/README.md +156 -2
- package/dist/browser-guard.d.ts +2 -0
- package/dist/browser-guard.d.ts.map +1 -0
- package/dist/browser-guard.js +18 -0
- package/dist/index.d.ts +37 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +36 -0
- package/dist/slugify.d.ts +17 -0
- package/dist/slugify.d.ts.map +1 -0
- package/dist/slugify.js +46 -0
- package/dist/types.d.ts +26 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +6 -0
- package/dist/unique.d.ts +34 -0
- package/dist/unique.d.ts.map +1 -0
- package/dist/unique.js +70 -0
- package/package.json +52 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,157 @@
|
|
|
1
|
-
|
|
1
|
+
<!--
|
|
2
|
+
AUTO-GENERATED — DO NOT EDIT THIS FILE.
|
|
3
|
+
Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
|
|
4
|
+
Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
|
|
5
|
+
To change this document, edit the module-level JSDoc in src/index.ts.
|
|
6
|
+
Generated: 2026-10-15T09:18:33.573Z
|
|
7
|
+
-->
|
|
2
8
|
|
|
3
|
-
|
|
9
|
+
# @molecule/api-slug
|
|
10
|
+
|
|
11
|
+
> **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
|
|
12
|
+
> It is written to be read by coding agents as much as by people, and is generated from this
|
|
13
|
+
> package's source — edit `src/index.ts` JSDoc, not this file.
|
|
14
|
+
|
|
15
|
+
URL slugs for titles and names.
|
|
16
|
+
|
|
17
|
+
`slugify` folds accents and punctuation into a lowercase, hyphenated slug;
|
|
18
|
+
`uniqueSlug` finds one your store does not have yet; `uniqueSlugInTable`
|
|
19
|
+
does that against a table column through the bonded DataStore.
|
|
20
|
+
|
|
21
|
+
## Quick Start
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { slugify, uniqueSlugInTable } from '@molecule/api-slug'
|
|
25
|
+
|
|
26
|
+
slugify('Café au lait: a how-to!') // 'cafe-au-lait-a-how-to'
|
|
27
|
+
|
|
28
|
+
// In a create handler: the first "Hello World" gets hello-world, the next hello-world-2.
|
|
29
|
+
const slug = await uniqueSlugInTable('articles', 'slug', input.title)
|
|
30
|
+
|
|
31
|
+
// On update, a row keeps its own slug:
|
|
32
|
+
const next = await uniqueSlugInTable('articles', 'slug', input.title, { excludeId: article.id })
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Type
|
|
36
|
+
|
|
37
|
+
`utility`
|
|
38
|
+
|
|
39
|
+
## Installation
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npm install @molecule/api-slug @molecule/api-database
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## API
|
|
46
|
+
|
|
47
|
+
### Interfaces
|
|
48
|
+
|
|
49
|
+
#### `SlugifyOptions`
|
|
50
|
+
|
|
51
|
+
How {@link slugify} shapes a slug.
|
|
52
|
+
|
|
53
|
+
```typescript
|
|
54
|
+
interface SlugifyOptions {
|
|
55
|
+
/** Joins the words (default `'-'`). */
|
|
56
|
+
separator?: string
|
|
57
|
+
/** Longest slug kept, cut at a word boundary when one is near (default 80). */
|
|
58
|
+
maxLength?: number
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
#### `UniqueSlugOptions`
|
|
63
|
+
|
|
64
|
+
How {@link uniqueSlug} looks for a free slug.
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
interface UniqueSlugOptions extends SlugifyOptions {
|
|
68
|
+
/** Numbered tries (`slug-2` … `slug-N`) before a random suffix (default 20). */
|
|
69
|
+
maxNumbered?: number
|
|
70
|
+
/** Always end in a random suffix, even when the plain slug is free (default false). */
|
|
71
|
+
alwaysSuffix?: boolean
|
|
72
|
+
/** The base when the text has no letters or digits (default `'item'`). */
|
|
73
|
+
fallback?: string
|
|
74
|
+
}
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Functions
|
|
78
|
+
|
|
79
|
+
#### `slugify(text, options)`
|
|
80
|
+
|
|
81
|
+
Turn a title or name into a URL slug: accents folded ("Café" → "cafe"),
|
|
82
|
+
lowercase, every run of other characters one separator, no separator at
|
|
83
|
+
either end, cut to `maxLength` at a word boundary when one is near.
|
|
84
|
+
|
|
85
|
+
```typescript
|
|
86
|
+
function slugify(text: string, options?: SlugifyOptions): string
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
- `text` — The title or name.
|
|
90
|
+
- `options` — Separator and maximum length.
|
|
91
|
+
|
|
92
|
+
**Returns:** The slug; empty when the text has no letters or digits at all.
|
|
93
|
+
|
|
94
|
+
#### `uniqueSlug(text, isTaken, options)`
|
|
95
|
+
|
|
96
|
+
A slug for `text` that `isTaken` says is free: the plain slug, then
|
|
97
|
+
`slug-2`, `slug-3` … up to `maxNumbered`, then `slug-<random>`.
|
|
98
|
+
|
|
99
|
+
A check-then-insert can still race another writer: keep a UNIQUE index on
|
|
100
|
+
the column and retry the insert on a conflict (call this again).
|
|
101
|
+
|
|
102
|
+
```typescript
|
|
103
|
+
function uniqueSlug(
|
|
104
|
+
text: string,
|
|
105
|
+
isTaken: (slug: string) => Promise<boolean> | boolean,
|
|
106
|
+
options?: UniqueSlugOptions,
|
|
107
|
+
): Promise<string>
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
- `text` — The title or name.
|
|
111
|
+
- `isTaken` — Whether a slug is already used (your store's lookup).
|
|
112
|
+
- `options` — Slug options, the numbered tries and a fallback for text with no letters.
|
|
113
|
+
|
|
114
|
+
**Returns:** A slug `isTaken` reported free.
|
|
115
|
+
|
|
116
|
+
#### `uniqueSlugInTable(table, column, text, options)`
|
|
117
|
+
|
|
118
|
+
{@link uniqueSlug} checked against a table column through the bonded
|
|
119
|
+
DataStore (`@molecule/api-database`).
|
|
120
|
+
|
|
121
|
+
```typescript
|
|
122
|
+
function uniqueSlugInTable(
|
|
123
|
+
table: string,
|
|
124
|
+
column: string,
|
|
125
|
+
text: string,
|
|
126
|
+
options?: UniqueSlugOptions & { excludeId?: string },
|
|
127
|
+
): Promise<string>
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
- `table` — The table, e.g. `'articles'`.
|
|
131
|
+
- `column` — The slug column, e.g. `'slug'`.
|
|
132
|
+
- `text` — The title or name.
|
|
133
|
+
- `options` — As for {@link uniqueSlug}; `excludeId` lets a row keep its own slug on update.
|
|
134
|
+
|
|
135
|
+
**Returns:** A slug no other row of the table uses.
|
|
136
|
+
|
|
137
|
+
## Injection Notes
|
|
138
|
+
|
|
139
|
+
### Requirements
|
|
140
|
+
|
|
141
|
+
Peer dependencies:
|
|
142
|
+
|
|
143
|
+
- `@molecule/api-database` ^1.0.1
|
|
144
|
+
|
|
145
|
+
### Runtime Dependencies
|
|
146
|
+
|
|
147
|
+
- `@molecule/api-database`
|
|
148
|
+
|
|
149
|
+
- **Keep a UNIQUE index on the slug column.** Checking and then inserting can
|
|
150
|
+
race another request; the index makes the second insert fail, and calling
|
|
151
|
+
`uniqueSlugInTable` again finds the next free slug.
|
|
152
|
+
- **`alwaysSuffix: true`** gives every row a random tail (`hello-world-k3x9q2`),
|
|
153
|
+
for specs that expect slugs not to collide or not to be guessable.
|
|
154
|
+
- Text with no letters or digits (`'!!!'`) slugifies to `''`; the unique
|
|
155
|
+
variants fall back to `fallback` (default `'item'`).
|
|
156
|
+
- `uniqueSlugInTable` needs a DataStore bond (`@molecule/api-database`);
|
|
157
|
+
`slugify` and `uniqueSlug` need nothing.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"browser-guard.d.ts","sourceRoot":"","sources":["../src/browser-guard.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,CAAA"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Browser guard — `@molecule/api-slug` is SERVER-ONLY.
|
|
3
|
+
*
|
|
4
|
+
* Generated by scripts/gen-browser-guards.mjs (workspace root) — edit THAT, not this.
|
|
5
|
+
* Evaluating a server package in a browser bundle is always an import-graph mistake
|
|
6
|
+
* (node APIs, secrets); without this guard it surfaces as a cryptic downstream crash
|
|
7
|
+
* ("Buffer is not defined") far from the culprit. Throwing here names the package and
|
|
8
|
+
* the fix at the exact moment the client bundle evaluates it. jsdom tests and SSR are
|
|
9
|
+
* unaffected: the throw requires browser globals AND the absence of a node runtime.
|
|
10
|
+
*/
|
|
11
|
+
const g = globalThis;
|
|
12
|
+
if (g.window !== undefined && g.document !== undefined && !g.process?.versions?.node) {
|
|
13
|
+
throw new Error('@molecule/api-slug is SERVER-ONLY: it was bundled into browser/client code. Import it only ' +
|
|
14
|
+
'from server code (a server route/function or your API), or dynamic-import it inside ' +
|
|
15
|
+
'the server handler — never from components or shared client modules, and never ' +
|
|
16
|
+
'polyfill Buffer/process to silence this.');
|
|
17
|
+
}
|
|
18
|
+
export {};
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* URL slugs for titles and names.
|
|
3
|
+
*
|
|
4
|
+
* `slugify` folds accents and punctuation into a lowercase, hyphenated slug;
|
|
5
|
+
* `uniqueSlug` finds one your store does not have yet; `uniqueSlugInTable`
|
|
6
|
+
* does that against a table column through the bonded DataStore.
|
|
7
|
+
*
|
|
8
|
+
* @module
|
|
9
|
+
* @example
|
|
10
|
+
* ```typescript
|
|
11
|
+
* import { slugify, uniqueSlugInTable } from '@molecule/api-slug'
|
|
12
|
+
*
|
|
13
|
+
* slugify('Café au lait: a how-to!') // 'cafe-au-lait-a-how-to'
|
|
14
|
+
*
|
|
15
|
+
* // In a create handler: the first "Hello World" gets hello-world, the next hello-world-2.
|
|
16
|
+
* const slug = await uniqueSlugInTable('articles', 'slug', input.title)
|
|
17
|
+
*
|
|
18
|
+
* // On update, a row keeps its own slug:
|
|
19
|
+
* const next = await uniqueSlugInTable('articles', 'slug', input.title, { excludeId: article.id })
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @remarks
|
|
23
|
+
* - **Keep a UNIQUE index on the slug column.** Checking and then inserting can
|
|
24
|
+
* race another request; the index makes the second insert fail, and calling
|
|
25
|
+
* `uniqueSlugInTable` again finds the next free slug.
|
|
26
|
+
* - **`alwaysSuffix: true`** gives every row a random tail (`hello-world-k3x9q2`),
|
|
27
|
+
* for specs that expect slugs not to collide or not to be guessable.
|
|
28
|
+
* - Text with no letters or digits (`'!!!'`) slugifies to `''`; the unique
|
|
29
|
+
* variants fall back to `fallback` (default `'item'`).
|
|
30
|
+
* - `uniqueSlugInTable` needs a DataStore bond (`@molecule/api-database`);
|
|
31
|
+
* `slugify` and `uniqueSlug` need nothing.
|
|
32
|
+
*/
|
|
33
|
+
export * from './browser-guard.js';
|
|
34
|
+
export * from './slugify.js';
|
|
35
|
+
export * from './types.js';
|
|
36
|
+
export * from './unique.js';
|
|
37
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,cAAc,oBAAoB,CAAA;AAClC,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* URL slugs for titles and names.
|
|
3
|
+
*
|
|
4
|
+
* `slugify` folds accents and punctuation into a lowercase, hyphenated slug;
|
|
5
|
+
* `uniqueSlug` finds one your store does not have yet; `uniqueSlugInTable`
|
|
6
|
+
* does that against a table column through the bonded DataStore.
|
|
7
|
+
*
|
|
8
|
+
* @module
|
|
9
|
+
* @example
|
|
10
|
+
* ```typescript
|
|
11
|
+
* import { slugify, uniqueSlugInTable } from '@molecule/api-slug'
|
|
12
|
+
*
|
|
13
|
+
* slugify('Café au lait: a how-to!') // 'cafe-au-lait-a-how-to'
|
|
14
|
+
*
|
|
15
|
+
* // In a create handler: the first "Hello World" gets hello-world, the next hello-world-2.
|
|
16
|
+
* const slug = await uniqueSlugInTable('articles', 'slug', input.title)
|
|
17
|
+
*
|
|
18
|
+
* // On update, a row keeps its own slug:
|
|
19
|
+
* const next = await uniqueSlugInTable('articles', 'slug', input.title, { excludeId: article.id })
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @remarks
|
|
23
|
+
* - **Keep a UNIQUE index on the slug column.** Checking and then inserting can
|
|
24
|
+
* race another request; the index makes the second insert fail, and calling
|
|
25
|
+
* `uniqueSlugInTable` again finds the next free slug.
|
|
26
|
+
* - **`alwaysSuffix: true`** gives every row a random tail (`hello-world-k3x9q2`),
|
|
27
|
+
* for specs that expect slugs not to collide or not to be guessable.
|
|
28
|
+
* - Text with no letters or digits (`'!!!'`) slugifies to `''`; the unique
|
|
29
|
+
* variants fall back to `fallback` (default `'item'`).
|
|
30
|
+
* - `uniqueSlugInTable` needs a DataStore bond (`@molecule/api-database`);
|
|
31
|
+
* `slugify` and `uniqueSlug` need nothing.
|
|
32
|
+
*/
|
|
33
|
+
export * from './browser-guard.js';
|
|
34
|
+
export * from './slugify.js';
|
|
35
|
+
export * from './types.js';
|
|
36
|
+
export * from './unique.js';
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Turning text into a URL slug.
|
|
3
|
+
*
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
6
|
+
import type { SlugifyOptions } from './types.js';
|
|
7
|
+
/**
|
|
8
|
+
* Turn a title or name into a URL slug: accents folded ("Café" → "cafe"),
|
|
9
|
+
* lowercase, every run of other characters one separator, no separator at
|
|
10
|
+
* either end, cut to `maxLength` at a word boundary when one is near.
|
|
11
|
+
*
|
|
12
|
+
* @param text - The title or name.
|
|
13
|
+
* @param options - Separator and maximum length.
|
|
14
|
+
* @returns The slug; empty when the text has no letters or digits at all.
|
|
15
|
+
*/
|
|
16
|
+
export declare function slugify(text: string, options?: SlugifyOptions): string;
|
|
17
|
+
//# sourceMappingURL=slugify.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"slugify.d.ts","sourceRoot":"","sources":["../src/slugify.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAkBhD;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,MAAM,CAgB1E"}
|
package/dist/slugify.js
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Turning text into a URL slug.
|
|
3
|
+
*
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* Letters NFKD does not decompose into a base letter plus a mark, folded by
|
|
8
|
+
* hand so "Straße" and "Øresund" keep their letters.
|
|
9
|
+
*/
|
|
10
|
+
const FOLDS = {
|
|
11
|
+
ß: 'ss',
|
|
12
|
+
æ: 'ae',
|
|
13
|
+
œ: 'oe',
|
|
14
|
+
ø: 'o',
|
|
15
|
+
đ: 'd',
|
|
16
|
+
ð: 'd',
|
|
17
|
+
þ: 'th',
|
|
18
|
+
ł: 'l',
|
|
19
|
+
ı: 'i',
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* Turn a title or name into a URL slug: accents folded ("Café" → "cafe"),
|
|
23
|
+
* lowercase, every run of other characters one separator, no separator at
|
|
24
|
+
* either end, cut to `maxLength` at a word boundary when one is near.
|
|
25
|
+
*
|
|
26
|
+
* @param text - The title or name.
|
|
27
|
+
* @param options - Separator and maximum length.
|
|
28
|
+
* @returns The slug; empty when the text has no letters or digits at all.
|
|
29
|
+
*/
|
|
30
|
+
export function slugify(text, options = {}) {
|
|
31
|
+
const separator = options.separator ?? '-';
|
|
32
|
+
const maxLength = options.maxLength ?? 80;
|
|
33
|
+
const folded = text
|
|
34
|
+
.normalize('NFKD')
|
|
35
|
+
.replace(/\p{M}+/gu, '')
|
|
36
|
+
.toLowerCase()
|
|
37
|
+
.replace(/[ßæœøđðþłı]/g, (c) => FOLDS[c] ?? c);
|
|
38
|
+
const words = folded.split(/[^a-z0-9]+/).filter(Boolean);
|
|
39
|
+
let slug = words.join(separator);
|
|
40
|
+
if (slug.length > maxLength) {
|
|
41
|
+
const cut = slug.slice(0, maxLength);
|
|
42
|
+
const boundary = cut.lastIndexOf(separator);
|
|
43
|
+
slug = boundary >= maxLength / 2 ? cut.slice(0, boundary) : cut;
|
|
44
|
+
}
|
|
45
|
+
return slug.endsWith(separator) ? slug.slice(0, -separator.length) : slug;
|
|
46
|
+
}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Slug option types.
|
|
3
|
+
*
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* How {@link slugify} shapes a slug.
|
|
8
|
+
*/
|
|
9
|
+
export interface SlugifyOptions {
|
|
10
|
+
/** Joins the words (default `'-'`). */
|
|
11
|
+
separator?: string;
|
|
12
|
+
/** Longest slug kept, cut at a word boundary when one is near (default 80). */
|
|
13
|
+
maxLength?: number;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* How {@link uniqueSlug} looks for a free slug.
|
|
17
|
+
*/
|
|
18
|
+
export interface UniqueSlugOptions extends SlugifyOptions {
|
|
19
|
+
/** Numbered tries (`slug-2` … `slug-N`) before a random suffix (default 20). */
|
|
20
|
+
maxNumbered?: number;
|
|
21
|
+
/** Always end in a random suffix, even when the plain slug is free (default false). */
|
|
22
|
+
alwaysSuffix?: boolean;
|
|
23
|
+
/** The base when the text has no letters or digits (default `'item'`). */
|
|
24
|
+
fallback?: string;
|
|
25
|
+
}
|
|
26
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,uCAAuC;IACvC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,+EAA+E;IAC/E,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACvD,gFAAgF;IAChF,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,uFAAuF;IACvF,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB"}
|
package/dist/types.js
ADDED
package/dist/unique.d.ts
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Slugs that are not taken yet.
|
|
3
|
+
*
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
6
|
+
import type { UniqueSlugOptions } from './types.js';
|
|
7
|
+
/**
|
|
8
|
+
* A slug for `text` that `isTaken` says is free: the plain slug, then
|
|
9
|
+
* `slug-2`, `slug-3` … up to `maxNumbered`, then `slug-<random>`.
|
|
10
|
+
*
|
|
11
|
+
* A check-then-insert can still race another writer: keep a UNIQUE index on
|
|
12
|
+
* the column and retry the insert on a conflict (call this again).
|
|
13
|
+
*
|
|
14
|
+
* @param text - The title or name.
|
|
15
|
+
* @param isTaken - Whether a slug is already used (your store's lookup).
|
|
16
|
+
* @param options - Slug options, the numbered tries and a fallback for text with no letters.
|
|
17
|
+
* @returns A slug `isTaken` reported free.
|
|
18
|
+
* @throws {Error} When every candidate is reported taken (a lookup that always says yes).
|
|
19
|
+
*/
|
|
20
|
+
export declare function uniqueSlug(text: string, isTaken: (slug: string) => Promise<boolean> | boolean, options?: UniqueSlugOptions): Promise<string>;
|
|
21
|
+
/**
|
|
22
|
+
* {@link uniqueSlug} checked against a table column through the bonded
|
|
23
|
+
* DataStore (`@molecule/api-database`).
|
|
24
|
+
*
|
|
25
|
+
* @param table - The table, e.g. `'articles'`.
|
|
26
|
+
* @param column - The slug column, e.g. `'slug'`.
|
|
27
|
+
* @param text - The title or name.
|
|
28
|
+
* @param options - As for {@link uniqueSlug}; `excludeId` lets a row keep its own slug on update.
|
|
29
|
+
* @returns A slug no other row of the table uses.
|
|
30
|
+
*/
|
|
31
|
+
export declare function uniqueSlugInTable(table: string, column: string, text: string, options?: UniqueSlugOptions & {
|
|
32
|
+
excludeId?: string;
|
|
33
|
+
}): Promise<string>;
|
|
34
|
+
//# sourceMappingURL=unique.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"unique.d.ts","sourceRoot":"","sources":["../src/unique.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAKnD;;;;;;;;;;;;GAYG;AACH,wBAAsB,UAAU,CAC9B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,EACrD,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,MAAM,CAAC,CAuBjB;AAED;;;;;;;;;GASG;AACH,wBAAsB,iBAAiB,CACrC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAiB,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAO,GACvD,OAAO,CAAC,MAAM,CAAC,CAYjB"}
|
package/dist/unique.js
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Slugs that are not taken yet.
|
|
3
|
+
*
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
6
|
+
import { findOne } from '@molecule/api-database';
|
|
7
|
+
import { slugify } from './slugify.js';
|
|
8
|
+
/** A short random suffix, so a slug is never guessable from its siblings. */
|
|
9
|
+
const randomSuffix = () => Math.random().toString(36).slice(2, 8).padEnd(6, '0');
|
|
10
|
+
/**
|
|
11
|
+
* A slug for `text` that `isTaken` says is free: the plain slug, then
|
|
12
|
+
* `slug-2`, `slug-3` … up to `maxNumbered`, then `slug-<random>`.
|
|
13
|
+
*
|
|
14
|
+
* A check-then-insert can still race another writer: keep a UNIQUE index on
|
|
15
|
+
* the column and retry the insert on a conflict (call this again).
|
|
16
|
+
*
|
|
17
|
+
* @param text - The title or name.
|
|
18
|
+
* @param isTaken - Whether a slug is already used (your store's lookup).
|
|
19
|
+
* @param options - Slug options, the numbered tries and a fallback for text with no letters.
|
|
20
|
+
* @returns A slug `isTaken` reported free.
|
|
21
|
+
* @throws {Error} When every candidate is reported taken (a lookup that always says yes).
|
|
22
|
+
*/
|
|
23
|
+
export async function uniqueSlug(text, isTaken, options = {}) {
|
|
24
|
+
const separator = options.separator ?? '-';
|
|
25
|
+
const base = slugify(text, options) || options.fallback || 'item';
|
|
26
|
+
if (options.alwaysSuffix) {
|
|
27
|
+
for (let i = 0; i < 5; i++) {
|
|
28
|
+
const candidate = `${base}${separator}${randomSuffix()}`;
|
|
29
|
+
if (!(await isTaken(candidate)))
|
|
30
|
+
return candidate;
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
else {
|
|
34
|
+
if (!(await isTaken(base)))
|
|
35
|
+
return base;
|
|
36
|
+
const maxNumbered = options.maxNumbered ?? 20;
|
|
37
|
+
for (let n = 2; n <= maxNumbered; n++) {
|
|
38
|
+
const candidate = `${base}${separator}${n}`;
|
|
39
|
+
if (!(await isTaken(candidate)))
|
|
40
|
+
return candidate;
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
// Twelve random characters are free on the first try unless the lookup is
|
|
44
|
+
// broken (it says everything is taken): stop and say so instead of spinning.
|
|
45
|
+
for (let i = 0; i < 10; i++) {
|
|
46
|
+
const candidate = `${base}${separator}${randomSuffix()}${randomSuffix()}`;
|
|
47
|
+
if (!(await isTaken(candidate)))
|
|
48
|
+
return candidate;
|
|
49
|
+
}
|
|
50
|
+
throw new Error(`No free slug for "${base}": every candidate was reported taken`);
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* {@link uniqueSlug} checked against a table column through the bonded
|
|
54
|
+
* DataStore (`@molecule/api-database`).
|
|
55
|
+
*
|
|
56
|
+
* @param table - The table, e.g. `'articles'`.
|
|
57
|
+
* @param column - The slug column, e.g. `'slug'`.
|
|
58
|
+
* @param text - The title or name.
|
|
59
|
+
* @param options - As for {@link uniqueSlug}; `excludeId` lets a row keep its own slug on update.
|
|
60
|
+
* @returns A slug no other row of the table uses.
|
|
61
|
+
*/
|
|
62
|
+
export async function uniqueSlugInTable(table, column, text, options = {}) {
|
|
63
|
+
return uniqueSlug(text, async (slug) => {
|
|
64
|
+
const row = await findOne(table, [
|
|
65
|
+
{ field: column, operator: '=', value: slug },
|
|
66
|
+
]);
|
|
67
|
+
// Not found is null from the bonds, undefined from some stores and stubs.
|
|
68
|
+
return row != null && (options.excludeId === undefined || row.id !== options.excludeId);
|
|
69
|
+
}, options);
|
|
70
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,54 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@molecule/api-slug",
|
|
3
|
-
"version": "
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "URL slugs from titles and names: accent-folding slugify, and unique slugs checked against your store (a table column or any lookup).",
|
|
5
|
+
"homepage": "https://www.molecule.dev/packages/api-slug",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"main": "dist/index.js",
|
|
8
|
+
"types": "dist/index.d.ts",
|
|
9
|
+
"scripts": {
|
|
10
|
+
"build": "tsc",
|
|
11
|
+
"test": "vitest run",
|
|
12
|
+
"test:watch": "vitest"
|
|
13
|
+
},
|
|
14
|
+
"exports": {
|
|
15
|
+
".": {
|
|
16
|
+
"types": "./dist/index.d.ts",
|
|
17
|
+
"import": "./dist/index.js"
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
"files": [
|
|
21
|
+
"dist",
|
|
22
|
+
"README.md"
|
|
23
|
+
],
|
|
24
|
+
"keywords": [
|
|
25
|
+
"molecule",
|
|
26
|
+
"slug",
|
|
27
|
+
"slugify",
|
|
28
|
+
"url",
|
|
29
|
+
"permalink"
|
|
30
|
+
],
|
|
31
|
+
"license": "Apache-2.0",
|
|
32
|
+
"repository": {
|
|
33
|
+
"type": "git",
|
|
34
|
+
"url": "https://github.com/molecule-dev/molecule.git",
|
|
35
|
+
"directory": "packages/api/utilities/slug"
|
|
36
|
+
},
|
|
37
|
+
"bugs": "https://github.com/molecule-dev/molecule/issues",
|
|
38
|
+
"publishConfig": {
|
|
39
|
+
"access": "public"
|
|
40
|
+
},
|
|
41
|
+
"devDependencies": {
|
|
42
|
+
"@types/node": "26.1.2",
|
|
43
|
+
"typescript": "6.0.3",
|
|
44
|
+
"vitest": "4.1.11"
|
|
45
|
+
},
|
|
46
|
+
"peerDependencies": {
|
|
47
|
+
"@molecule/api-database": "^1.0.1"
|
|
48
|
+
},
|
|
49
|
+
"peerDependenciesMeta": {
|
|
50
|
+
"@molecule/api-database": {
|
|
51
|
+
"optional": true
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|