@naturalcycles/abba 1.7.0 → 1.9.1

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,33 +1,21 @@
-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
- *
- * @returns
  */
 export declare const rollDie: () => number;
 /**
  * Determines a users assignment for this experiment. Returns null if they are not considered to be in the sampling group
- *
- * @param sampling
- * @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
  *
@@ -38,9 +26,5 @@ export declare const validateTotalBucketRatio: (buckets: BucketInput[]) => void;
 export declare const validateSegmentationRules: (rules: SegmentationRule[], segmentationData: SegmentationData) => boolean;
 /**
  * Validate a users segmentation data against a single rule
- *
- * @param rule
- * @param segmentationData
- * @returns
  */
 export declare const validateSegmentationRule: (rule: SegmentationRule, data: SegmentationData) => boolean;

package/dist/util.js

@@ -4,8 +4,6 @@ exports.validateSegmentationRule = exports.validateSegmentationRules = exports.v
 const semver_1 = require("semver");
 /**
  * Generate a random number between 0 and 100
- *
- * @returns
  */
 const rollDie = () => {
     return Math.random() * 100;
@@ -13,10 +11,6 @@ const rollDie = () => {
 exports.rollDie = rollDie;
 /**
  * Determines a users assignment for this experiment. Returns null if they are not considered to be in the sampling group
- *
- * @param sampling
- * @param buckets
- * @returns
  */
 const determineAssignment = (sampling, buckets) => {
     // Should this person be considered for the experiment?
@@ -29,9 +23,6 @@ const determineAssignment = (sampling, buckets) => {
 exports.determineAssignment = determineAssignment;
 /**
  * Determines which bucket a user assignment will recieve
- *
- * @param buckets
- * @returns
  */
 const determineBucket = (buckets) => {
     const bucketRoll = (0, exports.rollDie)();
@@ -55,9 +46,6 @@ const determineBucket = (buckets) => {
 exports.determineBucket = determineBucket;
 /**
  * Validate the total ratio of the buckets equals 100
- *
- * @param buckets
- * @returns
  */
 const validateTotalBucketRatio = (buckets) => {
     const bucketSum = buckets.reduce((sum, current) => sum + current.ratio, 0);
@@ -83,10 +71,6 @@ const validateSegmentationRules = (rules, segmentationData) => {
 exports.validateSegmentationRules = validateSegmentationRules;
 /**
  * Validate a users segmentation data against a single rule
- *
- * @param rule
- * @param segmentationData
- * @returns
  */
 const validateSegmentationRule = (rule, data) => {
     const { key, value, operator } = rule;

package/package.json

@@ -1,22 +1,22 @@
 {
   "name": "@naturalcycles/abba",
-  "version": "1.7.0",
+  "version": "1.9.1",
   "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.13.0",
+    "@naturalcycles/db-lib": "^8.40.1",
+    "@naturalcycles/js-lib": "^14.98.2",
+    "@naturalcycles/nodejs-lib": "^12.70.1",
     "semver": "^7.3.5"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "^12.0.0",
-    "@types/node": "^16.0.0",
+    "@naturalcycles/dev-lib": "^12.19.2",
+    "@types/node": "^17.0.34",
     "@types/semver": "^7.3.9",
-    "jest": "^27.5.1",
-    "prisma": "^3.13.0"
+    "jest": "^28.1.0"
   },
   "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