feat: documentation and github action to publish jsr

.github/workflows/build-test.yaml

@@ -1,6 +1,8 @@
 name: Build and Test
 on:
   push:
+    branches-ignore:
+      - main
 
 jobs:
   build:

.github/workflows/publish.yaml

@@ -0,0 +1,41 @@
+name: Publish JSR
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        node-version: [20]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build
+        run: pnpm run build
+      - name: Test
+        run: pnpm run test
+
+  publish:
+    runs-on: ubuntu-latest
+    environment: Production
+    needs: build
+    permissions:
+      contents: read
+      id-token: write # The OIDC ID token is used for authentication with JSR.
+    steps:
+      - uses: actions/checkout@v4
+      - run: npx jsr publish

jsr.json

@@ -1,8 +1,15 @@
 {
 	"name": "@rathod-sahaab/http-result",
-	"version": "0.5.0",
+	"version": "0.5.1",
 	"exports": {
 		".": "./src/index.ts"
 		"./ts-rest": "./src/ts-rest/index.ts"
-	}
+	},
+  "publish": {
+    "include": [
+      "LICENSE",
+      "README.md",
+      "src/**/*.ts"
+    ]
+  }
 }

src/functions.ts

@@ -2,9 +2,24 @@ import { HTTP_ERRORS } from './http.constants'
 import { IHttpErrorKind } from './http.types'
 import { ErrPayload, ErrType, Result, Success } from './types'
 
+/**
+ * Helper function to easily create result success type from object
+ *
+ * ```ts
+ * return Ok({value: 5})
+ * ```
+ */
 export function Ok<T>(value: T): Success<T> {
 	return [value, null]
 }
+
+/**
+ * Helper function to easily create result error type from object
+ *
+ * ```ts
+ * return Err('BadRequest', 'Article Too long.')
+ * ```
+ */
 export function Err<E extends IHttpErrorKind>(
 	kind: E,
 	message: string,
@@ -56,6 +71,13 @@ type IHttpErrorResultFnsMap = {
 	) => Result<T, K>
 }
 
+/**
+ * Object containing formatter functions to get ErrPayload
+ *
+ * Each function has:
+ * @param message Message describing error
+ * @param baseError? Optional: Underlying error that made you create a new error, for something like a stack trace
+ */
 export const HttpErrors: IHttpErrorFnsMap = (
 	Object.keys(HTTP_ERRORS) as IHttpErrorKind[]
 ).reduce<Partial<IHttpErrorFnsMap>>((acc, curr) => {
@@ -65,6 +87,14 @@ export const HttpErrors: IHttpErrorFnsMap = (
 	}
 }, {}) as IHttpErrorFnsMap
 
+/**
+ * Same as HttpErrors but for creating result type directly
+ * Object containing formatter functions to get Result
+ *
+ * Each function has:
+ * @param message Message describing error
+ * @param baseError? Optional: Underlying error that made you create a new error, for something like a stack trace
+ */
 export const HttpErrorResults: IHttpErrorResultFnsMap = (
 	Object.keys(HTTP_ERRORS) as IHttpErrorKind[]
 ).reduce<Partial<IHttpErrorResultFnsMap>>((acc, curr) => {

src/ts-rest/index.ts

@@ -25,6 +25,9 @@ export type ITsRestError<S extends IHttpErrorStatus> = {
 	}
 }
 
+/**
+ * Format http-result error type into a valid ts-rest response
+ */
 export function tsRestError<E extends IHttpErrorKind>(
 	err: ErrPayload<E>,
 ): ITsRestError<IHttpErrorStatusSpecific<E>> {
@@ -67,6 +70,11 @@ type ITsRestResponseFnsMap = {
 			: never
 }
 
+/**
+ * Format ouput into ts-rest reponse, define status code with function name.
+ * Error functions expect a message string, success response functions can
+ * anything.
+ */
 export const TsRestResponse: ITsRestResponseFnsMap = (
 	Object.keys(HTTP) as IHttpKind[]
 ).reduce<Partial<ITsRestResponseFnsMap>>((acc, curr) => {