@digiteers/uloba3-sdk 1.3.8 → 1.3.9

package/README.md

@@ -1,53 +1,37 @@
-# Uloba3 SDK
+# @digiteers/uloba3-sdk
 
-TypeScript SDK for Uloba3 API - Autogenerert fra OpenAPI spesifikasjon.
+TypeScript SDK for Uloba3 API - Auto-generert fra OpenAPI spesifikasjon og publisert til npm.
 
 ## 🎯 Formål
 
-Dette SDK-et er et separat repository som inneholder TypeScript-klient for Uloba3 API. SDK-et genereres automatisk fra API-ets OpenAPI spesifikasjon og gir type-safe tilgang til alle API endpoints.
+Dette SDK-et gir type-safe tilgang til Uloba3 API. SDK-et genereres automatisk fra API-ets OpenAPI spesifikasjon og publiseres som en privat npm-pakke.
 
-### Hvorfor separat repository?
-- **Uavhengighet**: SDK kan oppdateres uten å påvirke backend
-- **Enklere versjonering**: SDK har sin egen versjon lifecycle
-- **Renere arkitektur**: Reduserer kompleksitet i både backend og frontend
-- **Fleksibilitet**: Web-prosjektet velger selv når de vil oppdatere SDK
+## 📦 Installasjon
 
-## 📦 Arkitektur
+```bash
+# I uloba3-web eller andre prosjekter
+pnpm add @digiteers/uloba3-sdk@latest
 
-```
-uloba3-sdk/                 # Dette repository
-├── src/                    # Kildekode
-│   ├── api/               # API moduler
-│   ├── types.ts           # Genererte typer fra OpenAPI
-│   └── client.ts          # API klient
-├── dist/                  # Kompilert JavaScript (genereres)
-└── *.tgz                  # Pakket versjon (genereres)
-
-uloba3-backend/            # API som SDK genereres fra
-└── apps/api/              # FastAPI applikasjon
-
-uloba3-web/                # Frontend som bruker SDK
-└── packages/sdk/          # .tgz filer for produksjon
+# Eller spesifiser versjon
+pnpm add @digiteers/uloba3-sdk@1.3.8
 ```
 
 ## 🚀 Kom i gang
 
 ### Forutsetninger
 - Node.js 18+
-- npm eller pnpm
-- Tilgang til uloba3-backend repository
-- yalc installert globalt: `npm install -g yalc`
+- npm (for publisering)
+- Tilgang til uloba3-backend (for å generere types)
 
-### Oppsett
+### Oppsett for utvikling
 ```bash
 # Klon repository
-git clone [repository-url] uloba3-sdk
-cd uloba3-sdk
+cd /Users/digiteers/GitHub/uloba3/uloba3-sdk
 
 # Installer dependencies
 npm install
 
-# Generer SDK fra lokal API
+# Generer SDK fra lokal API (må kjøre på localhost:3001)
 npm run generate
 
 # Bygg SDK
@@ -56,88 +40,68 @@ npm run build
 
 ## 🔄 Utviklingsworkflow
 
-### 1. Når API endres (i uloba3-backend)
+### 1. Oppdatere SDK når API endres
 
 ```bash
-# Start API lokalt
-cd uloba3-backend
+# 1. Start API lokalt
+cd ../uloba3-backend
 pnpm dev:api  # Kjører på localhost:3001
 
-# Generer nytt SDK
-cd uloba3-sdk
-npm run generate    # Henter OpenAPI spec og genererer typer
-npm run build       # Kompilerer TypeScript
-```
+# 2. Generer nye typer fra API
+cd ../uloba3-sdk
+npm run generate    # Henter OpenAPI spec og genererer types.ts
 
-### 2. For lokal utvikling (med uloba3-web)
-
-**Metode A: Yalc (anbefalt for utvikling)**
-```bash
-# I SDK directory
-npm run publish:local   # Publiserer til yalc
-
-# I web prosjektet
-pnpm sdk:link          # Linker SDK via yalc
+# 3. Bygg SDK
+npm run build
 
-# OBS: Ved oppdateringer av SDK:
-# 1. Gjør endringer i SDK
-# 2. Kjør 'npm run publish:local' i SDK directory
-# 3. SDK oppdateres automatisk i web (yalc push)
-# 4. Hvis ikke, kjør 'pnpm sdk:link' på nytt i web
+# 4. Bump versjon og publiser
+npm version patch   # 1.3.8 -> 1.3.9 (eller minor/major)
+npm publish        # Publiserer til npm (automation token i .npmrc)
 
-# Når ferdig med utvikling:
-pnpm sdk:unlink        # Fjerner link
+# 5. Oppdater i uloba3-web
+cd ../uloba3-web
+pnpm add @digiteers/uloba3-sdk@latest
 ```
 
