@naturalcycles/abba 1.6.0 → 1.9.0

package/dist/abba.d.ts

@@ -1,8 +1,11 @@
-import { UserAssignment } from './prisma-output';
-import { BucketInput, ExperimentWithBuckets, ExperimentInput, SegmentationData, AssignmentStatistics } from '.';
+import { Saved } from '@naturalcycles/js-lib';
+import { AbbaConfig, Bucket, Experiment, ExperimentWithBuckets, UserAssignment } from './types';
+import { SegmentationData, AssignmentStatistics } from '.';
 export declare class Abba {
-    private client;
-    constructor(dbUrl?: string);
+    private experimentDao;
+    private bucketDao;
+    private userAssignmentDao;
+    constructor({ db }: AbbaConfig);
     /**
      * Returns all experiments
      *
@@ -16,7 +19,7 @@ export declare class Abba {
      * @param buckets
      * @returns
      */
-    createExperiment(experiment: ExperimentInput, buckets: BucketInput[]): Promise<ExperimentWithBuckets>;
+    createExperiment(experiment: Experiment, buckets: Bucket[]): Promise<ExperimentWithBuckets>;
     /**
      * Update experiment information, will also validate the buckets ratio if experiment.active is true
      *
@@ -26,7 +29,7 @@ export declare class Abba {
      * @param buckets
      * @returns
      */
-    saveExperiment(id: number, experiment: ExperimentInput, buckets: BucketInput[]): Promise<ExperimentWithBuckets>;
+    saveExperiment(id: number, experiment: Experiment, buckets: Bucket[]): Promise<ExperimentWithBuckets>;
     /**
      * Delete an experiment. Removes all user assignments and buckets
      *
@@ -38,18 +41,18 @@ export declare class Abba {
      *
      * @param experimentId
      * @param userId
-     * @param createNew
-     * @param segmentationData
+     * @param existingOnly Do not generate any new assignments for this experiment
+     * @param segmentationData Required if existingOnly is false
      * @returns
      */
-    getUserAssignment(experimentId: number, userId: string, existingOnly: boolean, segmentationData?: SegmentationData): Promise<UserAssignment | null>;
+    getUserAssignment(experimentId: number, userId: string, existingOnly: boolean, segmentationData?: SegmentationData): Promise<Saved<UserAssignment> | null>;
     /**
      * Get all existing user assignments
      *
-     * @param userId G
+     * @param userId
      * @returns
      */
-    getAllExistingUserAssignments(userId: string): Promise<UserAssignment[]>;
+    getAllExistingUserAssignments(userId: string): Promise<Saved<UserAssignment>[]>;
     /**
      * Generate user assignments for all active experiments. Will return any existing and attempt to generate any new assignments.
      *
@@ -57,7 +60,7 @@ export declare class Abba {
      * @param segmentationData
      * @returns
      */
-    generateUserAssignments(userId: string, segmentationData: SegmentationData): Promise<UserAssignment[]>;
+    generateUserAssignments(userId: string, segmentationData: SegmentationData): Promise<Saved<UserAssignment>[]>;
     /**
      * Get assignment statistics for an experiment
      *
@@ -82,21 +85,4 @@ export declare class Abba {
      * @returns
      */
     private getExistingUserAssignment;
-    /**
-     * Update experiment information
-     *
-     * @param id
-     * @param experiment
-     * @param rules
-     * @returns
-     */
-    private updateExperiment;
-    /**
-     * Upserts bucket info
-     *
-     * @param id
-     * @param experiment
-     * @returns
-     */
-    private saveBuckets;
 }

package/dist/abba.js

@@ -1,32 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Abba = void 0;
-const prisma_output_1 = require("./prisma-output");
+const js_lib_1 = require("@naturalcycles/js-lib");
 const types_1 = require("./types");
 const util_1 = require("./util");
