sbcwallet 0.0.1 → 0.0.2

package/README.md

@@ -16,7 +16,11 @@ It standardizes claim flows (like PES → TO) and status pipelines (ISSUED → P
 
 ## 🚀 Quickstart
 
-```jsnpm install sbcwallet
+```sh
+npm install sbcwallet
+```
+
+```js
 
 import { createParentSchedule, createChildTicket, getPkpassBuffer } from 'sbcwallet'
 
@@ -55,7 +59,7 @@ import {
 	getGoogleObject
 } from 'sbcwallet'
 
-const biz = createBusiness({ name: 'SBC Coffee', pointsLabel: 'Beans' })
+const biz = createBusiness({ name: 'SBC', pointsLabel: 'points' })
 await createLoyaltyProgram({ businessId: biz.id })
 
 const customer = createCustomerAccount({ businessId: biz.id, fullName: 'Alice' })

package/package.json

@@ -1,16 +1,34 @@
 {
   "name": "sbcwallet",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Unified Wallet-Pass SDK for Real-World Credentials",
   "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
   "scripts": {
+    "clean": "node scripts/clean-dist.js",
     "build": "tsc",
     "postbuild": "node scripts/copy-assets.js",
     "test": "vitest run",
     "test:watch": "vitest",
-    "lint": "eslint src",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint": "npm run typecheck",
+    "prepack": "npm run clean && npm run build",
+    "preversion": "npm run test && npm run typecheck",
+    "bump:patch": "npm version patch",
+    "bump:minor": "npm version minor",
+    "bump:major": "npm version major",
+    "publish:npm": "npm publish",
     "loyalty:issue": "npm run build && node examples/loyalty-google-issue.js",
     "loyalty:server": "npm run build && node examples/loyalty-admin-server.js",
     "loyalty:server:fixed": "npm run build && node examples/loyalty-fixed-card-server.js"
@@ -24,9 +42,7 @@
     "verifiable"
   ],
   "dependencies": {
-    "@types/jsonwebtoken": "^9.0.10",
     "canvas": "^3.2.0",
-    "dotenv": "^17.2.3",
     "google-auth-library": "^10.4.1",
     "jsonwebtoken": "^9.0.2",
     "passkit-generator": "^3.5.0",
@@ -34,8 +50,10 @@
     "zod": "^3.23.8"
   },
   "devDependencies": {
+    "@types/jsonwebtoken": "^9.0.10",
     "@types/node": "^20.10.0",
     "@types/qrcode": "^1.5.5",
+    "dotenv": "^17.2.3",
     "typescript": "^5.6.3",
     "vitest": "^1.6.0"
   },

package/.env.example

@@ -1,10 +0,0 @@
-# Google Wallet
-GOOGLE_ISSUER_ID=3388000000000000000
-GOOGLE_SA_JSON=./certs/google-credentials.json
-
-# Apple Wallet (requires Apple Developer setup)
-APPLE_TEAM_ID=ABCD123456
-APPLE_PASS_TYPE_ID=pass.com.sbcwallet.logistics
-APPLE_CERT_PATH=./certs/pass.p12
-APPLE_CERT_PASSWORD=yourpassword
-APPLE_WWDR_PATH=./certs/wwdr.pem

package/.github/workflows/build.yml

@@ -1,66 +0,0 @@
-name: Build and Release
-
-on: 
-  push:
-    branches:
-      - master
-      - main
-
-jobs:
-  build:
-    name: Build, Test and Release
-    runs-on: ubuntu-latest
-
-    permissions:
-      contents: write
-    
-    env:
-      PROJECT_NAME: 'sbcwallet'
-      RUN_TESTS: 'false'
-
-    steps:
-
-    - uses: actions/checkout@v4
-      name: Checkout
-
-    - uses: actions/setup-node@v4
-      with:
-        node-version: 18
-        registry-url: 'https://registry.npmjs.org'
-        always-auth: true
-
-    - name: Variables
-      run: |
-        echo VERSION=$(node -p "require('./package.json').version") >> $GITHUB_ENV
-      shell: bash
-
-    - name: Install and Build
-      run: |
-        npm install
-        npm run build
-      env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN || secrets.NOM }}
-
-    - name: Run Tests
-      if: ${{ env.RUN_TESTS == 'true' }}
-      run: |
-        npm run test
-
-    - name: Package
-      run: |
-        echo RELEASE_NAME=$(npm pack) >> $GITHUB_ENV
-
-    - uses: actions/upload-artifact@v4
-      with:
-        name: ${{env.PROJECT_NAME}}-preview-${{env.VERSION}}
-        path: "${{env.RELEASE_NAME}}"
-
-    - name: Release
-      uses: sondreb/action-release@main
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        files: "${{env.RELEASE_NAME}}"
-        draft: true
-        prerelease: false
-        name: "${{ env.PROJECT_NAME }} (${{env.VERSION}})"
-        tag: ${{env.VERSION}}