-**Metode B: .tgz fil (for testing av produksjon)**
-```bash
-# I SDK directory
-npm run pack           # Lager uloba3-sdk-X.X.X.tgz
+### 2. Workflow-diagram
 
-# I web prosjektet
-pnpm sdk:prod         # Kopierer og installerer .tgz
 ```
-
-### 3. Typisk utviklingsløype
-
-```mermaid
-graph LR
-    A[Backend endring] --> B[API kjører lokalt]
-    B --> C[Generer SDK]
-    C --> D[Publiser til yalc]
-    D --> E[Link i web]
-    E --> F[Test i web]
-    F --> G{Fungerer?}
-    G -->|Nei| A
-    G -->|Ja| H[Commit SDK]
-    H --> I[Pack .tgz]
-    I --> J[Deploy]
+Backend endring
+    ↓
+Start lokal API (localhost:3001)
+    ↓
+npm run generate (i SDK)
+    ↓
+npm run build
+    ↓
+npm version patch
+    ↓
+npm publish
+    ↓
+pnpm add @digiteers/uloba3-sdk@latest (i web)
+    ↓
+Test i web
 ```
 
-### ⚠️ Viktig om Yalc
-
-Yalc krever ofte at `pnpm sdk:link` kjøres flere ganger:
-- **Første gang**: Etablerer link mellom SDK og web
-- **Ved oppdateringer**: Selv om `npm run publish:local` pusher endringer, må ofte `pnpm sdk:link` kjøres på nytt i web for å få oppdateringen
-- **Tips**: Hvis du ikke ser endringene dine, kjør `pnpm sdk:link` igjen
-
 ## 📝 Scripts
 
 | Script | Beskrivelse | Når brukes |
 |--------|-------------|------------|
 | `npm run generate` | Generer fra lokal API (localhost:3001) | Etter API endringer |
-| `npm run generate:remote` | Generer fra ekstern API | For produksjon sync |
+| `npm run sjekk` | Quick test av type generation | For debugging |
+| `npm run generate:remote` | Generer fra remote API | For produksjon sync |
 | `npm run build` | Kompiler TypeScript til JavaScript | Før publisering |
-| `npm run publish:local` | Publiser til yalc | For lokal utvikling |
-| `npm run pack` | Lag .tgz pakke | For produksjon |
+| `npm run pack` | Lag .tgz pakke (for testing) | For lokal testing |
 | `npm run clean` | Slett dist og .tgz filer | For opprydding |
 | `npm run typecheck` | Sjekk TypeScript typer | Før commit |
+| `npm run lint` | Sjekk kode kvalitet | Før commit |
+| `npm run format` | Formater kode | Før commit |
 
 ## 💻 Bruk i kode
 
 ```typescript
 // Import SDK
-import { ApiClient } from '@uloba3/sdk';
+import { ApiClient } from '@digiteers/uloba3-sdk';
 
 // Initialiser klient
 const client = new ApiClient({
@@ -157,6 +121,43 @@ const application = await client.applications.create({
 });
 ```
 
+## 🔐 Publisering til npm
+
+SDK bruker **npm automation token** for å publisere uten 2FA ved hver gang.
+
+### Oppsett (allerede gjort)
+1. Automation token er konfigurert i `.npmrc`
+2. `.npmrc` er gitignored for sikkerhet
+3. Publisering krever ingen OTP-kode
+
+### Publisere ny versjon
+```bash
+npm version patch   # eller minor/major
+npm publish        # Publiserer automatisk til npm
+```
+
+## 📚 API Moduler
+
+SDK gir typed tilgang til følgende API moduler:
+
+| Modul | Beskrivelse |
+|-------|-------------|
+| `accounts` | Kontohåndtering |
+| `auth` | Autentisering |
+| `users` | Brukerhåndtering |
+| `jobs` | Jobbannonser |
+| `assistants` | Assistenthåndtering |
+| `applications` | Jobbsøknader |
+| `inquiries` | Henvendelser |
+| `contracts` | Kontrakter |
+| `contractCases` | Kontraktsaker |
+| `tasks` | Oppgaver |
+| `billing` | Fakturering |
+| `analytics` | Statistikk |
+| `documents` | Dokumenter |
+| `messaging` | Meldinger |
+| `admin` | Admin funksjoner |
+
 ## 🏗️ Vedlikehold
 
 ### Oppdater dependencies
