chore: add release workflow and update exports

Author: gmaclennan

.github/workflows/release.yml

@@ -0,0 +1,60 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      semver:
+        description: "The semver to use"
+        required: true
+        default: "auto"
+        type: choice
+        options:
+          - auto
+          - patch
+          - minor
+          - major
+          - prerelease
+          - prepatch
+          - preminor
+          - premajor
+  pull_request:
+    types: [closed]
+
+jobs:
+  release:
+    if: >-
+      ${{
+        (
+          startsWith(github.event.inputs.semver, 'pre') ||
+          github.ref == format(
+            'refs/heads/{0}',
+            github.event.repository.default_branch
+          )
+        ) &&
+        (
+          github.event_name != 'pull_request' ||
+          github.event.pull_request.user.login == 'optic-release-automation[bot]'
+        )
+      }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+      id-token: write
+    steps:
+      - uses: nearform-actions/optic-release-automation-action@9e3518763346efacba15d729d0faaa4cbd8fdd52 # v4.12.3
+        with:
+          commit-message: "Release {version}"
+          sync-semver-tags: false
+          access: "public"
+          # This prefix is added before the prerelease number, e.g. `v3.0.0-pre.0`
+          prerelease-prefix: "pre"
+          semver: ${{ github.event.inputs.semver }}
+          # Prereleases are published under the `next` npm dist-tag
+          npm-tag: ${{ startsWith(github.event.inputs.semver, 'pre') && 'next' || 'latest' }}
+          # Don't notify linked issues
+          notify-linked-issues: false
+          publish-mode: oidc
+          build-command: |
+            npm ci

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"name": "@comapeo/map-server",
-	"version": "1.0.0",
+	"version": "1.0.0-pre.0",
 	"type": "module",
 	"exports": {
 		".": {
@@ -13,10 +13,11 @@
 		"test:js": "vitest run",
 		"test:lint": "eslint",
 		"test:types": "tsc --noEmit",
+		"test:publint": "npm run build && publint",
 		"format": "prettier --write .",
-		"prepare": "husky",
-		"prepack": "tsc -p tsconfig.npm.json",
-		"postinstall": "patch-package"
+		"prepare": "husky && patch-package",
+		"build": "tsc -p tsconfig.npm.json",
+		"prepack": "run-s test build"
 	},
 	"keywords": [],
 	"author": "",
@@ -40,6 +41,7 @@
 		"npm-run-all2": "^7.0.2",
 		"patch-package": "^8.0.1",
 		"prettier": "^3.7.4",
+		"publint": "^0.3.17",
 		"type-fest": "^5.3.1",
 		"typescript": "^5.9.3",
 		"typescript-eslint": "^8.53.1",

package.json

@@ -16,6 +16,21 @@ import { fetchAPI } from './lib/fetch-api.js'
 import { RootRouter } from './routes/root.js'
 import type { FetchContext } from './types.js'
 
+export { errors } from './lib/errors.js'
+
+export type {
+	MapInfo,
+	MapShareState,
+	MapShareStateUpdate,
+	DownloadStateUpdate,
+} from './types.js'
+export type { DownloadState } from './lib/download-request.js'
+export type {
+	MapShareCreateParams,
+	MapShareDeclineParams,
+} from './routes/map-shares.js'
+export type { DownloadCreateParams } from './routes/downloads.js'
+
 export type ServerOptions = {
 	defaultOnlineStyleUrl: string | URL
 	customMapPath: string | URL

src/index.ts

@@ -2,21 +2,21 @@ import { Agent as SecretStreamAgent } from 'secret-stream-http'
 import z32 from 'z32'
 
 import { TypedEventTarget } from '../lib/event-target.js'
-import type { DownloadCreateRequest } from '../routes/downloads.js'
+import type { DownloadCreateParams } from '../routes/downloads.js'
 import { type DownloadStateUpdate } from '../types.js'
 import { StatusError } from './errors.js'
 import { errors, jsonError } from './errors.js'
 import { secretStreamFetch } from './secret-stream-fetch.js'
 import { StateUpdateEvent } from './state-update-event.js'
 import { addTrailingSlash, generateId, getErrorCode, noop } from './utils.js'
 
-type DownloadRequestState = DownloadStateUpdate &
-	Omit<DownloadCreateRequest, 'mapShareUrls'> & { downloadId: string }
+export type DownloadState = DownloadStateUpdate &
+	Omit<DownloadCreateParams, 'mapShareUrls'> & { downloadId: string }
 
 export class DownloadRequest extends TypedEventTarget<
 	InstanceType<typeof StateUpdateEvent<DownloadStateUpdate>>
 > {
-	#state: DownloadRequestState
+	#state: DownloadState
 	#abortController = new AbortController()
 	#transform = new TransformStream({
 		transform: (chunk, controller) => {
@@ -34,7 +34,7 @@ export class DownloadRequest extends TypedEventTarget<
 
 	constructor(
 		stream: WritableStream<Uint8Array>,
-		{ mapShareUrls, ...rest }: DownloadCreateRequest,
+		{ mapShareUrls, ...rest }: DownloadCreateParams,
 		keyPair: { publicKey: Uint8Array; secretKey: Uint8Array },
 	) {
 		super()

src/lib/download-request.ts

@@ -26,7 +26,7 @@ const DownloadCreateRequest = T.Object({
 	estimatedSizeBytes: EstimatedSizeBytes,
 })
 
-export type DownloadCreateRequest = Static<typeof DownloadCreateRequest>
+export type DownloadCreateParams = Static<typeof DownloadCreateRequest>
 
 export function DownloadsRouter(
 	{ base }: { base: string },

src/routes/downloads.ts

@@ -30,6 +30,8 @@ const MapShareCreateRequest = T.Object({
 	receiverDeviceId: T.String({ minLength: 1 }),
 })
 
+export type MapShareCreateParams = Static<typeof MapShareCreateRequest>
+
 const LocalMapShareDeclineRequest = T.Object({
 	reason: MapShareDeclineReason,
 	mapShareUrls: MapShareUrls,
@@ -39,6 +41,8 @@ const LocalMapShareDeclineRequest = T.Object({
 	}),
 })
 
+export type MapShareDeclineParams = Static<typeof LocalMapShareDeclineRequest>
+
 const RemoteMapShareDeclineRequest = T.Object({
 	reason: MapShareDeclineReason,
 })