package/.github/workflows/release.yml

@@ -1,57 +0,0 @@
-name: Publish Package
-
-on:
-  release:
-    types: [published]
-  workflow_dispatch:
-
-jobs:
-  build:
-    name: Download and Push Package
-    runs-on: ubuntu-latest
-
-    permissions:
-      contents: read
-
-    env:
-      PROJECT_NAME: 'sbcwallet'
-
-    steps:
-    - uses: actions/checkout@v4
-      name: Checkout
-
-    - uses: actions/setup-node@v4
-      with:
-        node-version: 18
-        registry-url: 'https://registry.npmjs.org'
-        always-auth: true
-
-    - name: Package Name
-      run: |
-        echo RELEASE_NAME=${{ env.PROJECT_NAME }}-${{ github.event.release.tag_name }}.tgz >> $GITHUB_ENV
-      shell: bash
-
-    - name: Log Variables
-      run: |
-        echo "action - ${{ github.event.action }}"
-        echo "url - ${{ github.event.release.url }}"
-        echo "assets_url - ${{ github.event.release.assets_url }}"
-        echo "id - ${{ github.event.release.id }}"
-        echo "tag_name - ${{ github.event.release.tag_name }}"
-        echo "assets - ${{ github.event.release.assets }}"
-        echo "assets[0] - ${{ github.event.release.assets[0] }}"
-
-    - name: Download release
-      uses: sondreb/action-release-download@master
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        url: ${{ github.event.release.assets_url }}
-        folder: "./"
-
-    - name: Display structure of downloaded files
-      run: ls -R
-
-    - name: NPM Publish
-      run: npm publish ${{env.RELEASE_NAME}} --access public
-      env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN || secrets.NOM }}

package/APPLE_WALLET_SETUP.md