@@ -167,90 +168,58 @@ npm audit fix
 
 ### Versjonering
 ```bash
-# Øk versjon i package.json manuelt eller:
-npm version patch  # 1.0.0 -> 1.0.1
-npm version minor  # 1.0.0 -> 1.1.0
-npm version major  # 1.0.0 -> 2.0.0
+npm version patch  # 1.0.0 -> 1.0.1 (bugfixes)
+npm version minor  # 1.0.0 -> 1.1.0 (nye features)
+npm version major  # 1.0.0 -> 2.0.0 (breaking changes)
 ```
 
-### Feilsøking
+## 🔧 Feilsøking
 
-**Problem: SDK oppdateres ikke i web etter publish:local**
+**Problem: TypeScript feil etter generering**
 ```bash
-# Dette er normalt - yalc push oppdaterer ikke alltid package.json
-# Løsning: Kjør sdk:link på nytt i web prosjektet
-pnpm sdk:link
-
-# Alternativt, force update:
-yalc remove @uloba3/sdk
-pnpm sdk:link
-```
+# Sjekk at API kjører
+curl http://localhost:3001/api/docs/json
 
-**Problem: SDK er utdatert**
-```bash
-cd uloba3-sdk
+# Regenerer med clean build
+npm run clean
 npm run generate
 npm run build
-npm run publish:local
-
-# I web prosjektet - VIKTIG:
-pnpm sdk:link  # Må ofte kjøres på nytt for å få oppdateringen
 ```
 
-**Problem: Yalc link fungerer ikke**
+**Problem: Kan ikke publisere til npm**
 ```bash
-# I web prosjektet
-yalc remove @uloba3/sdk
-rm -rf node_modules/.cache
-rm -rf .yalc
-yalc add @uloba3/sdk
-pnpm install
+# Sjekk at du er logget inn
+npm whoami
+
+# Sjekk at .npmrc eksisterer med automation token
+cat .npmrc
 ```
 
-**Problem: TypeScript feil etter generering**
+**Problem: uloba3-web får ikke oppdatert SDK**
 ```bash
-# Sjekk at API kjører
-curl http://localhost:3001/api/docs/json
+# I uloba3-web
+pnpm add @digiteers/uloba3-sdk@latest
 
-# Regenerer med clean build
-npm run clean
-npm run generate
-npm run build
+# Eller spesifiser eksakt versjon
+pnpm add @digiteers/uloba3-sdk@1.3.9
 ```
 
 ## 🔐 Sikkerhet
 
 - SDK inneholder INGEN hemmeligheter eller tokens
 - All autentisering håndteres av konsumenten (web-app)
+- `.npmrc` med automation token er gitignored
 - Generert kode skal ALDRI committes med sensitive data
 
-## 📚 API Moduler
-
-SDK gir typed tilgang til følgende API moduler:
-
-| Modul | Beskrivelse |
-|-------|-------------|
-| `accounts` | Kontohåndtering |
-| `auth` | Autentisering |
-| `users` | Brukerhåndtering |
-| `jobs` | Jobbannonser |
-| `assistants` | Assistenthåndtering |
-| `applications` | Jobbsøknader |
-| `inquiries` | Henvendelser |
-| `contracts` | Kontrakter |
-| `meetings` | Møter |
-| `billing` | Fakturering |
-| `analytics` | Statistikk |
-| `admin` | Admin funksjoner |
-
 ## 🤝 Bidra
 
 1. Gjør endringer i API (uloba3-backend)
-2. Generer nytt SDK
-3. Test grundig med yalc
+2. Generer nytt SDK med `npm run generate`
+3. Test lokalt
 4. Commit med beskrivende melding
-5. Push til main branch
+5. Publiser med `npm version patch && npm publish`
+6. Oppdater i uloba3-web med `pnpm add @digiteers/uloba3-sdk@latest`
 
 ## 📄 Lisens
 
