@striae-org/striae 5.2.0 → 5.3.0

package/.env.example

@@ -29,31 +29,15 @@ MEASUREMENT_ID=your_firebase_measurement_id_here
 # ===============================
 # FIREBASE SERVICE ACCOUNT CONFIGURATION
 # ===============================
-# **PULLED FROM ADMIN-SERVICE.JSON FILE ONLY**
-PROJECT_ID=your_firebase_project_id_here
+# Shared PROJECT_ID above is also sourced from app/config/admin-service.json by the deploy scripts.
 FIREBASE_SERVICE_ACCOUNT_EMAIL=your_firebase_service_account_email_here
 FIREBASE_SERVICE_ACCOUNT_PRIVATE_KEY=your_firebase_service_account_private_key_here
 
 # ================================
-# PAGES WORKER ENVIRONMENT VARIABLES
+# SIGNING & ENCRYPTION KEYS & REGISTRIES
 # ================================
-PAGES_PROJECT_NAME=your_pages_project_name_here
-PAGES_CUSTOM_DOMAIN=your_custom_domain_here
 
-# ================================
-# KEYS WORKER ENVIRONMENT VARIABLES
-# ================================
-# Worker domains can be entered manually or auto-generated as a 10-character subdomain of PAGES_CUSTOM_DOMAIN during scripts/deploy-config.sh.
-KEYS_WORKER_NAME=your_keys_worker_name_here
-KEYS_WORKER_DOMAIN=your_keys_worker_domain_here
-KEYS_AUTH=your_custom_keys_auth_token_here
-
-# ================================
-# USER WORKER ENVIRONMENT VARIABLES  
-# ================================
-USER_WORKER_NAME=your_user_worker_name_here
-USER_WORKER_DOMAIN=your_user_worker_domain_here
-KV_STORE_ID=your_kv_store_id_here
+# USER WORKER KV ENCRYPTION CONFIGURATION
 USER_KV_ENCRYPTION_PRIVATE_KEY=your_user_kv_encryption_private_key_here
 USER_KV_ENCRYPTION_KEY_ID=your_user_kv_encryption_key_id_here
 USER_KV_ENCRYPTION_PUBLIC_KEY=your_user_kv_encryption_public_key_here
@@ -63,35 +47,54 @@ USER_KV_ENCRYPTION_PUBLIC_KEY=your_user_kv_encryption_public_key_here
 USER_KV_WRITE_ENDPOINTS_ENABLED=true
 # Optional key registry for rotation-safe USER_DB reads.
 # JSON shape: {"activeKeyId":"kid_current","keys":{"kid_current":"-----BEGIN PRIVATE KEY-----\\n...","kid_previous":"-----BEGIN PRIVATE KEY-----\\n..."}}
-USER_KV_ENCRYPTION_KEYS_JSON='{"activeKeyId":"your_user_kv_active_encryption_key_id_here","keys":{"your_user_kv_active_encryption_key_id_here":"your_user_kv_encryption_private_key_here"}}'
-USER_KV_ENCRYPTION_ACTIVE_KEY_ID=your_user_kv_active_encryption_key_id_here
+USER_KV_ENCRYPTION_KEYS_JSON='{}'
+USER_KV_ENCRYPTION_ACTIVE_KEY_ID=
 
-# ================================
-# DATA WORKER ENVIRONMENT VARIABLES
-# ================================
-DATA_WORKER_NAME=your_data_worker_name_here
-DATA_BUCKET_NAME=your_data_bucket_name_here
-FILES_BUCKET_NAME=your_files_bucket_name_here
-DATA_WORKER_DOMAIN=your_data_worker_domain_here
-# Auto-generated by scripts/deploy-config.sh when placeholders are detected.
+# DATA WORKER MANIFEST SIGNING CONFIGURATION
 MANIFEST_SIGNING_PRIVATE_KEY=your_manifest_signing_private_key_here
 MANIFEST_SIGNING_KEY_ID=your_manifest_signing_key_id_here
 MANIFEST_SIGNING_PUBLIC_KEY=your_manifest_signing_public_key_here
