@nusgaops/sgauth 0.0.0 → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to `@nusgaops/sgauth` are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0]
+
+- Initial package scaffold and release pipeline. No public API beyond `version`.

package/README.md

@@ -0,0 +1,41 @@
+# @nusgaops/sgauth
+
+Client SDK for SGAuth, the SGA Operations single sign-on service.
+
+## Install
+
+```bash
+npm install @nusgaops/sgauth
+```
+
+The package is on the public npm registry, so no `.npmrc` or token is needed.
+
+## Requirements
+
+- Node.js 20 or later
+- ESM (`import`) or CommonJS (`require`); both ship with types
+
+## Status
+
+Pre-1.0. The package currently exports only `version`; the session API lands in #3 and #4.
+
+## Releasing
+
+1. Bump `version` in `package.json` and add a matching `## [X.Y.Z]` section to `CHANGELOG.md`.
+2. Merge to `main`.
+3. Tag the merged commit and push the tag:
+
+   ```bash
+   git tag vX.Y.Z <main sha>
+   git push origin vX.Y.Z
+   ```
+
+4. A prerelease version (`X.Y.Z-beta.N`) publishes to the `next` dist-tag instead of `latest`.
+
+`.github/workflows/release.yml` publishes through npm trusted publishing (GitHub OIDC), so there is no npm token anywhere. The release fails before publishing if:
+
+- the tag does not point at a commit on `main`
+- any check fails
+- the tag is not `v` followed by the `package.json` version
+- `CHANGELOG.md` has no section for the version
+- the version is already published, or the registry cannot be read

package/dist/index.cjs

@@ -0,0 +1,31 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  version: () => version
+});
+module.exports = __toCommonJS(index_exports);
+var version = "0.1.0";
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  version
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/** The version of `@nusgaops/sgauth` in use, as published to npm. */\nexport const version: string = __SGAUTH_SDK_VERSION__;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACO,IAAM,UAAkB;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,4 @@
+/** The version of `@nusgaops/sgauth` in use, as published to npm. */
+declare const version: string;
+
+export { version };

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+/** The version of `@nusgaops/sgauth` in use, as published to npm. */
+declare const version: string;
+
+export { version };

package/dist/index.js

@@ -0,0 +1,6 @@
+// src/index.ts
+var version = "0.1.0";
+export {
+  version
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/** The version of `@nusgaops/sgauth` in use, as published to npm. */\nexport const version: string = __SGAUTH_SDK_VERSION__;\n"],"mappings":";AACO,IAAM,UAAkB;","names":[]}

package/package.json

@@ -1,13 +1,66 @@
 {
   "name": "@nusgaops/sgauth",
-  "version": "0.0.0",
-  "description": "Placeholder that reserves the package name for trusted publishing. Use 0.1.0 or later.",
+  "version": "0.1.0",
+  "description": "Client SDK for SGAuth, the SGA Operations single sign-on service",
   "license": "UNLICENSED",
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/SGAOperations/auth-sdk.git"
   },
+  "homepage": "https://github.com/SGAOperations/auth-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/SGAOperations/auth-sdk/issues"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "typecheck": "tsc --noEmit",
+    "check:package": "npm run build && publint --strict && attw --pack ."
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^20.19.43",
+    "eslint": "^10.13.0",
+    "globals": "^17.13.0",
+    "prettier": "^3.9.10",
+    "publint": "^0.3.25",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.72.0",
+    "vitest": "^4.1.12"
   }
 }