@ankhorage/contracts 1.15.0 → 1.17.0

package/src/nutrition/nutrition.test.ts

@@ -0,0 +1,137 @@
+import { describe, expect, it } from 'bun:test';
+
+import {
+  NUTRITION_BARCODE_TYPES,
+  NUTRITION_CAPTURE_SUBMISSION_STATUSES,
+  NUTRITION_DATA_SOURCES,
+  NUTRITION_PRODUCT_STATUSES,
+  NUTRITION_REVIEW_DECISIONS,
+  type NutritionCaptureSubmission,
+  type NutritionProduct,
+  type NutritionProductCaptureRequest,
+  type NutritionReviewDecisionRequest,
+} from './index';
+
+describe('nutrition contracts', () => {
+  it('exports stable literal unions for nutrition workflows', () => {
+    expect(NUTRITION_BARCODE_TYPES).toEqual([
+      'ean_8',
+      'ean_13',
+      'upc_a',
+      'upc_e',
+      'gtin_14',
+      'unknown',
+    ]);
+    expect(NUTRITION_PRODUCT_STATUSES).toEqual([
+      'draft',
+      'pending_review',
+      'published',
+      'rejected',
+      'archived',
+    ]);
+    expect(NUTRITION_DATA_SOURCES).toEqual([
+      'manual_scan',
+      'user_correction',
+      'open_food_facts',
+      'foodrepo_legacy',
+      'retailer_import',
+      'admin_import',
+    ]);
+    expect(NUTRITION_CAPTURE_SUBMISSION_STATUSES).toEqual([
+      'queued',
+      'needs_more_data',
+      'accepted',
+      'rejected',
+      'merged',
+    ]);
+    expect(NUTRITION_REVIEW_DECISIONS).toEqual([
+      'accept',
+      'reject',
+      'merge',
+      'request_changes',
+      'publish',
+    ]);
+  });
+
+  it('serializes a published barcode product', () => {
+    const product: NutritionProduct = {
+      id: 'product_01',
+      primaryBarcode: {
+        value: '7612345678901',
+        type: 'ean_13',
+        normalizedValue: '7612345678901',
+      },
+      name: 'Example Yogurt Nature',
+      brand: 'Example Brand',
+      quantity: '250 g',
+      packageSizeG: 250,
+      serving: { label: '1 cup', sizeG: 250, servingsPerPackage: 1 },
+      nutrientsPer100g: {
+        basis: 'per_100g',
+        energyKcal: 62,
+        energyKj: 260,
+        proteinG: 11,
+        carbohydratesG: 3.8,
+        sugarsG: 3.8,
+        fatG: 0.2,
+        saturatedFatG: 0.1,
+        fiberG: 0,
+        saltG: 0.1,
+        sodiumG: 0.04,
+      },
+      ingredients: { locale: 'de-CH', text: 'Milk, cultures.' },
+      allergens: ['milk'],
+      stores: [{ countryCode: 'CH', storeChain: 'Example Store' }],
+      images: [{ kind: 'nutrition_label', path: 'labels/7612345678901.jpg' }],
+      status: 'published',
+      source: 'manual_scan',
+      sourceConfidence: 'high',
+      verifiedByUser: true,
+      createdAt: '2026-06-01T12:00:00.000Z',
+      updatedAt: '2026-06-01T12:05:00.000Z',
+      publishedAt: '2026-06-01T12:10:00.000Z',
+    };
+
+    expect(JSON.parse(JSON.stringify(product))).toEqual(product);
+    expect(product.nutrientsPer100g?.proteinG).toBe(11);
+  });
+
+  it('serializes capture submissions and review decisions', () => {
+    const capture: NutritionProductCaptureRequest = {
+      draft: {
+        barcode: { value: '7612345678901', type: 'ean_13' },
+        name: 'Example Yogurt Nature',
+        nutrientsPer100g: { energyKcal: 62, proteinG: 11 },
+        storeObservation: { countryCode: 'CH', storeChain: 'Example Store' },
+        rawPayload: { source: 'manual' },
+      },
+      client: {
+        anonymousDeviceId: 'device-1',
+        platform: 'ios',
+        appVersion: '0.1.0',
+        clientCapturedAt: '2026-06-01T12:00:00.000Z',
+      },
+    };
+
+    const submission: NutritionCaptureSubmission = {
+      id: 'submission_01',
+      status: 'queued',
+      draft: capture.draft,
+      client: capture.client,
+      matchedProductId: null,
+      createdAt: '2026-06-01T12:00:00.000Z',
+      updatedAt: '2026-06-01T12:00:00.000Z',
+    };
+
+    const decision: NutritionReviewDecisionRequest = {
+      submissionId: submission.id,
+      decision: 'accept',
+      reviewerId: 'reviewer-1',
+      note: 'Readable label.',
+    };
+
+    expect(JSON.parse(JSON.stringify(capture))).toEqual(capture);
+    expect(JSON.parse(JSON.stringify(submission))).toEqual(submission);
+    expect(decision.decision).toBe('accept');
+  });
+});