+
+# DATA EXPORT ENCRYPTION CONFIGURATION
 EXPORT_ENCRYPTION_PRIVATE_KEY=your_export_encryption_private_key_here
 EXPORT_ENCRYPTION_KEY_ID=your_export_encryption_key_id_here
 EXPORT_ENCRYPTION_PUBLIC_KEY=your_export_encryption_public_key_here
 # Optional key registry for export decrypt compatibility.
 # JSON shape: {"activeKeyId":"kid_current","keys":{"kid_current":"-----BEGIN PRIVATE KEY-----\\n...","kid_previous":"-----BEGIN PRIVATE KEY-----\\n..."}}
-EXPORT_ENCRYPTION_KEYS_JSON='{"activeKeyId":"your_export_encryption_active_key_id_here","keys":{"your_export_encryption_active_key_id_here":"your_export_encryption_private_key_here"}}'
-EXPORT_ENCRYPTION_ACTIVE_KEY_ID=your_export_encryption_active_key_id_here
+EXPORT_ENCRYPTION_KEYS_JSON='{}'
+EXPORT_ENCRYPTION_ACTIVE_KEY_ID=
+
+# DATA-AT-REST ENCRYPTION CONFIGURATION
 DATA_AT_REST_ENCRYPTION_ENABLED=true
 DATA_AT_REST_ENCRYPTION_PRIVATE_KEY=your_data_at_rest_encryption_private_key_here
 DATA_AT_REST_ENCRYPTION_KEY_ID=your_data_at_rest_encryption_key_id_here
 DATA_AT_REST_ENCRYPTION_PUBLIC_KEY=your_data_at_rest_encryption_public_key_here
 # Optional key registry for data/files/audit decryption compatibility.
 # JSON shape: {"activeKeyId":"kid_current","keys":{"kid_current":"-----BEGIN PRIVATE KEY-----\\n...","kid_previous":"-----BEGIN PRIVATE KEY-----\\n..."}}
-DATA_AT_REST_ENCRYPTION_KEYS_JSON='{"activeKeyId":"your_data_at_rest_active_encryption_key_id_here","keys":{"your_data_at_rest_active_encryption_key_id_here":"your_data_at_rest_encryption_private_key_here"}}'
-DATA_AT_REST_ENCRYPTION_ACTIVE_KEY_ID=your_data_at_rest_active_encryption_key_id_here
+DATA_AT_REST_ENCRYPTION_KEYS_JSON='{}'
+DATA_AT_REST_ENCRYPTION_ACTIVE_KEY_ID=
+
+# ================================
+# PAGES WORKER ENVIRONMENT VARIABLES
+# ================================
+PAGES_PROJECT_NAME=your_pages_project_name_here
+PAGES_CUSTOM_DOMAIN=your_custom_domain_here
+
+# ================================
+# USER WORKER ENVIRONMENT VARIABLES  
+# ================================
+# Worker domains can be entered manually or auto-generated as a shared subdomain during scripts/deploy-config.sh.
+USER_WORKER_NAME=your_user_worker_name_here
+USER_WORKER_DOMAIN=your_user_worker_domain_here
+KV_STORE_ID=your_kv_store_id_here
+
+# ================================
+# DATA WORKER ENVIRONMENT VARIABLES
+# ================================
+DATA_WORKER_NAME=your_data_worker_name_here
+DATA_BUCKET_NAME=your_data_bucket_name_here
+FILES_BUCKET_NAME=your_files_bucket_name_here
+DATA_WORKER_DOMAIN=your_data_worker_domain_here
 
 # ================================
 # AUDIT WORKER ENVIRONMENT VARIABLES

package/README.md

@@ -2,7 +2,7 @@
 
 Striae is a cloud-native forensic annotation application for firearms identification, built with React Router and Cloudflare Workers.
 
-This npm package publishes the Striae application source and deployment scaffolding for teams that run their own Striae environment.
+This npm package publishes the Striae application source for teams that run/develop their own Striae environment.
 
 ## Live Project
 
@@ -21,53 +21,11 @@ This npm package publishes the Striae application source and deployment scaffold
 - Not a small client SDK.
 - Not a zero-config, ready-to-run desktop app.
 