@@ -1,318 +0,0 @@
-# Apple Wallet Setup Guide
-
-Complete guide for setting up Apple Wallet pass generation with sbcwallet.
-
-## Prerequisites
-
-- ✅ Apple Developer Account ($99/year) - [developer.apple.com/programs](https://developer.apple.com/programs/)
-- ✅ Mac computer (required for certificate signing)
-- ✅ sbcwallet package (already built)
-
----
-
-## Step 1: Create Pass Type Identifier
-
-1. Go to [developer.apple.com/account](https://developer.apple.com/account)
-2. Navigate to **Certificates, Identifiers & Profiles**
-3. Click **Identifiers** → **+** button
-4. Select **Pass Type IDs** → Continue
-
-### Create Two Pass Type IDs:
-
-#### For Logistics (Transport Orders)
-- **Description**: sbcwallet Logistics Pass
-- **Identifier**: `pass.com.sbcwallet.logistics`
-- Click **Continue** → **Register**
-
-#### For Healthcare (Patient Visits) - Optional
-- **Description**: sbcwallet Healthcare Pass
-- **Identifier**: `pass.com.sbcwallet.healthcare`
-- Click **Continue** → **Register**
-
----
-
-## Step 2: Generate Pass Type ID Certificate
-
-### A. Create Certificate Signing Request (CSR)
-
-1. Open **Keychain Access** on your Mac
-2. Menu: **Keychain Access** → **Certificate Assistant** → **Request a Certificate from a Certificate Authority**
-3. Fill in:
-   - **User Email**: your@email.com
-   - **Common Name**: sbcwallet Pass Certificate
-   - **Request is**: Saved to disk
-4. Save as `PassCertificate.certSigningRequest`
-
-### B. Create Certificate in Apple Developer Portal
-
-1. Go to **Certificates** → **+** button
-2. Select **Pass Type ID Certificate** → Continue
-3. Choose your Pass Type ID: `pass.com.sbcwallet.logistics`
-4. Upload the `.certSigningRequest` file
-5. Download the certificate: `pass.cer`
-
-### C. Install Certificate
-
-1. Double-click `pass.cer` to install in Keychain Access
-2. Find the certificate in **My Certificates**
-3. Right-click → **Export "Pass Type ID..."**
-4. Save as: `sbcwallet-pass.p12`
-5. **Set a password** (you'll need this later)
-6. Save to: `/Users/przpgo/code/sbcwallet/pass/certs/`
-
----
-
-## Step 3: Get Apple WWDR Certificate
-
-### Download Worldwide Developer Relations Certificate
-
-1. Go to [Apple PKI](https://www.apple.com/certificateauthority/)
-2. Download **Worldwide Developer Relations - G4** certificate
-3. Or use direct link: [WWDR G4 Certificate](https://www.apple.com/certificateauthority/AppleWWDRCAG4.cer)
-4. Double-click to install in Keychain Access
-
-### Export WWDR as PEM
-
-```bash
-# Create certs directory
-mkdir -p /Users/przpgo/code/sbcwallet/pass/certs
-
-# Export from Keychain (or download and convert)
-# If you have the .cer file:
-openssl x509 -inform DER -in AppleWWDRCAG4.cer -out certs/wwdr.pem
-```
-
-**Alternative**: Export from Keychain Access
-1. Find "Apple Worldwide Developer Relations Certification Authority" in System keychain
-2. Right-click → Export
-3. Save as `wwdr.pem` (format: Privacy Enhanced Mail (.pem))
-
----
-
-## Step 4: Configure Environment Variables
-
-Create a `.env` file in the project root:
-
-```bash
-cd /Users/przpgo/code/sbcwallet/pass
-
-cat > .env << 'EOF'
-# Apple Wallet Configuration
-APPLE_TEAM_ID=YOUR_TEAM_ID
-APPLE_PASS_TYPE_ID=pass.com.sbcwallet.logistics
-APPLE_CERT_PATH=./certs/sbcwallet-pass.p12
-APPLE_CERT_PASSWORD=your_p12_password
-APPLE_WWDR_PATH=./certs/wwdr.pem
-EOF
-```
-
-### Find Your Team ID
-
-1. Go to [developer.apple.com/account](https://developer.apple.com/account)
-2. Click on **Membership** in sidebar
-3. Your Team ID is shown (e.g., `ABCD123456`)
-4. Update `.env` with your Team ID
-
----
-
-## Step 5: Verify Certificate Setup
-
-Create a test script:
-
-```bash
-cat > test-apple-wallet.ts << 'EOF'
-import { createParentSchedule, createChildTicket, getPkpassBuffer } from './dist/index.js'
-import { writeFile } from 'fs/promises'
-import 'dotenv/config'
-
-async function testAppleWallet() {
-  console.log('🧪 Testing Apple Wallet Pass Generation\n')
-
-  // Create parent
-  const parent = await createParentSchedule({
-    profile: 'logistics',
-    programName: 'Test Yard Veracruz',
-    site: 'Patio Gate 3',
-    window: {
-      from: '2025-10-20T08:00:00-06:00',
-      to: '2025-10-20T12:00:00-06:00',
-      tz: 'America/Mexico_City'
-    }
-  })
-
-  console.log('✅ Parent created:', parent.id)
-
-  // Create child
-  const child = await createChildTicket({
-    profile: 'logistics',
-    parentId: parent.id,
-    plate: 'TEST123',
-    carrier: 'Test Transport',
-    client: 'Test Client'
-  })
-
-  console.log('✅ Child created:', child.id)
-
-  // Generate pkpass
-  try {
-    const pkpass = await getPkpassBuffer('child', child)
-    await writeFile('test-transport-order.pkpass', pkpass)
-    console.log('\n✅ SUCCESS! Generated: test-transport-order.pkpass')
-    console.log('📱 AirDrop this file to your iPhone to test!')
-  } catch (error) {
-    console.error('❌ Error generating pass:', error)
-    throw error
-  }
-}
-
-testAppleWallet()
-EOF
-```
-
-### Install dotenv and run:
-
-```bash
-npm install dotenv
-npx tsc test-apple-wallet.ts --module ESNext --target ES2022 --moduleResolution node --esModuleInterop
-node test-apple-wallet.js
-```
-
-Expected output:
-```
-🧪 Testing Apple Wallet Pass Generation
-
-✅ Parent created: PES-2025-10-20-XXXX
-✅ Child created: TO-2025-10-20-XXXX-YYYY
-
-✅ SUCCESS! Generated: test-transport-order.pkpass
-📱 AirDrop this file to your iPhone to test!
-```
-
----
-
-## Step 6: Install Pass on iPhone
-
-### Option 1: AirDrop
-1. Right-click `test-transport-order.pkpass` on Mac
-2. Share → AirDrop → Your iPhone
-3. Tap on iPhone to open
-4. Click **Add** to add to Wallet
-
-### Option 2: Email
-1. Email the `.pkpass` file to yourself
-2. Open on iPhone
-3. Tap attachment → Add to Wallet
-
-### Option 3: Web Server
-```bash
-# Serve the file locally
-python3 -m http.server 8080
-```
-Navigate to `http://your-mac-ip:8080/test-transport-order.pkpass` from iPhone
-
----
-
-## Step 7: Test Pass Updates
-
-Create an update script:
-
-```typescript
-import { updatePassStatus, getPass } from './dist/index.js'
-
-const passId = 'TO-2025-10-20-XXXX-YYYY' // Use your actual ID
-
-// Simulate status transitions
-await updatePassStatus(passId, 'PRESENCE')
-console.log('✅ Status: PRESENCE')
-
-await updatePassStatus(passId, 'SCALE')
-console.log('✅ Status: SCALE')
-
-// In production, you'd regenerate and push the updated pass
-```
-
----
-
-## Troubleshooting
-
-### Common Issues
-
-#### 1. "teamIdentifier" is not allowed to be empty
-- **Solution**: Set `APPLE_TEAM_ID` in `.env` file
-- Find it at developer.apple.com/account → Membership
-
-#### 2. Certificate verification failed
-- **Solution**: Ensure WWDR certificate is in PEM format
-- Verify with: `openssl x509 -in certs/wwdr.pem -text -noout`
-
-#### 3. Invalid password for p12 file
-- **Solution**: Re-export certificate from Keychain Access with correct password
-- Update `APPLE_CERT_PASSWORD` in `.env`
-
-#### 4. Pass not appearing on iPhone
-- **Solution**: Check that:
-  - Pass Type ID matches in code and certificate
-  - Certificate is not expired
-  - iPhone has internet connection (for first-time verification)
-
-#### 5. Permission denied on certs directory
-```bash
-chmod 600 certs/*.p12
-chmod 644 certs/*.pem
-```
-
----
-
-## Directory Structure
-
-Your final setup should look like:
-
-```
-sbcwallet/pass/
-├── .env                          # Environment variables
-├── certs/
-│   ├── sbcwallet-pass.p12        # Your pass certificate (private)
-│   └── wwdr.pem                 # Apple WWDR cert (public)
-├── test-transport-order.pkpass  # Generated pass file
-└── test-apple-wallet.ts         # Test script
-```
-
----
-
-## Next Steps
-
-### 1. Production Setup
-- Store certificates securely (not in git)
-- Use environment-specific configs
-- Implement pass update notifications
-- Set up web service for pass distribution
-
-### 2. Add Logo Images
-```bash
-mkdir -p certs/images
-# Add these images:
-# - icon.png (29×29, 58×58, 87×87)
-# - icon@2x.png (58×58)
-# - icon@3x.png (87×87)
-# - logo.png (160×50)
-# - logo@2x.png (320×100)
-# - logo@3x.png (480×150)
-```
-
-### 3. Enable Pass Updates
-- Implement web service endpoints
-- Set up push notifications
-- Add pass registration/update logic
-
----
-
-## Resources
-
-- [Apple Wallet Developer Guide](https://developer.apple.com/documentation/walletpasses)
-- [Pass Design Guidelines](https://developer.apple.com/design/human-interface-guidelines/wallet)
-- [passkit-generator Documentation](https://github.com/alexandercerutti/passkit-generator)
-- [sbcwallet Pass README](./README.md)
-
----
-
-**Ready to generate your first pass?** Follow Steps 1-6 above after purchasing your Apple Developer account!