package/src/nutrition/products.ts

@@ -0,0 +1,134 @@
+import type {
+  NutritionBarcode,
+  NutritionDataSource,
+  NutritionIsoDateTime,
+  NutritionJsonValue,
+  NutritionProductId,
+  NutritionProductStatus,
+  NutritionSourceConfidence,
+} from './common';
+
+export type NutritionMeasurementBasis = 'per_100g' | 'per_100ml';
+
+export interface NutritionFactsPer100g {
+  readonly basis?: NutritionMeasurementBasis;
+  readonly energyKcal?: number;
+  readonly energyKj?: number;
+  readonly proteinG?: number;
+  readonly carbohydratesG?: number;
+  readonly sugarsG?: number;
+  readonly fatG?: number;
+  readonly saturatedFatG?: number;
+  readonly fiberG?: number;
+  readonly saltG?: number;
+  readonly sodiumG?: number;
+}
+
+export interface NutritionServing {
+  readonly label?: string;
+  readonly sizeG?: number;
+  readonly sizeMl?: number;
+  readonly servingsPerPackage?: number;
+}
+
+export interface NutritionIngredientStatement {
+  readonly text?: string;
+  readonly locale?: string;
+  readonly rawText?: string;
+}
+
+export type NutritionAllergenTag =
+  | 'celery'
+  | 'cereals_containing_gluten'
+  | 'crustaceans'
+  | 'eggs'
+  | 'fish'
+  | 'lupin'
+  | 'milk'
+  | 'molluscs'
+  | 'mustard'
+  | 'nuts'
+  | 'peanuts'
+  | 'sesame'
+  | 'soybeans'
+  | 'sulphur_dioxide_and_sulphites'
+  | (string & {});
+
+export interface NutritionStoreObservation {
+  readonly countryCode?: string;
+  readonly storeChain?: string;
+  readonly storeName?: string;
+  readonly storeLocationLabel?: string;
+  readonly observedAt?: NutritionIsoDateTime;
+}
+
+export const NUTRITION_IMAGE_KINDS = [
+  'front',
+  'nutrition_label',
+  'ingredients',
+  'barcode',
+  'package_back',
+  'other',
+] as const;
+export type NutritionImageKind = (typeof NUTRITION_IMAGE_KINDS)[number];
+
+export interface NutritionImageEvidence {
+  readonly id?: string;
+  readonly kind: NutritionImageKind;
+  readonly storageId?: string;
+  readonly bucket?: string;
+  readonly path?: string;
+  readonly publicUrl?: string;
+  readonly contentType?: string;
+  readonly width?: number;
+  readonly height?: number;
+  readonly capturedAt?: NutritionIsoDateTime;
+  readonly metadata?: Record<string, NutritionJsonValue>;
+}
+
+export interface NutritionProductSummary {
+  readonly id: NutritionProductId;
+  readonly primaryBarcode: NutritionBarcode;
+  readonly name: string;
+  readonly brand?: string;
+  readonly quantity?: string;
+  readonly status: NutritionProductStatus;
+  readonly source: NutritionDataSource;
+  readonly sourceConfidence: NutritionSourceConfidence;
+  readonly imageUrl?: string;
+  readonly updatedAt: NutritionIsoDateTime;
+}
+
+export interface NutritionProduct {
+  readonly id: NutritionProductId;
+  readonly primaryBarcode: NutritionBarcode;
+  readonly barcodes?: readonly NutritionBarcode[];
+  readonly name: string;
+  readonly brand?: string;
+  readonly quantity?: string;
+  readonly packageSizeG?: number;
+  readonly packageSizeMl?: number;
+  readonly serving?: NutritionServing;
+  readonly nutrientsPer100g?: NutritionFactsPer100g;
+  readonly ingredients?: NutritionIngredientStatement;
+  readonly allergens?: readonly NutritionAllergenTag[];
+  readonly traces?: readonly NutritionAllergenTag[];
+  readonly stores?: readonly NutritionStoreObservation[];
+  readonly images?: readonly NutritionImageEvidence[];
+  readonly status: NutritionProductStatus;
+  readonly source: NutritionDataSource;
+  readonly sourceConfidence: NutritionSourceConfidence;
+  readonly sourcePayload?: NutritionJsonValue;
+  readonly verifiedByUser?: boolean;
+  readonly createdAt: NutritionIsoDateTime;
+  readonly updatedAt: NutritionIsoDateTime;
+  readonly publishedAt?: NutritionIsoDateTime | null;
+}
+
+export interface NutritionProductDetail {
+  readonly product: NutritionProduct;
+}
+
+export interface NutritionProductLookupByBarcodeResponse {
+  readonly product: NutritionProduct;
+}

