setup repo

.gitea/workflows/build-and-publish.yaml

@@ -23,8 +23,8 @@ jobs:
 
       - name: Login to package registry
         run: |
-          npm config set @<scope name>:registry https://gitea.jbrumond.me/api/packages/<scope name>/npm/
-          npm config set -- '//gitea.jbrumond.me/api/packages/<scope name>/npm/:_authToken' "$NPM_PUBLISH_TOKEN"
+          npm config set @js:registry https://gitea.jbrumond.me/api/packages/js/npm/
+          npm config set -- '//gitea.jbrumond.me/api/packages/js/npm/:_authToken' "$NPM_PUBLISH_TOKEN"
 
       - name: Install dependencies
         run: npm ci

.gitea/workflows/build-and-test.yaml

@@ -26,8 +26,8 @@ jobs:
 
       - name: Login to package registry
         run: |
-          npm config set @<scope name>:registry https://gitea.jbrumond.me/api/packages/<scope name>/npm/
-          npm config set -- '//gitea.jbrumond.me/api/packages/<scope name>/npm/:_authToken' "$NPM_PUBLISH_TOKEN"
+          npm config set @js:registry https://gitea.jbrumond.me/api/packages/js/npm/
+          npm config set -- '//gitea.jbrumond.me/api/packages/js/npm/:_authToken' "$NPM_PUBLISH_TOKEN"
 
       - name: Install dependencies
         run: npm ci

package-lock.json

@@ -1,12 +1,12 @@
 {
-  "name": "@templates/typescript-library",
-  "version": "1.0.0",
+  "name": "@js/oidc-login",
+  "version": "0.1.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
-      "name": "@templates/typescript-library",
-      "version": "1.0.0",
+      "name": "@js/oidc-login",
+      "version": "0.1.0",
       "license": "ISC",
       "devDependencies": {
         "typescript": "^5.1.3"

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "@templates/typescript-library",
-  "version": "1.0.0",
-  "description": "Template project for creating new TypeScript library packages",
+  "name": "@js/oidc-login",
+  "version": "0.1.0",
+  "description": "Utilities for implementing OAuth2 / OpenID Connect based login in Node.js services",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {
@@ -13,7 +13,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://gitea.jbrumond.me/templates/typescript-library.git"
+    "url": "https://gitea.jbrumond.me/js/oidc-login.git"
   },
   "author": "James Brumond <https://jbrumond.me>",
   "license": "ISC",

readme.md

@@ -1,30 +1,24 @@
 
-Template project for creating new TypeScript library packages
+Utilities for implementing OAuth2 / OpenID Connect based login in Node.js services
 
 ---
 
-## Get Started
-
-### Pull down the code
+## Install
 
 ```bash
-git init
-git pull https://gitea.jbrumond.me/templates/typescript-library.git master
-```
+# Update project npm config to refer to correct registry for the @js scope
+echo '@js:registry=https://gitea.jbrumond.me/api/packages/js/npm/' >> ./.npmrc
 
-### Update configuration
+npm install --save @js/oidc-login
 
-- In `package.json`, update any fields like `name`, `description`, `repository`, etc.
-- In `.gitea/workflows/publish.yaml`, update `<scope name>` placeholders
-
-
-
-## Building
-
-```bash
-npm run tsc
+# optional - additional supporting typescript definitions
+npm install --save-dev @js/types
 ```
 
 
 
+## Usage
 
+```ts
+import { } from '@js/oidc-login';
+```