@hasna/shortlinks 0.1.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 ADDED
@@ -0,0 +1,152 @@
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 ADDED
@@ -0,0 +1,151 @@
1
+ # @hasna/shortlinks
2
+
3
+ CLI-only shortlink management for custom domains.
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 `@hasna/cloud` sync.
6
+
7
+ [![npm](https://img.shields.io/npm/v/@hasna/shortlinks)](https://www.npmjs.com/package/@hasna/shortlinks)
8
+ [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
9
+
10
+ ## Install
11
+
12
+ ```bash
13
+ bun install -g @hasna/shortlinks
14
+ ```
15
+
16
+ The local database lives at:
17
+
18
+ ```bash
19
+ ~/.hasna/shortlinks/shortlinks.db
20
+ ```
21
+
22
+ ## Quick Start
23
+
24
+ ```bash
25
+ shortlinks init --domain has.na
26
+ shortlinks create https://example.com --slug docs
27
+ shortlinks serve --host 127.0.0.1 --port 8787
28
+ ```
29
+
30
+ Then a request for `https://has.na/docs` redirects to `https://example.com` and records a click.
31
+
32
+ ## Agent-Friendly JSON
33
+
34
+ Every operational command supports `--json`:
35
+
36
+ ```bash
37
+ shortlinks --json create https://example.com --domain has.na
38
+ shortlinks --json link list
39
+ shortlinks --json stats docs --domain has.na
40
+ shortlinks --json doctor
41
+ ```
42
+
43
+ Errors are emitted as:
44
+
45
+ ```json
46
+ { "error": "message" }
47
+ ```
48
+
49
+ ## CLI
50
+
51
+ ```bash
52
+ shortlinks init --domain has.na
53
+ shortlinks domain add has.na --default
54
+ shortlinks domain setup go.example.com --cloudflare --target shortlinks.example.com --dry-run
55
+ shortlinks domain check example.ai
56
+ shortlinks domain buy example.ai --dry-run
57
+
58
+ shortlinks create https://example.com --slug home
59
+ shortlinks link create https://example.com/docs --domain has.na --title Docs
60
+ shortlinks link list
61
+ shortlinks link get home --domain has.na
62
+ shortlinks link disable home --domain has.na
63
+ shortlinks link enable home --domain has.na
64
+ shortlinks stats home --domain has.na
65
+
66
+ shortlinks serve --port 8787
67
+ shortlinks doctor
68
+ ```
69
+
70
+ ## Custom Domains
71
+
72
+ Add as many domains as you need:
73
+
74
+ ```bash
75
+ shortlinks domain add has.na --default
76
+ shortlinks domain add go.example.com --provider cloudflare
77
+ ```
78
+
79
+ Generated links use the default domain unless `--domain` is passed.
80
+
81
+ ## Cloudflare
82
+
83
+ Create a dry-run plan:
84
+
85
+ ```bash
86
+ shortlinks cloudflare plan has.na \
87
+ --target shortlinks.hasna.xyz \
88
+ --origin https://shortlinks.hasna.xyz
89
+ ```
90
+
91
+ Write a Cloudflare Worker that forwards requests to the redirect server while preserving the original host:
92
+
93
+ ```bash
94
+ shortlinks cloudflare worker \
95
+ --worker shortlinks \
96
+ --origin https://shortlinks.hasna.xyz
97
+ ```
98
+
99
+ Upsert DNS when `CLOUDFLARE_API_TOKEN` is available:
100
+
101
+ ```bash
102
+ shortlinks cloudflare dns has.na --target shortlinks.hasna.xyz
103
+ ```
104
+
105
+ ## Buying Domains
106
+
107
+ Domain purchasing goes through the `domains` CLI from `@hasna/domains`:
108
+
109
+ ```bash
110
+ shortlinks domain check new-short-domain.ai
111
+ shortlinks domain buy new-short-domain.ai --dry-run
112
+ ```
113
+
114
+ This package does not install or call any removed `connect-*` packages.
115
+
116
+ ## Cloud Sync
117
+
118
+ `shortlinks` is compatible with `@hasna/cloud` conventions:
119
+
120
+ ```bash
121
+ cloud setup
122
+ shortlinks cloud migrate
123
+ shortlinks cloud push
124
+ shortlinks cloud pull
125
+ shortlinks cloud sync
126
+ ```
127
+
128
+ The cloud database service name is `shortlinks`.
129
+
130
+ ## Development
131
+
132
+ ```bash
133
+ bun install
134
+ bun test
135
+ bun run typecheck
136
+ bun run build
137
+ ```
138
+
139
+ ## Repository
140
+
141
+ The OSS repository is expected to be:
142
+
143
+ ```text
144
+ hasna/shortlinks
145
+ ```
146
+
147
+ The local workspace folder may still be named `open-shortlinks`; the published package and GitHub repo do not use the `open-` prefix.
148
+
149
+ ## License
150
+
151
+ Apache-2.0. See [LICENSE](LICENSE).
package/SECURITY.md ADDED
@@ -0,0 +1,19 @@
1
+ # Security
2
+
3
+ Do not report security issues in public GitHub issues.
4
+
5
+ Email security concerns to:
6
+
7
+ ```text
8
+ andrei@hasna.com
9
+ ```
10
+
11
+ ## Secrets
12
+
13
+ Never commit API tokens, Cloudflare credentials, AWS credentials, database passwords, `.env` files, or local SQLite databases.
14
+
15
+ Use environment variables, the `secrets` CLI, or AWS Secrets Manager for deployment credentials.
16
+
17
+ ## Click Tracking
18
+
19
+ The redirect server hashes IP addresses before storing them. Set `SHORTLINKS_CLICK_SALT` in production so hashes cannot be correlated with local development data.
@@ -0,0 +1,21 @@
1
+ export default {
2
+ async fetch(request, env) {
3
+ const origin = env.SHORTLINKS_ORIGIN;
4
+ if (!origin) {
5
+ return new Response("SHORTLINKS_ORIGIN is not configured", { status: 500 });
6
+ }
7
+
8
+ const incoming = new URL(request.url);
9
+ const upstream = new URL(incoming.pathname + incoming.search, origin);
10
+ const headers = new Headers(request.headers);
11
+ headers.set("x-forwarded-host", incoming.host);
12
+ headers.set("x-shortlinks-worker", "cloudflare");
13
+
14
+ return fetch(upstream.toString(), {
15
+ method: request.method,
16
+ headers,
17
+ body: request.method === "GET" || request.method === "HEAD" ? undefined : request.body,
18
+ redirect: "manual"
19
+ });
20
+ }
21
+ };
@@ -0,0 +1,6 @@
1
+ name = "shortlinks"
2
+ main = "shortlinks.js"
3
+ compatibility_date = "2026-05-01"
4
+
5
+ [vars]
6
+ SHORTLINKS_ORIGIN = "https://shortlinks.hasna.xyz"
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env bun
2
+ export {};