shipseal 0.0.1

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,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Akash Pise
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,61 @@
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/akii09/shipseal/main/assets/brand/wordmark-800.png" alt="Shipseal" width="400">
3
+ </p>
4
+
5
+ <p align="center">
6
+ <strong>Every release, sealed and ready to share.</strong>
7
+ </p>
8
+
9
+ Shipseal turns your repo's releases, milestones, and benchmarks into ready-to-post visuals: OG images, X and LinkedIn cards, GitHub social previews. On brand, at the right size, with **every number verified** from a real source.
10
+
11
+ > Status: **pre-alpha**. Not usable yet. Follow progress at [shipseal.dev](https://shipseal.dev).
12
+
13
+ ## Install
14
+
15
+ ```bash
16
+ npx shipseal init # detect your brand once
17
+ npx shipseal release # generate the release pack
18
+ ```
19
+
20
+ ## How it works
21
+
22
+ ```
23
+ repo facts -> optional AI copy (words only) -> your brand + templates -> Takumi render -> image pack + manifest
24
+ ```
25
+
26
+ Facts come from git, the GitHub API, npm, or your CI. An optional LLM writes words and never numbers, so every figure on a card is listed with its source in `manifest.json`. Rendering uses [Takumi](https://takumi.kane.tw): no headless browser, no image model, deterministic output.
27
+
28
+ ## Commands
29
+
30
+ | Command | What it does |
31
+ |---|---|
32
+ | `shipseal init` | Detect brand (name, tagline, colors, logo, fonts) and write `.shipseal/` |
33
+ | `shipseal release` | Generate the release pack for a tag |
34
+ | `shipseal milestone` | Card for a crossed stars, downloads, or contributors threshold |
35
+ | `shipseal bench` | Before and after cards from a benchmark JSON file |
36
+ | `shipseal doctor` | Check the environment and report fixes |
37
+
38
+ ## GitHub Action
39
+
40
+ ```yaml
41
+ on: { release: { types: [published] } }
42
+ permissions: { contents: write }
43
+ jobs:
44
+ visuals:
45
+ runs-on: ubuntu-latest
46
+ steps:
47
+ - uses: actions/checkout@v4
48
+ with: { fetch-depth: 0 }
49
+ - uses: akii09/shipseal@v1
50
+ env: { GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" }
51
+ ```
52
+
53
+ `fetch-depth: 0` is required: release facts need full history and tags.
54
+
55
+ ## Documentation
56
+
57
+ Full specification in [docs/PROJECT_PLAN.md](https://github.com/akii09/shipseal/blob/main/docs/PROJECT_PLAN.md). Contributions: read [AGENTS.md](https://github.com/akii09/shipseal/blob/main/AGENTS.md) first.
58
+
59
+ ## License
60
+
61
+ MIT. The bundled Geist Mono font is licensed separately under the SIL Open Font License 1.1; see `assets/fonts/OFL.txt`.
Binary file
@@ -0,0 +1,93 @@
1
+ Copyright 2024 The Geist Project Authors (https://github.com/vercel/geist-font)
2
+
3
+ This Font Software is licensed under the SIL Open Font License, Version 1.1.
4
+ This license is copied below, and is also available with a FAQ at:
5
+ https://openfontlicense.org
6
+
7
+
8
+ -----------------------------------------------------------
9
+ SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10
+ -----------------------------------------------------------
11
+
12
+ PREAMBLE
13
+ The goals of the Open Font License (OFL) are to stimulate worldwide
14
+ development of collaborative font projects, to support the font creation
15
+ efforts of academic and linguistic communities, and to provide a free and
16
+ open framework in which fonts may be shared and improved in partnership
17
+ with others.
18
+
19
+ The OFL allows the licensed fonts to be used, studied, modified and
20
+ redistributed freely as long as they are not sold by themselves. The
21
+ fonts, including any derivative works, can be bundled, embedded,
22
+ redistributed and/or sold with any software provided that any reserved
23
+ names are not used by derivative works. The fonts and derivatives,
24
+ however, cannot be released under any other type of license. The
25
+ requirement for fonts to remain under this license does not apply
26
+ to any document created using the fonts or their derivatives.
27
+
28
+ DEFINITIONS
29
+ "Font Software" refers to the set of files released by the Copyright
30
+ Holder(s) under this license and clearly marked as such. This may
31
+ include source files, build scripts and documentation.
32
+
33
+ "Reserved Font Name" refers to any names specified as such after the
34
+ copyright statement(s).
35
+
36
+ "Original Version" refers to the collection of Font Software components as
37
+ distributed by the Copyright Holder(s).
38
+
39
+ "Modified Version" refers to any derivative made by adding to, deleting,
40
+ or substituting -- in part or in whole -- any of the components of the
41
+ Original Version, by changing formats or by porting the Font Software to a
42
+ new environment.
43
+
44
+ "Author" refers to any designer, engineer, programmer, technical
45
+ writer or other person who contributed to the Font Software.
46
+
47
+ PERMISSION & CONDITIONS
48
+ Permission is hereby granted, free of charge, to any person obtaining
49
+ a copy of the Font Software, to use, study, copy, merge, embed, modify,
50
+ redistribute, and sell modified and unmodified copies of the Font
51
+ Software, subject to the following conditions:
52
+
53
+ 1) Neither the Font Software nor any of its individual components,
54
+ in Original or Modified Versions, may be sold by itself.
55
+
56
+ 2) Original or Modified Versions of the Font Software may be bundled,
57
+ redistributed and/or sold with any software, provided that each copy
58
+ contains the above copyright notice and this license. These can be
59
+ included either as stand-alone text files, human-readable headers or
60
+ in the appropriate machine-readable metadata fields within text or
61
+ binary files as long as those fields can be easily viewed by the user.
62
+
63
+ 3) No Modified Version of the Font Software may use the Reserved Font
64
+ Name(s) unless explicit written permission is granted by the corresponding
65
+ Copyright Holder. This restriction only applies to the primary font name as
66
+ presented to the users.
67
+
68
+ 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69
+ Software shall not be used to promote, endorse or advertise any
70
+ Modified Version, except to acknowledge the contribution(s) of the
71
+ Copyright Holder(s) and the Author(s) or with their explicit written
72
+ permission.
73
+
74
+ 5) The Font Software, modified or unmodified, in part or in whole,
75
+ must be distributed entirely under this license, and must not be
76
+ distributed under any other license. The requirement for fonts to
77
+ remain under this license does not apply to any document created
78
+ using the Font Software.
79
+
80
+ TERMINATION
81
+ This license becomes null and void if any of the above conditions are
82
+ not met.
83
+
84
+ DISCLAIMER
85
+ THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88
+ OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89
+ COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90
+ INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91
+ DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92
+ FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93
+ OTHER DEALINGS IN THE FONT SOFTWARE.
@@ -0,0 +1,17 @@
1
+ # Bundled fonts
2
+
3
+ ## GeistMono[wght].ttf
4
+
5
+ Geist Mono, variable weight axis, upstream `vercel/geist-font` release `v1.7.2`.
6
+ Licensed under the SIL Open Font License 1.1. The full license text is in `OFL.txt`
7
+ and must stay next to the font file in any redistribution.
8
+
9
+ Takumi bundles Geist (sans) at weights 300 to 800 but **not** Geist Mono, verified in
10
+ spike S4 (`docs/spikes/2026-09-11-takumi-s1-s2-s4.md`). The code card and the
11
+ `brand.fonts.mono` default both need a mono face, so Shipseal ships one.
12
+
13
+ One variable file covers every weight: rendering weights 300 through 900 produced
14
+ seven distinct outputs, so there is no reason to ship static instances.
15
+
16
+ To upgrade, take the file from a tagged upstream release, update the version above,
17
+ and re-run the golden image tests.
package/dist/cli.js ADDED
@@ -0,0 +1,13 @@
1
+ #!/usr/bin/env node
2
+ //#region src/cli.ts
3
+ process.stdout.write([
4
+ "shipseal is pre-alpha and not usable yet.",
5
+ "",
6
+ "This release exists to reserve the package name. No commands are implemented.",
7
+ `Follow progress at https://shipseal.dev`,
8
+ ""
9
+ ].join("\n"));
10
+
11
+ //#endregion
12
+ export { };
13
+ //# sourceMappingURL=cli.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cli.js","names":[],"sources":["../src/cli.ts"],"sourcesContent":["#!/usr/bin/env node\n// CLI entry: parse args, dispatch to commands/*\n// Spec: docs/PROJECT_PLAN.md §18\n// Placeholder until the commands land. Keep this honest: it must not pretend to work.\n\nconst HOMEPAGE = \"https://shipseal.dev\";\n\nprocess.stdout.write(\n [\n \"shipseal is pre-alpha and not usable yet.\",\n \"\",\n \"This release exists to reserve the package name. No commands are implemented.\",\n `Follow progress at ${HOMEPAGE}`,\n \"\",\n ].join(\"\\n\"),\n);\n"],"mappings":";;AAOA,QAAQ,OAAO,MACb;CACE;CACA;CACA;CACA;CACA;AACF,CAAC,CAAC,KAAK,IAAI,CACb"}
package/package.json ADDED
@@ -0,0 +1,47 @@
1
+ {
2
+ "name": "shipseal",
3
+ "version": "0.0.1",
4
+ "description": "Every release, sealed and ready to share. Verified release visuals from your repo.",
5
+ "license": "MIT",
6
+ "type": "module",
7
+ "bin": {
8
+ "shipseal": "./dist/cli.js"
9
+ },
10
+ "files": [
11
+ "dist",
12
+ "assets"
13
+ ],
14
+ "engines": {
15
+ "node": ">=22"
16
+ },
17
+ "homepage": "https://shipseal.dev",
18
+ "repository": {
19
+ "type": "git",
20
+ "url": "git+https://github.com/akii09/shipseal.git",
21
+ "directory": "packages/shipseal"
22
+ },
23
+ "keywords": [
24
+ "release",
25
+ "og-image",
26
+ "social-cards",
27
+ "changelog",
28
+ "github-action",
29
+ "takumi"
30
+ ],
31
+ "scripts": {
32
+ "build": "tsdown",
33
+ "test": "vitest run",
34
+ "test:update-golden": "UPDATE_GOLDEN=1 vitest run test/golden",
35
+ "typecheck": "tsc --noEmit"
36
+ },
37
+ "devDependencies": {
38
+ "@types/node": "^22.20.2",
39
+ "tsdown": "^0.23.0",
40
+ "typescript": "^7.0.2",
41
+ "vitest": "^5.0.0"
42
+ },
43
+ "dependencies": {
44
+ "takumi-js": "2.13.7",
45
+ "zod": "4.6.2"
46
+ }
47
+ }