@hasna/shortlinks 0.1.11 → 0.1.13
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 +152 -191
- package/README.md +21 -18
- package/cloudflare/shortlinks.js +9 -0
- package/cloudflare/wrangler.example.toml +2 -1
- package/dist/cli/index.js +6055 -764
- package/dist/cloudflare.js +10 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +5412 -81
- package/dist/pg-migrate.d.ts +7 -0
- package/dist/pg-store.d.ts +2 -1
- package/dist/remote-storage.d.ts +11 -0
- package/dist/server.d.ts +1 -0
- package/dist/server.js +4 -0
- package/dist/storage-config.d.ts +37 -0
- package/dist/storage-sync.d.ts +36 -0
- package/dist/storage.d.ts +6 -0
- package/dist/storage.js +5539 -0
- package/infra/aws-ec2-user-data.sh +38 -16
- package/package.json +11 -6
package/LICENSE
CHANGED
|
@@ -1,191 +1,152 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
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
|
-
Copyright 2026 Hasna, Inc.
|
|
180
|
-
|
|
181
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
|
182
|
-
you may not use this file except in compliance with the License.
|
|
183
|
-
You may obtain a copy of the License at
|
|
184
|
-
|
|
185
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
186
|
-
|
|
187
|
-
Unless required by applicable law or agreed to in writing, software
|
|
188
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
|
189
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
190
|
-
See the License for the specific language governing permissions and
|
|
191
|
-
limitations under the License.
|
|
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, and
|
|
10
|
+
distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by the copyright
|
|
13
|
+
owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all other entities
|
|
16
|
+
that control, are controlled by, or are under common control with that entity.
|
|
17
|
+
For the purposes of this definition, "control" means (i) the power, direct or
|
|
18
|
+
indirect, to cause the direction or management of such entity, whether by
|
|
19
|
+
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
20
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
21
|
+
|
|
22
|
+
"You" (or "Your") shall mean an individual or Legal Entity exercising
|
|
23
|
+
permissions granted by this License.
|
|
24
|
+
|
|
25
|
+
"Source" form shall mean the preferred form for making modifications, including
|
|
26
|
+
but not limited to software source code, documentation source, and configuration
|
|
27
|
+
files.
|
|
28
|
+
|
|
29
|
+
"Object" form shall mean any form resulting from mechanical transformation or
|
|
30
|
+
translation of a Source form, including but not limited to compiled object code,
|
|
31
|
+
generated documentation, and conversions to other media types.
|
|
32
|
+
|
|
33
|
+
"Work" shall mean the work of authorship, whether in Source or Object form,
|
|
34
|
+
made available under the License, as indicated by a copyright notice that is
|
|
35
|
+
included in or attached to the work.
|
|
36
|
+
|
|
37
|
+
"Derivative Works" shall mean any work, whether in Source or Object form, that
|
|
38
|
+
is based on or derived from the Work and for which the editorial revisions,
|
|
39
|
+
annotations, elaborations, or other modifications represent, as a whole, an
|
|
40
|
+
original work of authorship. For the purposes of this License, Derivative Works
|
|
41
|
+
shall not include works that remain separable from, or merely link (or bind by
|
|
42
|
+
name) to the interfaces of, the Work and Derivative Works thereof.
|
|
43
|
+
|
|
44
|
+
"Contribution" shall mean any work of authorship, including the original version
|
|
45
|
+
of the Work and any modifications or additions to that Work or Derivative Works
|
|
46
|
+
thereof, that is intentionally submitted to Licensor for inclusion in the Work
|
|
47
|
+
by the copyright owner or by an individual or Legal Entity authorized to submit
|
|
48
|
+
on behalf of the copyright owner. For the purposes of this definition,
|
|
49
|
+
"submitted" means any form of electronic, verbal, or written communication sent
|
|
50
|
+
to the Licensor or its representatives, including but not limited to
|
|
51
|
+
communication on electronic mailing lists, source code control systems, and
|
|
52
|
+
issue tracking systems that are managed by, or on behalf of, the Licensor for
|
|
53
|
+
the purpose of discussing and improving the Work, but excluding communication
|
|
54
|
+
that is conspicuously marked or otherwise designated in writing by the copyright
|
|
55
|
+
owner as "Not a Contribution."
|
|
56
|
+
|
|
57
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
|
|
58
|
+
of whom a Contribution has been received by Licensor and subsequently
|
|
59
|
+
incorporated within the Work.
|
|
60
|
+
|
|
61
|
+
2. Grant of Copyright License. Subject to the terms and conditions of this
|
|
62
|
+
License, each Contributor hereby grants to You a perpetual, worldwide,
|
|
63
|
+
non-exclusive, no-charge, royalty-free, irrevocable copyright license to
|
|
64
|
+
reproduce, prepare Derivative Works of, publicly display, publicly perform,
|
|
65
|
+
sublicense, and distribute the Work and such Derivative Works in Source or
|
|
66
|
+
Object form.
|
|
67
|
+
|
|
68
|
+
3. Grant of Patent License. Subject to the terms and conditions of this License,
|
|
69
|
+
each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
|
|
70
|
+
no-charge, royalty-free, irrevocable patent license to make, have made, use,
|
|
71
|
+
offer to sell, sell, import, and otherwise transfer the Work, where such license
|
|
72
|
+
applies only to those patent claims licensable by such Contributor that are
|
|
73
|
+
necessarily infringed by their Contribution alone or by combination of their
|
|
74
|
+
Contribution with the Work to which such Contribution was submitted. If You
|
|
75
|
+
institute patent litigation against any entity alleging that the Work or a
|
|
76
|
+
Contribution incorporated within the Work constitutes direct or contributory
|
|
77
|
+
patent infringement, then any patent licenses granted to You under this License
|
|
78
|
+
for that Work shall terminate as of the date such litigation is filed.
|
|
79
|
+
|
|
80
|
+
4. Redistribution. You may reproduce and distribute copies of the Work or
|
|
81
|
+
Derivative Works thereof in any medium, with or without modifications, and in
|
|
82
|
+
Source or Object form, provided that You meet the following conditions:
|
|
83
|
+
|
|
84
|
+
(a) You must give any other recipients of the Work or Derivative Works a copy of
|
|
85
|
+
this License; and
|
|
86
|
+
|
|
87
|
+
(b) You must cause any modified files to carry prominent notices stating that
|
|
88
|
+
You changed the files; and
|
|
89
|
+
|
|
90
|
+
(c) You must retain, in the Source form of any Derivative Works that You
|
|
91
|
+
distribute, all copyright, patent, trademark, and attribution notices from the
|
|
92
|
+
Source form of the Work, excluding those notices that do not pertain to any part
|
|
93
|
+
of the Derivative Works; and
|
|
94
|
+
|
|
95
|
+
(d) If the Work includes a "NOTICE" text file as part of its distribution, then
|
|
96
|
+
any Derivative Works that You distribute must include a readable copy of the
|
|
97
|
+
attribution notices contained within such NOTICE file, excluding those notices
|
|
98
|
+
that do not pertain to any part of the Derivative Works, in at least one of the
|
|
99
|
+
following places: within a NOTICE text file distributed as part of the Derivative
|
|
100
|
+
Works; within the Source form or documentation, if provided along with the
|
|
101
|
+
Derivative Works; or within a display generated by the Derivative Works, if and
|
|
102
|
+
wherever such third-party notices normally appear. The contents of the NOTICE
|
|
103
|
+
file are for informational purposes only and do not modify the License. You may
|
|
104
|
+
add Your own attribution notices within Derivative Works that You distribute,
|
|
105
|
+
alongside or as an addendum to the NOTICE text from the Work, provided that such
|
|
106
|
+
additional attribution notices cannot be construed as modifying the License.
|
|
107
|
+
|
|
108
|
+
You may add Your own copyright statement to Your modifications and may provide
|
|
109
|
+
additional or different license terms and conditions for use, reproduction, or
|
|
110
|
+
distribution of Your modifications, or for any such Derivative Works as a whole,
|
|
111
|
+
provided Your use, reproduction, and distribution of the Work otherwise complies
|
|
112
|
+
with the conditions stated in this License.
|
|
113
|
+
|
|
114
|
+
5. Submission of Contributions. Unless You explicitly state otherwise, any
|
|
115
|
+
Contribution intentionally submitted for inclusion in the Work by You to the
|
|
116
|
+
Licensor shall be under the terms and conditions of this License, without any
|
|
117
|
+
additional terms or conditions. Notwithstanding the above, nothing herein shall
|
|
118
|
+
supersede or modify the terms of any separate license agreement you may have
|
|
119
|
+
executed with Licensor regarding such Contributions.
|
|
120
|
+
|
|
121
|
+
6. Trademarks. This License does not grant permission to use the trade names,
|
|
122
|
+
trademarks, service marks, or product names of the Licensor, except as required
|
|
123
|
+
for reasonable and customary use in describing the origin of the Work and
|
|
124
|
+
reproducing the content of the NOTICE file.
|
|
125
|
+
|
|
126
|
+
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
|
|
127
|
+
writing, Licensor provides the Work on an "AS IS" BASIS, WITHOUT WARRANTIES OR
|
|
128
|
+
CONDITIONS OF ANY KIND, either express or implied, including, without limitation,
|
|
129
|
+
any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or
|
|
130
|
+
FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
131
|
+
appropriateness of using or redistributing the Work and assume any risks
|
|
132
|
+
associated with Your exercise of permissions under this License.
|
|
133
|
+
|
|
134
|
+
8. Limitation of Liability. In no event and under no legal theory, whether in
|
|
135
|
+
tort (including negligence), contract, or otherwise, unless required by
|
|
136
|
+
applicable law or agreed to in writing, shall any Contributor be liable to You
|
|
137
|
+
for damages, including any direct, indirect, special, incidental, or
|
|
138
|
+
consequential damages arising as a result of this License or out of the use or
|
|
139
|
+
inability to use the Work, even if such Contributor has been advised of the
|
|
140
|
+
possibility of such damages.
|
|
141
|
+
|
|
142
|
+
9. Accepting Warranty or Additional Liability. While redistributing the Work or
|
|
143
|
+
Derivative Works thereof, You may choose to offer, and charge a fee for,
|
|
144
|
+
acceptance of support, warranty, indemnity, or other liability obligations
|
|
145
|
+
and/or rights consistent with this License. However, in accepting such
|
|
146
|
+
obligations, You may act only on Your own behalf and on Your sole
|
|
147
|
+
responsibility, not on behalf of any other Contributor, and only if You agree to
|
|
148
|
+
indemnify, defend, and hold each Contributor harmless for any liability incurred
|
|
149
|
+
by, or claims asserted against, such Contributor by reason of your accepting any
|
|
150
|
+
such warranty or additional liability.
|
|
151
|
+
|
|
152
|
+
END OF TERMS AND CONDITIONS
|
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
CLI-only shortlink management for custom domains.
|
|
4
4
|
|
|
5
|
-
`shortlinks` creates Bitly-style short URLs, supports multiple domains, records click analytics, can run a tiny redirect server, and includes helper commands for Cloudflare DNS/Workers, `@hasna/domains`, and
|
|
5
|
+
`shortlinks` creates Bitly-style short URLs, supports multiple domains, records click analytics, can run a tiny redirect server, and includes helper commands for Cloudflare DNS/Workers, `@hasna/domains`, and package-native storage sync. Production serving can run directly against the shared RDS database with `--remote`; local SQLite is only for explicit local/offline use.
|
|
6
6
|
|
|
7
7
|
[](https://www.npmjs.com/package/@hasna/shortlinks)
|
|
8
8
|
[](LICENSE)
|
|
@@ -64,7 +64,7 @@ shortlinks link enable home --domain has.na
|
|
|
64
64
|
shortlinks stats home --domain has.na
|
|
65
65
|
|
|
66
66
|
shortlinks serve --port 8787
|
|
67
|
-
shortlinks serve --
|
|
67
|
+
shortlinks serve --remote --port 8787
|
|
68
68
|
shortlinks doctor
|
|
69
69
|
```
|
|
70
70
|
|
|
@@ -96,8 +96,8 @@ Create a dry-run plan:
|
|
|
96
96
|
|
|
97
97
|
```bash
|
|
98
98
|
shortlinks cloudflare plan has.na \
|
|
99
|
-
--target shortlinks.
|
|
100
|
-
--origin https://shortlinks.
|
|
99
|
+
--target shortlinks.example.com \
|
|
100
|
+
--origin https://shortlinks.example.com
|
|
101
101
|
```
|
|
102
102
|
|
|
103
103
|
Write a Cloudflare Worker that forwards requests to the redirect server while preserving the original host:
|
|
@@ -105,13 +105,13 @@ Write a Cloudflare Worker that forwards requests to the redirect server while pr
|
|
|
105
105
|
```bash
|
|
106
106
|
shortlinks cloudflare worker \
|
|
107
107
|
--worker shortlinks \
|
|
108
|
-
--origin https://shortlinks.
|
|
108
|
+
--origin https://shortlinks.example.com
|
|
109
109
|
```
|
|
110
110
|
|
|
111
111
|
Upsert DNS when `CLOUDFLARE_API_TOKEN` is available. Global API key auth is also supported with `CLOUDFLARE_API_KEY` plus `CLOUDFLARE_EMAIL`.
|
|
112
112
|
|
|
113
113
|
```bash
|
|
114
|
-
shortlinks cloudflare dns has.na --target shortlinks.
|
|
114
|
+
shortlinks cloudflare dns has.na --target shortlinks.example.com
|
|
115
115
|
```
|
|
116
116
|
|
|
117
117
|
## Buying Domains
|
|
@@ -125,25 +125,28 @@ shortlinks domain buy new-short-domain.ai --dry-run
|
|
|
125
125
|
|
|
126
126
|
This package does not install or call any removed `connect-*` packages.
|
|
127
127
|
|
|
128
|
-
##
|
|
128
|
+
## Storage Sync
|
|
129
129
|
|
|
130
|
-
|
|
130
|
+
Storage sync is optional and implemented inside this package:
|
|
131
131
|
|
|
132
132
|
```bash
|
|
133
|
-
|
|
134
|
-
shortlinks
|
|
135
|
-
shortlinks
|
|
136
|
-
shortlinks
|
|
137
|
-
shortlinks cloud sync
|
|
133
|
+
shortlinks storage migrate
|
|
134
|
+
shortlinks storage push
|
|
135
|
+
shortlinks storage pull
|
|
136
|
+
shortlinks storage sync
|
|
138
137
|
```
|
|
139
138
|
|
|
140
|
-
|
|
139
|
+
For production storage, set `HASNA_SHORTLINKS_DATABASE_URL` or configure
|
|
140
|
+
`~/.hasna/shortlinks/storage/config.json` to run in hybrid/remote mode with
|
|
141
|
+
PostgreSQL. `SHORTLINKS_DATABASE_URL` remains supported as a rollback/local
|
|
142
|
+
fallback. The storage database service name is `shortlinks`.
|
|
143
|
+
Programmatic storage helpers are available from `@hasna/shortlinks/storage`.
|
|
141
144
|
Use direct RDS mode for production and live management:
|
|
142
145
|
|
|
143
146
|
```bash
|
|
144
|
-
shortlinks --
|
|
145
|
-
shortlinks --
|
|
146
|
-
shortlinks serve --
|
|
147
|
+
shortlinks --remote create https://example.com
|
|
148
|
+
shortlinks --remote link list
|
|
149
|
+
shortlinks serve --remote --host 127.0.0.1 --port 8787
|
|
147
150
|
```
|
|
148
151
|
|
|
149
152
|
## AWS Origin
|
|
@@ -151,7 +154,7 @@ shortlinks serve --cloud --host 127.0.0.1 --port 8787
|
|
|
151
154
|
For an apex domain that needs stable A records, `infra/aws-ec2-user-data.sh` bootstraps a small EC2 redirect origin with:
|
|
152
155
|
|
|
153
156
|
- `@hasna/shortlinks` installed through Bun
|
|
154
|
-
- direct reads and click writes against the `shortlinks` RDS database through
|
|
157
|
+
- direct reads and click writes against the `shortlinks` RDS database through the package-native PostgreSQL store
|
|
155
158
|
- Caddy terminating HTTPS and proxying to `shortlinks serve`
|
|
156
159
|
|
|
157
160
|
The script reads the RDS password from AWS Secrets Manager through the instance role; it does not contain secret values.
|
package/cloudflare/shortlinks.js
CHANGED
|
@@ -6,6 +6,15 @@ export default {
|
|
|
6
6
|
}
|
|
7
7
|
|
|
8
8
|
const incoming = new URL(request.url);
|
|
9
|
+
const reserved = (env.SHORTLINKS_RESERVED_PATH_PREFIXES || "a")
|
|
10
|
+
.split(",")
|
|
11
|
+
.map((value) => value.trim().toLowerCase())
|
|
12
|
+
.filter(Boolean);
|
|
13
|
+
const firstSegment = decodeURIComponent(incoming.pathname.replace(/^\/+/, "").split("/")[0] || "").toLowerCase();
|
|
14
|
+
if (firstSegment && reserved.includes(firstSegment)) {
|
|
15
|
+
return new Response("Reserved path prefix", { status: 404 });
|
|
16
|
+
}
|
|
17
|
+
|
|
9
18
|
const upstream = new URL(incoming.pathname + incoming.search, origin);
|
|
10
19
|
const headers = new Headers(request.headers);
|
|
11
20
|
headers.set("x-forwarded-host", incoming.host);
|