-## npm Package, Installation, and Full Deployment
-
-**Striae Package Links**
+## Striae Package Links
 
 - npmjs: [https://www.npmjs.com/package/@striae-org/striae](https://www.npmjs.com/package/@striae-org/striae)
 - GitHub Packages: [https://github.com/orgs/striae-org/packages/npm/package/striae](https://github.com/orgs/striae-org/packages/npm/package/striae)
 
-1) Install the latest package:
-
-```bash
-npm i @striae-org/striae
-```
-
-2) Copy the package scaffold into the project root
-
-```bash
-cp -R node_modules/@striae-org/striae/. .
-```
-
-3) Reinstall using Striae's own package.json (includes dev deps like wrangler/react-router)
-
-```bash
-rm -rf node_modules package-lock.json
-npm install
-```
-
-4) Prepare Firebase admin credentials (required before deploy-config can pass)
-
-```bash
-mkdir -p app/config
-cp -f app/config-example/admin-service.json app/config/admin-service.json
-```
-
-5) Replace `app/config/admin-service.json` with your actual Firebase service account JSON
-
-6) Authenticate Cloudflare CLI
-
-```bash
-npx wrangler login
-```
-
-7) Run guided config + full deployment
-
-```bash
-npm run deploy:all
-```
-
 ## NPM Package Content Policy
 
 This package intentionally includes only non-sensitive defaults and runtime source needed for setup.
@@ -75,9 +33,10 @@ This package intentionally includes only non-sensitive defaults and runtime sour
 Included:
 
 - `app/` source (with `app/config-example/`)
-- `functions/`, `public/`, `scripts/`
+- `functions/`, `public/`
 - Worker package manifests
-- Worker source files except runtime entry files (`workers/*/src/*.ts` and excluding `workers/*/src/*worker.ts`)
+- Worker source files needed by the example workers, including nested helper modules, while excluding production worker entry files (`workers/*/src/**/*.ts` excluding `workers/*/src/**/*worker.ts`)
+- PDF worker example support files limited to `workers/pdf-worker/src/assets/generated-assets.example.ts` and `workers/pdf-worker/src/formats/format-striae.ts` (no extra PDF image assets or custom formats)
 - Worker example Wrangler configs (`workers/*/wrangler.jsonc.example`)
 - Project-level example and build config (`.env.example`, `wrangler.toml.example`, `tsconfig.json`, etc.)
 

package/app/components/actions/case-export/core-export.ts

@@ -1,183 +1,11 @@
 import type { User } from 'firebase/auth';
-import { type AnnotationData, type CaseExportData, type AllCasesExportData, type ExportOptions } from '~/types';
+import { type AnnotationData, type CaseExportData, type ExportOptions } from '~/types';
 import { getCaseData } from '~/utils/data';
 import { fetchFiles } from '../image-manage';
 import { getNotes } from '../notes-manage';
-import { validateCaseNumber, listCases } from '../case-manage';
+import { validateCaseNumber } from '../case-manage';
 import { getUserExportMetadata } from './metadata-helpers';
 