-Privat repository - ikke for offentlig distribusjon.
+MIT - Privat npm package under @digiteers scope.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digiteers/uloba3-sdk",
-  "version": "1.3.8",
+  "version": "1.3.9",
   "description": "SDK for Uloba3 API - TypeScript client library",
   "private": false,
   "main": "./dist/index.js",

package/MIGRATION.md

@@ -1,118 +0,0 @@
-# SDK Migration Documentation
-
-## Overview
-The SDK has been successfully migrated from `uloba3-backend` monorepo to its own standalone repository `uloba3-sdk`.
-
-## Migration Summary
-
-### Repository Structure
-- **New Location**: `/Users/digiteers/GitHub/uloba3/uloba3-sdk`
-- **Package Name**: Changed from `@uloba3-backend/sdk` to `@uloba3/sdk`
-- **Version**: 1.3.6
-
-### Key Changes
-
-#### 1. Package Configuration
-- Standalone package.json with all necessary dependencies
-- Independent TypeScript configuration
-- ESLint and Prettier configurations for code quality
-- Support for both yalc (local dev) and .tgz (production) workflows
-
-#### 2. Generation Scripts
-```json
-{
-  "generate": "npm run generate:local",
-  "generate:local": "openapi-typescript http://localhost:3001/api/docs/json --output ./src/types.ts",
-  "generate:remote": "curl -s ${API_URL}/api/docs/json > /tmp/openapi.json && openapi-typescript /tmp/openapi.json --output ./src/types.ts"
-}
-```
-
-#### 3. Publishing Workflows
-- **Local Development**: `npm run publish:local` (uses yalc)
-- **Production Build**: `npm run pack` (creates .tgz file)
-
-### uloba3-web Updates
-
-#### Package.json Changes
-```json
-// Old
-"@uloba3-backend/sdk": "file:../uloba3-backend/packages/sdk"
-
-// New
-"@uloba3/sdk": "file:.yalc/@uloba3/sdk"  // For local dev with yalc
-// OR
-"@uloba3/sdk": "file:./packages/sdk/uloba3-sdk-1.3.6.tgz"  // For production
-```
-
-#### Script Updates
-- `sdk:prod`: Now references `../uloba3-sdk` instead of `../uloba3-backend/packages/sdk`
-- `sdk:link`: Now uses `@uloba3/sdk` instead of `@uloba3-backend/sdk`
-
-#### Import Updates
-All imports changed from:
-```typescript
-import { SomeType } from '@uloba3-backend/sdk';
-```
-To:
-```typescript
-import { SomeType } from '@uloba3/sdk';
-```
-
-### GitHub Actions
-Added automated SDK generation workflow that:
-- Runs daily or on manual trigger
-- Fetches latest OpenAPI spec from API
-- Generates TypeScript types
-- Commits changes if any
-- Creates releases with .tgz packages
-
-### Benefits of Separation
-
-1. **Cleaner Architecture**: SDK is now independent from backend implementation
-2. **Simpler Workflows**: SDK can be updated without touching backend code
-3. **Better Versioning**: SDK has its own version lifecycle
-4. **Reduced Complexity**: Backend monorepo is simpler without SDK
-5. **Flexible Deployment**: Can be published to npm in future if needed
-
-## Usage
-
-### For SDK Development
-```bash
-cd uloba3-sdk
-npm install
-npm run generate     # Generate from local API
-npm run build        # Build TypeScript
-npm run publish:local  # Publish to yalc
-```
-
-### For uloba3-web Development
-```bash
-# Link SDK for local development
-pnpm sdk:link
-
-# Or use production build
-pnpm sdk:prod
-
-# Unlink when done
-pnpm sdk:unlink
-```
-
-### For Production Deployment
-The `vercel-build` script in uloba3-web will:
-1. Fetch OpenAPI spec from production API
-2. Generate types directly (fallback if SDK not available)
-3. Build the Next.js application
-
-## Migration Completed
-- ✅ Created standalone uloba3-sdk repository
-- ✅ Copied all SDK code and configurations
-- ✅ Set up independent build and generation scripts
-- ✅ Added GitHub Actions for automation
-- ✅ Updated uloba3-web to use new SDK
-- ✅ Removed SDK from backend monorepo
-- ✅ Tested yalc and .tgz workflows
-
-## Next Steps (Optional)
-1. Push uloba3-sdk to GitHub
-2. Configure GitHub Actions secrets
-3. Consider npm publishing in future (currently using local workflows)