package/src/nutrition/review.ts

@@ -0,0 +1,65 @@
+import type { NutritionCaptureSubmission, NutritionCaptureSubmissionStatus } from './capture';
+import type {
+  NutritionCaptureSubmissionId,
+  NutritionIsoDateTime,
+  NutritionJsonValue,
+  NutritionProductId,
+  NutritionReviewId,
+  NutritionUserId,
+} from './common';
+import type { NutritionProduct } from './products';
+
+export const NUTRITION_REVIEW_DECISIONS = [
+  'accept',
+  'reject',
+  'merge',
+  'request_changes',
+  'publish',
+] as const;
+export type NutritionReviewDecision = (typeof NUTRITION_REVIEW_DECISIONS)[number];
+
+export interface NutritionReviewDecisionRequest {
+  readonly decision: NutritionReviewDecision;
+  readonly submissionId: NutritionCaptureSubmissionId;
+  readonly reviewerId?: NutritionUserId;
+  readonly targetProductId?: NutritionProductId;
+  readonly productOverride?: Partial<NutritionProduct>;
+  readonly note?: string;
+  readonly metadata?: Record<string, NutritionJsonValue>;
+}
+
+export interface NutritionReviewDecisionResponse {
+  readonly reviewId: NutritionReviewId;
+  readonly submissionId: NutritionCaptureSubmissionId;
+  readonly decision: NutritionReviewDecision;
+  readonly status: NutritionCaptureSubmissionStatus;
+  readonly productId?: NutritionProductId;
+  readonly decidedAt: NutritionIsoDateTime;
+}
+
+export interface NutritionReviewRecord {
+  readonly id: NutritionReviewId;
+  readonly submissionId: NutritionCaptureSubmissionId;
+  readonly reviewerId?: NutritionUserId;
+  readonly decision: NutritionReviewDecision;
+  readonly previousStatus: NutritionCaptureSubmissionStatus;
+  readonly nextStatus: NutritionCaptureSubmissionStatus;
+  readonly targetProductId?: NutritionProductId | null;
+  readonly note?: string;
+  readonly metadata?: Record<string, NutritionJsonValue>;
+  readonly createdAt: NutritionIsoDateTime;
+}
+
+export interface NutritionReviewSubmissionListRequest {
+  readonly status?: NutritionCaptureSubmissionStatus;
+  readonly barcode?: string;
+  readonly store?: string;
+  readonly limit?: number;
+  readonly offset?: number;
+}
+
+export interface NutritionReviewSubmissionListResponse {
+  readonly submissions: readonly NutritionCaptureSubmission[];
+  readonly limit?: number;
+  readonly offset?: number;
+}