-// Note: Schema currently contains an output dir which generates all the files to the prisma dir
-// it would be tidier not to include it here when possible later on:
-// Explanation is here: https://github.com/prisma/prisma/issues/9435#issuecomment-960290681
+const experiment_dao_1 = require("./dao/experiment.dao");
+const userAssignment_dao_1 = require("./dao/userAssignment.dao");
+const bucket_dao_1 = require("./dao/bucket.dao");
 class Abba {
-    constructor(dbUrl) {
-        this.client = new prisma_output_1.PrismaClient({
-            datasources: {
-                db: {
-                    url: dbUrl,
-                },
-            },
-        });
+    constructor({ db }) {
+        this.experimentDao = (0, experiment_dao_1.experimentDao)(db);
+        this.bucketDao = (0, bucket_dao_1.bucketDao)(db);
+        this.userAssignmentDao = (0, userAssignment_dao_1.userAssignmentDao)(db);
     }
+    // TODO: Cache me
     /**
      * Returns all experiments
      *
      * @returns
      */
     async getAllExperiments(excludeInactive = false) {
-        return await this.client.experiment.findMany({
-            where: excludeInactive ? { NOT: { status: types_1.AssignmentStatus.Inactive } } : undefined,
-            include: { buckets: true },
-        });
+        const query = this.experimentDao.query();
+        if (excludeInactive) {
+            query.filter('status', '!=', types_1.AssignmentStatus.Inactive);
+        }
+        const experiments = await this.experimentDao.runQuery(query);
+        const buckets = await this.bucketDao
+            .query()
+            .filter('experimentId', 'in', experiments.map(e => e.id))
+            .runQuery();
+        return experiments.map(experiment => ({
+            ...experiment,
+            buckets: buckets.filter(bucket => bucket.experimentId === experiment.id),
+        }));
     }
     /**
      * Creates a new experiment
@@ -39,21 +45,11 @@ class Abba {
         if (experiment.status === types_1.AssignmentStatus.Active) {
             (0, util_1.validateTotalBucketRatio)(buckets);
         }
-        const created = await this.client.experiment.create({
-            data: {
-                ...experiment,
-                rules: experiment.rules,
-                buckets: {
-                    createMany: {
-                        data: buckets,
-                    },
-                },
-            },
-            include: {
-                buckets: true,
-            },
-        });
-        return created;
+        const created = await this.experimentDao.save(experiment);
+        return {
+            ...created,
+            buckets: await this.bucketDao.saveBatch(buckets.map(b => ({ ...b, experimentId: created.id }))),
+        };
     }
     /**
      * Update experiment information, will also validate the buckets ratio if experiment.active is true
@@ -68,11 +64,13 @@ class Abba {
         if (experiment.status === types_1.AssignmentStatus.Active) {
             (0, util_1.validateTotalBucketRatio)(buckets);
         }
-        const updatedExperiment = await this.updateExperiment(id, experiment);
-        const updatedBuckets = await this.saveBuckets(buckets);
+        const updated = await this.experimentDao.save({
+            ...experiment,
+            id,
+        });
         return {
-            ...updatedExperiment,
-            buckets: updatedBuckets,
+            ...updated,
+            buckets: await this.bucketDao.saveBatch(buckets.map(b => ({ ...b, experimentId: id }))),
         };
     }
     /**
@@ -81,24 +79,22 @@ class Abba {
      * @param id
      */
     async deleteExperiment(id) {
-        await this.client.experiment.delete({ where: { id } });
+        await this.experimentDao.deleteById(id);
     }
     /**
      * Get an assignment for a given user. If existingOnly is false, it will attempt generate a new assignment
      *
      * @param experimentId
      * @param userId
-     * @param createNew
-     * @param segmentationData
+     * @param existingOnly Do not generate any new assignments for this experiment
+     * @param segmentationData Required if existingOnly is false
      * @returns
      */
     async getUserAssignment(experimentId, userId, existingOnly, segmentationData) {
-        const experiment = await this.client.experiment.findUnique({
-            where: { id: experimentId },
-            include: { buckets: true },
-        });
+        const experiment = await this.experimentDao.requireById(experimentId);
         if (!experiment)
             throw new Error('Experiment not found');
+        const buckets = await this.bucketDao.getBy('experimentId', experimentId);
         const existing = await this.getExistingUserAssignment(experimentId, userId);
         if (existing)
             return existing;
@@ -106,16 +102,16 @@ class Abba {
             return null;
         if (!segmentationData)
             throw new Error('Segmentation data required when creating a new assignment');
-        return await this.generateUserAssignment(experiment, userId, segmentationData);
+        return await this.generateUserAssignment({ ...experiment, buckets }, userId, segmentationData);
     }
     /**
      * Get all existing user assignments
      *
-     * @param userId G
+     * @param userId
      * @returns
      */
     async getAllExistingUserAssignments(userId) {
-        return await this.client.userAssignment.findMany({ where: { userId } });
+        return await this.userAssignmentDao.getBy('userId', userId);
     }
     /**
      * Generate user assignments for all active experiments. Will return any existing and attempt to generate any new assignments.
@@ -151,19 +147,16 @@ class Abba {
      */
     async getExperimentAssignmentStatistics(experimentId) {
         const statistics = {
-            sampled: await this.client.userAssignment.count({ where: { experimentId } }),
+            sampled: await this.userAssignmentDao
+                .query()
+                .filterEq('experimentId', experimentId)
+                .runQueryCount(),
             buckets: {},
         };
-        const buckets = await this.client.bucket.findMany({ where: { experimentId } });
-        const assignmentCounts = await this.client.userAssignment.groupBy({
-            where: { experimentId },
-            by: ['bucketId'],
-            _count: {
-                _all: true,
-            },
-        });
-        buckets.forEach(({ id }) => {
-            statistics.buckets[`${id}`] = assignmentCounts.find(i => i.bucketId === id)?._count?._all || 0;
+        const buckets = await this.bucketDao.getBy('experimentId', experimentId);
+        await (0, js_lib_1.pMap)(buckets, async (bucket) => {
+            const count = this.userAssignmentDao.query().filterEq('bucketId', bucket.id);
+            statistics[bucket.id] = await this.userAssignmentDao.runQueryCount(count);
         });
         return statistics;
     }
@@ -179,9 +172,10 @@ class Abba {
         const segmentationMatch = (0, util_1.validateSegmentationRules)(experiment.rules, segmentationData);
         if (!segmentationMatch)
             return null;
-        const bucketId = (0, util_1.determineAssignment)(experiment.sampling, experiment.buckets);
-        return await this.client.userAssignment.create({
-            data: { userId, experimentId: experiment.id, bucketId },
+        return await this.userAssignmentDao.save({
+            userId,
+            experimentId: experiment.id,
+            bucketId: (0, util_1.determineAssignment)(experiment.sampling, experiment.buckets),
         });
     }
     /**
@@ -192,54 +186,9 @@ class Abba {
      * @returns
      */
     async getExistingUserAssignment(experimentId, userId) {
-        return await this.client.userAssignment.findFirst({ where: { userId, experimentId } });
-    }
-    /**
-     * Update experiment information
-     *
-     * @param id
-     * @param experiment
-     * @param rules
-     * @returns
-     */
-    async updateExperiment(id, experiment) {
-        return await this.client.experiment.update({
-            where: { id },
-            data: {
-                ...experiment,
-                rules: experiment.rules,
-            },
-        });
-    }
-    /**
-     * Upserts bucket info
-     *
-     * @param id
-     * @param experiment
-     * @returns
-     */
-    async saveBuckets(buckets) {
-        const savedBuckets = [];
-        for (const bucket of buckets) {
-            const { id, ...data } = bucket;
-            if (id) {
-                savedBuckets.push(this.client.bucket.update({ where: { id }, data }));
-            }
-            else {
-                savedBuckets.push(this.client.bucket.create({
-                    data: {
-                        key: data.key,
-                        ratio: data.ratio,
-                        experiment: {
-                            connect: {
-                                id: data.experimentId,
-                            },
-                        },
-                    },
-                }));
-            }
-        }
-        return await Promise.all(savedBuckets);
+        const assignments = await this.userAssignmentDao.getBy('userId', userId);
+        const assignment = assignments.find(assignment => assignment.experimentId === experimentId);
+        return assignment || null;
     }
 }
 exports.Abba = Abba;

package/dist/dao/bucket.dao.d.ts

@@ -0,0 +1,5 @@
+import { CommonDao, CommonDB } from '@naturalcycles/db-lib';
+import { Bucket } from '../types';
+export declare class BucketDao extends CommonDao<Bucket> {
+}
+export declare const bucketDao: (db: CommonDB) => BucketDao;

package/dist/dao/bucket.dao.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bucketDao = exports.BucketDao = void 0;
+const db_lib_1 = require("@naturalcycles/db-lib");
+class BucketDao extends db_lib_1.CommonDao {
+}
+exports.BucketDao = BucketDao;
+const bucketDao = (db) => new BucketDao({
+    db,
+    table: 'Bucket',
+    createId: false,
+    idType: 'number',
+    assignGeneratedIds: true,
+});
+exports.bucketDao = bucketDao;

package/dist/dao/experiment.dao.d.ts

@@ -0,0 +1,10 @@
+import { CommonDao, CommonDB } from '@naturalcycles/db-lib';
+import { Saved } from '@naturalcycles/js-lib';
+import { BaseExperiment, Experiment } from '../types';
+declare type ExperimentDBM = Saved<BaseExperiment> & {
+    rules: string | null;
+};
+export declare class ExperimentDao extends CommonDao<Experiment, ExperimentDBM> {
+}
+export declare const experimentDao: (db: CommonDB) => ExperimentDao;
+export {};

package/dist/dao/experiment.dao.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.experimentDao = exports.ExperimentDao = void 0;
+const db_lib_1 = require("@naturalcycles/db-lib");
+class ExperimentDao extends db_lib_1.CommonDao {
+}
+exports.ExperimentDao = ExperimentDao;
+const experimentDao = (db) => new ExperimentDao({
+    db,
+    table: 'Experiment',
+    createId: false,
+    idType: 'number',
+    assignGeneratedIds: true,
+    hooks: {
+        beforeBMToDBM: bm => ({ ...bm, rules: bm.rules.length ? JSON.stringify(bm.rules) : null }),
+        beforeDBMToBM: dbm => ({ ...dbm, rules: dbm.rules && JSON.parse(dbm.rules) }),
+    },
+});
+exports.experimentDao = experimentDao;

package/dist/dao/userAssignment.dao.d.ts

@@ -0,0 +1,5 @@
+import { CommonDao, CommonDB } from '@naturalcycles/db-lib';
+import { UserAssignment } from '../types';
+export declare class UserAssignmentDao extends CommonDao<UserAssignment> {
+}
+export declare const userAssignmentDao: (db: CommonDB) => UserAssignmentDao;

package/dist/dao/userAssignment.dao.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userAssignmentDao = exports.UserAssignmentDao = void 0;
+const db_lib_1 = require("@naturalcycles/db-lib");
+class UserAssignmentDao extends db_lib_1.CommonDao {
+}
+exports.UserAssignmentDao = UserAssignmentDao;
+const userAssignmentDao = (db) => new UserAssignmentDao({
+    db,
+    table: 'UserAssignment',
+    createId: false,
+    idType: 'number',
+    assignGeneratedIds: true,
+});
+exports.userAssignmentDao = userAssignmentDao;

package/dist/index.d.ts

@@ -1,3 +1,2 @@
-export type { Bucket, Experiment, UserAssignment } from './prisma-output';
 export * from './types';
 export { Abba } from './abba';

package/dist/index.js

@@ -2,6 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Abba = void 0;
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./types"), exports);
+tslib_1.__exportStar(require("./types"), exports);
 var abba_1 = require("./abba");
 Object.defineProperty(exports, "Abba", { enumerable: true, get: function () { return abba_1.Abba; } });

package/dist/migrations/init.sql

@@ -0,0 +1,47 @@
+-- CreateTable
+CREATE TABLE IF NOT EXISTS `Bucket` (
+    `id` INTEGER NOT NULL AUTO_INCREMENT,
+    `experimentId` INTEGER NOT NULL,
+    `key` VARCHAR(10) NOT NULL,
+    `ratio` INTEGER NOT NULL,
+    `created` INTEGER(11) NOT NULL,
+    `updated` INTEGER(11) NOT NULL,
+
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- CreateTable
+CREATE TABLE IF NOT EXISTS `Experiment` (
+    `id` INTEGER NOT NULL AUTO_INCREMENT,
+    `name` VARCHAR(191) NOT NULL,
+    `status` INTEGER NOT NULL,
+    `sampling` INTEGER NOT NULL,
+    `description` VARCHAR(240) NULL,
+    `created` INTEGER(11) NOT NULL,
+    `updated` INTEGER(11) NOT NULL,
+    `rules` JSON NULL,
+
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- CreateTable
+CREATE TABLE IF NOT EXISTS `UserAssignment` (
+    `id` INTEGER NOT NULL AUTO_INCREMENT,
+    `userId` VARCHAR(191) NOT NULL,
+    `experimentId` INTEGER NOT NULL,
+    `bucketId` INTEGER NULL,
+    `created` INTEGER(11) NOT NULL,
+    `updated` INTEGER(11) NOT NULL,
+
+    UNIQUE INDEX `UserAssignment_userId_experimentId_key`(`userId`, `experimentId`),
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+-- AddForeignKey
+ALTER TABLE `Bucket` ADD CONSTRAINT `Bucket_experimentId_fkey` FOREIGN KEY (`experimentId`) REFERENCES `Experiment`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE `UserAssignment` ADD CONSTRAINT `UserAssignment_bucketId_fkey` FOREIGN KEY (`bucketId`) REFERENCES `Bucket`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE `UserAssignment` ADD CONSTRAINT `UserAssignment_experimentId_fkey` FOREIGN KEY (`experimentId`) REFERENCES `Experiment`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;

package/dist/types.d.ts

@@ -1,12 +1,35 @@
-import { Bucket, Experiment } from './prisma-output';
-export declare type Unsaved<T> = Omit<T, 'createdAt' | 'updatedAt'> & {
-    id?: number;
+import { CommonDB } from '@naturalcycles/db-lib';
+import { BaseDBEntity, Saved } from '@naturalcycles/js-lib';
+export interface AbbaConfig {
+    db: CommonDB;
+}
+export declare type BaseExperiment = BaseDBEntity<number> & {
+    name: string;
+    status: number;
+    sampling: number;
+    description: string | null;
+};
+export declare type Experiment = BaseExperiment & {
+    rules: SegmentationRule[];
+};
+export declare type ExperimentWithBuckets = Saved<Experiment> & {
+    buckets: Saved<Bucket>[];
+};
+export interface BucketInput {
+    experimentId: number;
+    key: string;
+    ratio: number;
+}
+export declare type Bucket = BaseDBEntity<number> & {
+    experimentId: number;
+    key: string;
+    ratio: number;
 };
-export declare type ExperimentWithBuckets = Experiment & {
-    buckets: Bucket[];
+export declare type UserAssignment = BaseDBEntity<number> & {
+    userId: string;
+    experimentId: number;
+    bucketId: number | null;
 };
-export declare type ExperimentInput = Unsaved<Experiment>;
-export declare type BucketInput = Unsaved<Bucket>;
 export declare type SegmentationData = Record<string, string | boolean | number>;
 export declare enum AssignmentStatus {
     Active = 1,

package/dist/util.d.ts

@@ -1,5 +1,5 @@
-import { Bucket } from './prisma-output';
-import { BucketInput, SegmentationData, SegmentationRule } from '.';
+import { Saved } from '@naturalcycles/js-lib';
+import { Bucket, SegmentationData, SegmentationRule } from './types';
 /**
  * Generate a random number between 0 and 100
  *
@@ -13,21 +13,21 @@ export declare const rollDie: () => number;
  * @param buckets
  * @returns
  */
-export declare const determineAssignment: (sampling: number, buckets: Bucket[]) => number | null;
+export declare const determineAssignment: (sampling: number, buckets: Saved<Bucket>[]) => number | null;
 /**
  * Determines which bucket a user assignment will recieve
  *
  * @param buckets
  * @returns
  */
-export declare const determineBucket: (buckets: Bucket[]) => number;
+export declare const determineBucket: (buckets: Saved<Bucket>[]) => number;
 /**
  * Validate the total ratio of the buckets equals 100
  *
  * @param buckets
  * @returns
  */
-export declare const validateTotalBucketRatio: (buckets: BucketInput[]) => void;
+export declare const validateTotalBucketRatio: (buckets: Bucket[]) => void;
 /**
  * Validate a users segmentation data against multiple rules. Returns false if any fail
  *

package/package.json

@@ -1,22 +1,21 @@
 {
   "name": "@naturalcycles/abba",
-  "version": "1.6.0",
+  "version": "1.9.0",
   "scripts": {
     "prepare": "husky install",
-    "build": "build && npm run copy-prisma-output",
-    "build-prod": "build-prod && npm run copy-prisma-output",
-    "copy-prisma-output": "cp -R src/prisma-output dist"
+    "build": "build",
+    "build-prod": "build-prod"
   },
   "dependencies": {
-    "@prisma/client": "^3.9.2",
+    "@naturalcycles/db-lib": "^8.40.1",
+    "@naturalcycles/js-lib": "^14.98.2",
     "semver": "^7.3.5"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "^12.0.0",
+    "@naturalcycles/dev-lib": "^12.19.2",
     "@types/node": "^16.0.0",
     "@types/semver": "^7.3.9",
-    "jest": "^27.5.1",
-    "prisma": "^3.9.2"
+    "jest": "^27.5.1"
   },
   "files": [
     "dist",

package/readme.md

@@ -44,7 +44,7 @@
 
 ### Built With
 
-- [Prisma](https://www.prisma.io/)
+- [@naturalcycles/db-lib](https://github.com/NaturalCycles/db-lib)
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -77,9 +77,8 @@ This template doesn't rely on any external dependencies or services._
    npm install @naturalcyles/abba
    ```
 
-2. Execute the
-   [sql script found here](https://github.com/NaturalCycles/abba/blob/master/prisma/migrations/20220218075343_init/migration.sql)
-   to generate the required DB Schema
+2. Install the schema into your MySQL db instance using the migration script found
+   [here](https://github.com/NaturalCycles/abba/blob/master/src/migrations/init.sql).
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -91,14 +90,14 @@ This template doesn't rely on any external dependencies or services._
 
 ### Create an instance of Abba
 
-Creates an instance of Abba. You can pass in the database url in the constructor. If it does not
-exist it will fallback to trying to use the `ABBA_DB_URL` which must be added to your environment
-variables.
+(Currently supports MySQL, probably all DocumentDBs but not verified.)
 
 ```js
-const abba = new Abba('url')
-// or reading from process.env.ABBA_DB_URL
-const abba = new Abba()
+type AbbaConfig = {
+  db: CommonDB // from @naturalcycles/db-lib
+}
+
+const abba = new Abba(config: AbbaConfig)
 ```
 
 ### Create a new experiment
@@ -109,7 +108,7 @@ Creates a new experiment
 async createExperiment(
 	input: ExperimentInput,
 	buckets: BucketInput[]
-): Promise<Experiment>
+): Promise<Saved<Experiment>>
 ```
 
 ### Update an experiment
@@ -121,7 +120,7 @@ async updateExperiment(
 	id: number,
 	input: ExperimentInput,
 	buckets: BucketInput[]
-): Promise<Experiment>
+): Promise<Saved<Experiment>>
 ```
 
 ### Delete an experiment
@@ -141,7 +140,7 @@ Gets all existing user assignments
 ```js
 async getAllExistingUserAssignments(
 	userId: string
-): Promise<UserAssignment[]>
+): Promise<Saved<UserAssignment>[]>
 ```
 
 ### Get a users assignment
@@ -155,7 +154,7 @@ async getUserAssignment(
   userId: string,
   existingOnly: boolean,
   segmentationData?: SegmentationData,
-): Promise<UserAssignment | null>
+): Promise<Saved<UserAssignment> | null>
 ```
 
 ### Generate user assignments
@@ -167,7 +166,7 @@ attempt to generate new assignments.
 async generateUserAssignments(
   userId: string,
   segmentationData: SegmentationData,
-): Promise<UserAssignment[]>
+): Promise<Saved<UserAssignment>[]>
 ```
 
 ### Getting assignment statistics