-/**
- * Export all cases for a user
- */
-export async function exportAllCases(
-  user: User,
-  options: ExportOptions = {},
-  onProgress?: (current: number, total: number, caseName: string) => void
-): Promise<AllCasesExportData> {
-  // NOTE: startTime tracking moved to download handlers
-  
-  try {
-    // NOTE: Audit workflow management moved to download handlers
-    
-    const {
-      includeMetadata = true
-    } = options;
-
-    // Get user export metadata
-    const userMetadata = await getUserExportMetadata(user);
-    
-    // Get list of all cases for the user
-    const caseNumbers = await listCases(user);
-    
-    if (!caseNumbers || caseNumbers.length === 0) {
-      throw new Error('No cases found for user');
-    }
-
-    const exportedCases: CaseExportData[] = [];
-    let totalFiles = 0;
-    let totalAnnotations = 0;
-    let totalConfirmations = 0;
-    let totalConfirmationsRequested = 0;
-    let casesWithFiles = 0;
-    let casesWithAnnotations = 0;
-    let casesWithoutFiles = 0;
-    let lastModified: string | undefined;
-    let earliestAnnotationDate: string | undefined;
-    let latestAnnotationDate: string | undefined;
-
-    // Export each case
-    for (let i = 0; i < caseNumbers.length; i++) {
-      const caseNumber = caseNumbers[i];
-      
-      // Report progress
-      if (onProgress) {
-        onProgress(i + 1, caseNumbers.length, caseNumber);
-      }
-
-      try {
-        const caseExport = await exportCaseData(user, caseNumber, options);
-        exportedCases.push(caseExport);
-
-        // Update totals
-        totalFiles += caseExport.metadata.totalFiles;
-        
-        if (caseExport.metadata.totalFiles > 0) {
-          casesWithFiles++;
-        } else {
-          casesWithoutFiles++;
-        }
-
-        // Count annotations and confirmations
-        const caseAnnotations = caseExport.files.filter(f => f.hasAnnotations).length;
-        if (caseAnnotations > 0) {
-          casesWithAnnotations++;
-          totalAnnotations += caseAnnotations;
-        }
-
-        // Count confirmations
-        if (caseExport.summary?.filesWithConfirmations) {
-          totalConfirmations += caseExport.summary.filesWithConfirmations;
-        }
-        if (caseExport.summary?.filesWithConfirmationsRequested) {
-          totalConfirmationsRequested += caseExport.summary.filesWithConfirmationsRequested;
-        }
-
-        // Track latest modification
-        if (caseExport.summary?.lastModified) {
-          if (!lastModified || caseExport.summary.lastModified > lastModified) {
-            lastModified = caseExport.summary.lastModified;
-          }
-        }
-
-        // Track annotation date range across all cases
-        if (caseExport.summary?.earliestAnnotationDate) {
-          if (!earliestAnnotationDate || caseExport.summary.earliestAnnotationDate < earliestAnnotationDate) {
-            earliestAnnotationDate = caseExport.summary.earliestAnnotationDate;
-          }
-        }
-        if (caseExport.summary?.latestAnnotationDate) {
-          if (!latestAnnotationDate || caseExport.summary.latestAnnotationDate > latestAnnotationDate) {
-            latestAnnotationDate = caseExport.summary.latestAnnotationDate;
-          }
-        }
-
-      } catch (error) {
-        // Get case creation date even for failed exports
-        let caseCreatedDate = new Date().toISOString(); // fallback
-        try {
-          const caseData = await getCaseData(user, caseNumber);
-          if (caseData?.createdAt) {
-            caseCreatedDate = caseData.createdAt;
-          }
-        } catch {
-          // Use fallback date if case lookup fails
-        }
-
-        // Create a placeholder entry for failed exports
-        exportedCases.push({
-          metadata: {
-            caseNumber,
-            caseCreatedDate,
-            exportDate: new Date().toISOString(),
-            ...userMetadata,
-            striaeExportSchemaVersion: '1.0',
-            totalFiles: 0
-          },
-          files: [],
-          summary: {
-            filesWithAnnotations: 0,
-            filesWithoutAnnotations: 0,
-            totalBoxAnnotations: 0,
-            exportError: error instanceof Error ? error.message : 'Unknown error'
-          }
-        });
-        casesWithoutFiles++;
-      }
-    }
-
-    const allCasesExport: AllCasesExportData = {
-      metadata: {
-        exportDate: new Date().toISOString(),
-        ...userMetadata,
-        striaeExportSchemaVersion: '1.0',
-        totalCases: caseNumbers.length,
-        totalFiles,
-        totalAnnotations,
-        totalConfirmations,
-        totalConfirmationsRequested
-      },
-      cases: exportedCases
-    };
-
-    if (includeMetadata) {
-      allCasesExport.summary = {
-        casesWithFiles,
-        casesWithAnnotations,
-        casesWithoutFiles,
-        lastModified,
-        earliestAnnotationDate,
-        latestAnnotationDate
-      };
-    }
-
-    // Report completion
-    if (onProgress) {
-      onProgress(caseNumbers.length, caseNumbers.length, 'Export completed!');
-    }
-    
-    // NOTE: Audit logging moved to download handlers where actual filename and format are known
-    
-    return allCasesExport;
-
-  } catch (error) {
-    console.error('Export all cases failed:', error);
-    
-    // NOTE: Audit logging for failures moved to download handlers
-    
-    throw error;
-  }
-}
-
 /**
  * Export case data with files and annotations
  */