package/src/profile-contract.test.ts

@@ -0,0 +1,33 @@
+import { describe, expect, it } from 'bun:test';
+
+import {
+  AUTH_PROFILE_CREATE_STRATEGIES,
+  AUTH_PROFILE_PRIMARY_KEY_STRATEGIES,
+  AUTH_PROFILE_UPDATE_STRATEGIES,
+  type AuthSpec,
+} from './index';
+
+describe('profile contract', () => {
+  it('exports profile strategy lists', () => {
+    expect(AUTH_PROFILE_PRIMARY_KEY_STRATEGIES).toEqual(['authUserId']);
+    expect(AUTH_PROFILE_CREATE_STRATEGIES).toEqual(['trigger', 'api', 'app']);
+    expect(AUTH_PROFILE_UPDATE_STRATEGIES).toEqual(['api', 'app']);
+  });
+
+  it('serializes profile settings on an auth spec', () => {
+    const auth: AuthSpec = {
+      scope: 'global',
+      provider: 'supabase',
+      authorization: { kind: 'RBAC', engine: 'native' },
+      profile: {
+        fields: ['email', 'displayName', 'avatarUrl'],
+        table: 'profiles',
+        primaryKey: 'authUserId',
+        createStrategy: 'trigger',
+        updateStrategy: 'api',
+      },
+    };
+
+    expect(JSON.parse(JSON.stringify(auth))).toEqual(auth);
+  });
+});

package/src/types.ts

@@ -212,6 +212,15 @@ export const AUTH_PROFILE_FIELDS = [
 export type KnownAuthProfileField = (typeof AUTH_PROFILE_FIELDS)[number];
 export type AuthProfileField = KnownAuthProfileField | (string & {});
 
+export const AUTH_PROFILE_PRIMARY_KEY_STRATEGIES = ['authUserId'] as const;
+export type AuthProfilePrimaryKeyStrategy = (typeof AUTH_PROFILE_PRIMARY_KEY_STRATEGIES)[number];
+
+export const AUTH_PROFILE_CREATE_STRATEGIES = ['trigger', 'api', 'app'] as const;
+export type AuthProfileCreateStrategy = (typeof AUTH_PROFILE_CREATE_STRATEGIES)[number];
+
+export const AUTH_PROFILE_UPDATE_STRATEGIES = ['api', 'app'] as const;
+export type AuthProfileUpdateStrategy = (typeof AUTH_PROFILE_UPDATE_STRATEGIES)[number];
+
 export interface IconSpec {
   name: string;
   provider?: string;
@@ -307,6 +316,10 @@ export interface AuthSignUpSpec {
 
 export interface AuthProfileSpec {
   fields: AuthProfileField[];
+  table?: string;
+  primaryKey?: AuthProfilePrimaryKeyStrategy;
+  createStrategy?: AuthProfileCreateStrategy;
+  updateStrategy?: AuthProfileUpdateStrategy;
 }
 
 export interface AuthSpec {

package/dist/data/datasets.d.ts

@@ -1,20 +0,0 @@
-import type { DbCollectionDefinition } from '../db';
-import type { DataContractValue } from './values';
-export declare const APP_DATASET_OPERATIONS: readonly ["create", "delete", "list", "read", "update"];
-export type AppDatasetOperation = (typeof APP_DATASET_OPERATIONS)[number];
-export type AppDatasetId = string;
-export type AppDatasetSeedRecord = Readonly<Record<string, DataContractValue>>;
-export interface AppDatasetDefinition {
-    readonly id: AppDatasetId;
-    readonly label?: string;
-    readonly description?: string;
-    readonly collection: DbCollectionDefinition;
-    readonly operations?: readonly AppDatasetOperation[];
-    readonly seed?: readonly AppDatasetSeedRecord[];
-    readonly metadata?: DataContractValue;
-}
-export type AppDatasetRegistry = Readonly<Record<AppDatasetId, AppDatasetDefinition>>;
-export interface AppDataManifest {
-    readonly datasets?: AppDatasetRegistry;
-}
-//# sourceMappingURL=datasets.d.ts.map

package/dist/data/datasets.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"datasets.d.ts","sourceRoot":"","sources":["../../src/data/datasets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,OAAO,CAAC;AACpD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD,eAAO,MAAM,sBAAsB,yDAA0D,CAAC;AAC9F,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1E,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAClC,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAE/E,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,EAAE,YAAY,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,sBAAsB,CAAC;IAC5C,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,mBAAmB,EAAE,CAAC;IACrD,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAC;IAChD,QAAQ,CAAC,QAAQ,CAAC,EAAE,iBAAiB,CAAC;CACvC;AAED,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,oBAAoB,CAAC,CAAC,CAAC;AAEtF,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;CACxC"}

package/dist/data/datasets.js

@@ -1,2 +0,0 @@
-export const APP_DATASET_OPERATIONS = ['create', 'delete', 'list', 'read', 'update'];
-//# sourceMappingURL=datasets.js.map

package/dist/data/datasets.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"datasets.js","sourceRoot":"","sources":["../../src/data/datasets.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAU,CAAC","sourcesContent":["import type { DbCollectionDefinition } from '../db';\nimport type { DataContractValue } from './values';\n\nexport const APP_DATASET_OPERATIONS = ['create', 'delete', 'list', 'read', 'update'] as const;\nexport type AppDatasetOperation = (typeof APP_DATASET_OPERATIONS)[number];\n\nexport type AppDatasetId = string;\nexport type AppDatasetSeedRecord = Readonly<Record<string, DataContractValue>>;\n\nexport interface AppDatasetDefinition {\n  readonly id: AppDatasetId;\n  readonly label?: string;\n  readonly description?: string;\n  readonly collection: DbCollectionDefinition;\n  readonly operations?: readonly AppDatasetOperation[];\n  readonly seed?: readonly AppDatasetSeedRecord[];\n  readonly metadata?: DataContractValue;\n}\n\nexport type AppDatasetRegistry = Readonly<Record<AppDatasetId, AppDatasetDefinition>>;\n\nexport interface AppDataManifest {\n  readonly datasets?: AppDatasetRegistry;\n}\n"]}

package/src/data/datasets.ts

@@ -1,24 +0,0 @@
-import type { DbCollectionDefinition } from '../db';
-import type { DataContractValue } from './values';
-
-export const APP_DATASET_OPERATIONS = ['create', 'delete', 'list', 'read', 'update'] as const;
-export type AppDatasetOperation = (typeof APP_DATASET_OPERATIONS)[number];
-
-export type AppDatasetId = string;
-export type AppDatasetSeedRecord = Readonly<Record<string, DataContractValue>>;
-
-export interface AppDatasetDefinition {
-  readonly id: AppDatasetId;
-  readonly label?: string;
-  readonly description?: string;
-  readonly collection: DbCollectionDefinition;
-  readonly operations?: readonly AppDatasetOperation[];
-  readonly seed?: readonly AppDatasetSeedRecord[];
-  readonly metadata?: DataContractValue;
-}
-
-export type AppDatasetRegistry = Readonly<Record<AppDatasetId, AppDatasetDefinition>>;
-
-export interface AppDataManifest {
-  readonly datasets?: AppDatasetRegistry;
-}