@breign/db-schemas 0.1.0

package/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 100
+tab_width = 2

package/.gitlab-ci.yml

@@ -0,0 +1,51 @@
+image: node:22-alpine
+
+default:
+  tags:
+    - cluster
+
+stages:
+  - setup
+  - build
+  - publish
+
+install:
+  stage: setup
+  script:
+    - npm ci
+  cache:
+    key: ${CI_COMMIT_REF_SLUG}
+    paths:
+      - node_modules/
+  only:
+    - main
+
+build:
+  stage: build
+  script:
+    - npm run build
+  artifacts:
+    paths:
+      - dist/
+  cache:
+    key: ${CI_COMMIT_REF_SLUG}
+    paths:
+      - node_modules/
+    policy: pull
+  only:
+    - main
+
+publish:
+  stage: publish
+  script:
+    - echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > .npmrc
+    - NEW_VERSION=$(./scripts/compute-package-version.sh)
+    - npm version $NEW_VERSION --no-git-tag-version --allow-same-version
+    - npm publish --access public
+  cache:
+    key: ${CI_COMMIT_REF_SLUG}
+    paths:
+      - node_modules/
+    policy: pull
+  only:
+    - main

package/.nvmrc

@@ -0,0 +1 @@
+v22.13.1

package/.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  semi: true,
+  trailingComma: 'all',
+  singleQuote: true,
+  tabWidth: 2,
+};

package/README.md

@@ -0,0 +1,19 @@
+# Brain DB Schemas
+
+This repository contains the database schema definitions for the Brain project. These schemas are used to define the structure of data stored and managed within the Brain ecosystem.
+
+## Usage
+
+Specific instructions for using or contributing to these schemas will depend on the exact technology and integration with other Brain components. Generally, these schemas serve as the foundation for data consistency across the system.
+
+## Local Development with @breign/client
+
+This project depends on the `@breign/client` package. Several utility scripts are available to manage this dependency:
+
+### Available Scripts
+
+- `npm run link-project:client`: Links the local `@breign/client` project for development
+- `npm run install-latest:client`: Installs the latest published version of `@breign/client`
+- `npm run reinstall:client`: Reinstalls the `@breign/client` package (useful for resolving dependency issues)
+
+To work with a local version of `@breign/client`, use the `link-project:client` script. For production builds, use `install-latest:client` to ensure you're using the latest published version.

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);

package/dist/types/agent.d.ts

@@ -0,0 +1,80 @@
+import { AgentModuleTypeUio, AgentTypeUio } from '@breign/client';
+import { FlowNode } from './flow';
+export type Agent = {
+    id: string;
+    name: string;
+    engine?: AgentEngine;
+    organisationId: string;
+    modules: {
+        [name: string]: AgentModule;
+    };
+    tools?: AgentTool[];
+    knowledgeBaseIds: string[];
+    persona: {
+        default: string;
+    };
+    promptInit: {
+        [lang: string]: string;
+        default: string;
+    };
+    flow?: FlowNode['id'] | null;
+    subscription?: AgentSubscription;
+    speechOverrides?: {
+        [text: string]: string;
+    };
+    profilePicture?: string;
+    role?: string;
+    defaultLanguage?: string;
+    description?: string;
+    template?: string;
+    isTemplate?: boolean;
+    color?: string;
+    picture?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    isActivated?: boolean;
+    agentType?: AgentTypeUio;
+};
+export type AgentKnowledgeBase = {
+    id: string;
+    name: string;
+    privacy: 'private' | 'public';
+    organisationId: string;
+    authorizedAgents: string[];
+};
+export type AgentEngine = {
+    providerId: string;
+    model: string;
+};
+export type AgentModule = {
+    type: AgentModuleTypeUio;
+    name: string;
+    configuration: Record<string, any>;
+    restricted?: boolean;
+};
+export type AgentTool = {
+    id: string;
+    name: string;
+    type: string;
+    orgId: string;
+    description: string;
+    configuration?: Record<string, unknown>;
+    manifest?: Record<string, unknown>;
+    restricted?: boolean;
+};
+export type AgentSubscription = {
+    textInteractions: Interaction;
+    voiceInteractions: Interaction;
+    canGoBeyondIncluded: boolean;
+    startDate?: Date;
+    endDate?: Date;
+};
+export type Interaction = {
+    included: number;
+    additional: Additional;
+};
+export type Additional = {
+    price: string;
+    amountForPrice: string;
+    currency: string;
+};

package/dist/types/agent.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/engine.d.ts

@@ -0,0 +1,12 @@
+import { ProviderTypeUio } from '@breign/client';
+export type Provider = {
+    id: string;
+    name: string;
+    providerType: ProviderTypeUio;
+    models: string[];
+    apiKey: string;
+    endpoint?: string;
+    createdAt: Date;
+    organizationId: string;
+};
+export type ProviderSimple = Pick<Provider, 'id' | 'name' | 'providerType' | 'models'>;

package/dist/types/engine.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/file.d.ts

@@ -0,0 +1,11 @@
+import { FileStatusUio } from '@breign/client';
+export type File = {
+    id: string;
+    contentType: string;
+    ext: string;
+    hash: string;
+    size: number;
+    key: string;
+    createdAt: string;
+    status: FileStatusUio;
+};

package/dist/types/file.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/flow.d.ts

@@ -0,0 +1,68 @@
+export type FlowNode = {
+    id: string;
+    brainId: string;
+    entrypoints?: {
+        nodes?: string[];
+        intents: string[];
+    };
+    exits?: FlowNodeExits;
+    contents?: FlowNodeContents;
+    options?: {
+        conditions: {
+            [property: string]: Record<string, any>;
+        };
+        exits?: FlowNodeExits;
+        contents?: FlowNodeContents;
+    }[];
+};
+export type FlowNodeContents = {
+    rephrase?: boolean;
+    text?: string;
+    texts?: string[];
+    instructions?: string;
+    tools?: {
+        /**
+         * Prevents the agent from using any tools other than those listed when at this node.
+         * Any tools marked as `restricted` listed in `exclusive` will be allowed as well (even if not specified in the `allowed` array).
+         */
+        exclusive?: string[];
+        /**
+         * Prevents the agent from using the tools listed when at this node.
+         */
+        forbidden?: string[];
+        /**
+         * By default, tools marked as `restricted` cannot be used by the agent. If a tool is listed in the `allowed` array, the agent can use it when at this node.
+         */
+        allowed?: string[];
+    };
+    suggestions?: {
+        id: string;
+        text: string;
+    }[];
+};
+export type FlowNodeExits = {
+    nodes?: string[];
+    /**
+     * Will force the brain to choose one of the nodes in the nodes array, or default to the defaultExitNode.
+     */
+    forceNodes?: boolean;
+    /**
+     * If forceNode is true, and no node intent match from the nodes array, the defaultExitNode will be used.
+     */
+    defaultExitNode?: string;
+    /**
+     * Add requirements to allow leaving the node. As long as the requirements are not met, the agent will not continue forward and will remain at this node
+     * attempting to fulfill the requirements, staying into a loop.
+     */
+    requirements?: {
+        maxIterations?: 5;
+        /**
+         * If the maxIterations is reached without satisfying the requirements, the agent will be forced to go to the onFailure node.
+         * The onFailure node doesn't have to be listed in the exits nodes array.
+         */
+        onFailure?: string;
+        evaluation: {
+            instructions: string[];
+        };
+    };
+};

package/dist/types/flow.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from './agent';
+export * from './flow';
+export * from './file';
+export * from './engine';
+export * from './knowledge';
+export * from './organization';
+export * from './user';

package/dist/types/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./agent"), exports);
+__exportStar(require("./flow"), exports);
+__exportStar(require("./file"), exports);
+__exportStar(require("./engine"), exports);
+__exportStar(require("./knowledge"), exports);
+__exportStar(require("./organization"), exports);
+__exportStar(require("./user"), exports);

package/dist/types/knowledge.d.ts

@@ -0,0 +1,36 @@
+import { Agent } from './agent';
+import { FileStatusUio } from '@breign/client';
+export type KnowledgeBaseModule = {
+    type: string;
+    name: string;
+    configuration: {
+        [key: string]: unknown;
+    };
+};
+export type KnowledgeBase = {
+    id: string;
+    name: string;
+    organizationId: string;
+    authorizedAgents: Agent['id'][];
+    modules: {
+        [moduleName: string]: KnowledgeBaseModule;
+    };
+    createdAt: string;
+    updatedAt: string;
+};
+export type Knowledge = {
+    id: string;
+    knowledgeBaseId: string;
+    key: string;
+    name: string;
+    uploadId?: string;
+    postURL?: string;
+    formData?: string;
+    contentType?: string;
+    ext?: string;
+    size?: number;
+    hash?: string;
+    status: FileStatusUio;
+    createdAt: string;
+    updatedAt: string;
+};

package/dist/types/knowledge.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/organization.d.ts

@@ -0,0 +1,13 @@
+export type Organization = {
+    id: string;
+    slug: string;
+    name: string;
+    engine?: {
+        providerId: string;
+        model: string;
+    };
+    users: {
+        id: string;
+        role: 'admin' | 'user' | string;
+    }[];
+};

package/dist/types/organization.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/user.d.ts

@@ -0,0 +1,20 @@
+export type ApiKey = {
+    id: string;
+    name: string;
+    keySecret: string;
+};
+export type User = {
+    id: string;
+    user: {
+        email: string;
+    };
+    isAdmin: boolean;
+    canCreateAgents: boolean;
+    maxAgents?: number;
+    agents: string[];
+    allAgents: boolean;
+    apiKeys: ApiKey[];
+    createdAt: string;
+    locked?: boolean;
+    lockDate?: string;
+};

package/dist/types/user.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@breign/db-schemas",
+  "version": "0.1.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc -w",
+    "link-project:client": "zx scripts/link-project.mjs",
+    "install-latest:client": "zx scripts/install-latest-client.mjs",
+    "reinstall:client": "zx scripts/reinstall-client.mjs"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "@breign/client": "^1.0.11",
+    "prettier": "^3.5.3",
+    "zx": "^8.5.5"
+  }
+}

package/scripts/compute-package-version.sh

@@ -0,0 +1,14 @@
+CURRENT_VERSION=$(npm view @breign/db-schemas version || echo "0.1.0")
+LOCAL_VERSION=$(node -p "require('./package.json').version")
+LOCAL_MAJOR=$(echo $LOCAL_VERSION | cut -d. -f1)
+LOCAL_MINOR=$(echo $LOCAL_VERSION | cut -d. -f2)
+CURRENT_MAJOR=$(echo $CURRENT_VERSION | cut -d. -f1)
+CURRENT_MINOR=$(echo $CURRENT_VERSION | cut -d. -f2)
+CURRENT_PATCH=$(echo $CURRENT_VERSION | cut -d. -f3)
+
+if [ "$LOCAL_MAJOR" -eq "$CURRENT_MAJOR" ] && [ "$LOCAL_MINOR" -eq "$CURRENT_MINOR" ]; then
+  NEW_VERSION="$CURRENT_MAJOR.$(($CURRENT_MINOR)).$((CURRENT_PATCH + 1))"
+else
+  NEW_VERSION="$LOCAL_MAJOR.$LOCAL_MINOR.0"
+fi
+echo "$NEW_VERSION"

package/scripts/install-latest-client.mjs

@@ -0,0 +1,10 @@
+#!/usr/bin/env zx
+import { $, echo, spinner } from 'zx';
+
+echo(`Installing latest version of @breign/client`);
+
+await spinner(async () => {
+  await $`yalc remove @breign/client`;
+  await $`npm uninstall @breign/client`;
+  await $`npm install @breign/client`;
+});

package/scripts/link-project.mjs

@@ -0,0 +1,18 @@
+#!/usr/bin/env zx
+import { echo, spinner, $, cd } from 'zx';
+import path from 'path';
+
+echo('Linking Brain Client local package');
+
+// get project path
+const currentPath = path.resolve(path.dirname('.'));
+
+// change directory back to current directory
+cd(path.join(currentPath, '..', 'brain-client'));
+
+echo('Publish local package');
+await spinner(() => $`yalc publish`);
+
+cd(currentPath);
+echo('Installing local package');
+await spinner(() => $`yalc add @breign/client`);

package/scripts/reinstall-client.mjs

@@ -0,0 +1,22 @@
+#!/usr/bin/env zx
+import path from 'node:path';
+import { $, echo, fs, spinner } from 'zx';
+
+(async () => {
+  await $`yalc remove @breign/client`;
+  const { dependencies } = await fs.readJSON(
+    path.join(path.dirname('..'), 'package.json')
+  );
+  const cleanedVersion = String(
+    dependencies['@breign/client']
+  ).replace('^', '');
+
+  echo(
+    `Reinstalling version "${cleanedVersion}" of @breign/client`
+  );
+
+  await spinner(async () => {
+    await $`npm uninstall @breign/client`;
+    await $`npm install @breign/client@${cleanedVersion}`;
+  });
+})();

package/src/index.ts

@@ -0,0 +1 @@
+export * from './types';

package/src/types/agent.ts

@@ -0,0 +1,83 @@
+import { AgentModuleTypeUio, AgentTypeUio } from '@breign/client';
+import { FlowNode } from './flow';
+
+export type Agent = {
+  id: string;
+  name: string;
+  engine?: AgentEngine;
+  organisationId: string;
+  modules: { [name: string]: AgentModule };
+  tools?: AgentTool[];
+  knowledgeBaseIds: string[];
+  persona: { default: string };
+  promptInit: { [lang: string]: string; default: string };
+  flow?: FlowNode['id'] | null;
+  subscription?: AgentSubscription;
+  /*
+   * The following properties are used to override the default speech synthesis pronounciation of certain words.
+   * Exemple: { "mehera": "mera" }
+   */
+  speechOverrides?: { [text: string]: string };
+  profilePicture?: string;
+  role?: string;
+  defaultLanguage?: string;
+  description?: string;
+  template?: string;
+  isTemplate?: boolean;
+  color?: string;
+  picture?: string;
+  createdAt?: string;
+  updatedAt?: string;
+  isActivated?: boolean;
+  agentType?: AgentTypeUio;
+};
+
+export type AgentKnowledgeBase = {
+  id: string;
+  name: string;
+  privacy: 'private' | 'public';
+  organisationId: string;
+  authorizedAgents: string[];
+};
+
+export type AgentEngine = {
+  providerId: string;
+  model: string;
+};
+
+export type AgentModule = {
+  type: AgentModuleTypeUio;
+  name: string;
+  configuration: Record<string, any>;
+  restricted?: boolean;
+};
+
+export type AgentTool = {
+  id: string;
+  name: string;
+  type: string;
+  orgId: string;
+  description: string;
+  configuration?: Record<string, unknown>;
+  manifest?: Record<string, unknown>;
+  restricted?: boolean;
+};
+
+export type AgentSubscription = {
+  textInteractions: Interaction;
+  voiceInteractions: Interaction;
+  canGoBeyondIncluded: boolean;
+  startDate?: Date;
+  endDate?: Date;
+};
+
+export type Interaction = {
+  included: number;
+  additional: Additional;
+};
+
+export type Additional = {
+  price: string;
+  amountForPrice: string;
+  currency: string;
+};

package/src/types/engine.ts

@@ -0,0 +1,14 @@
+import { ProviderTypeUio } from '@breign/client';
+
+export type Provider = {
+  id: string;
+  name: string;
+  providerType: ProviderTypeUio;
+  models: string[];
+  apiKey: string;
+  endpoint?: string; // TODO: mandatory ?
+  createdAt: Date;
+  organizationId: string;
+};
+
+export type ProviderSimple = Pick<Provider, 'id' | 'name' | 'providerType' | 'models'>;

package/src/types/file.ts

@@ -0,0 +1,12 @@
+import { FileStatusUio } from '@breign/client';
+
+export type File = {
+  id: string;
+  contentType: string;
+  ext: string;
+  hash: string;
+  size: number;
+  key: string;
+  createdAt: string;
+  status: FileStatusUio;
+};

package/src/types/flow.ts

@@ -0,0 +1,72 @@
+export type FlowNode = {
+  id: string;
+  brainId: string;
+  entrypoints?: {
+    nodes?: string[];
+    intents: string[];
+  };
+  exits?: FlowNodeExits;
+  contents?: FlowNodeContents;
+  options?: {
+    conditions: { [property: string]: Record<string, any> };
+    exits?: FlowNodeExits;
+    contents?: FlowNodeContents;
+  }[];
+};
+
+export type FlowNodeContents = {
+  rephrase?: boolean;
+  text?: string;
+  texts?: string[];
+  instructions?: string;
+  tools?: {
+    /**
+     * Prevents the agent from using any tools other than those listed when at this node.
+     * Any tools marked as `restricted` listed in `exclusive` will be allowed as well (even if not specified in the `allowed` array).
+     */
+    exclusive?: string[];
+
+    /**
+     * Prevents the agent from using the tools listed when at this node.
+     */
+    forbidden?: string[];
+
+    /**
+     * By default, tools marked as `restricted` cannot be used by the agent. If a tool is listed in the `allowed` array, the agent can use it when at this node.
+     */
+    allowed?: string[];
+  };
+  suggestions?: {
+    id: string;
+    text: string;
+  }[];
+};
+
+export type FlowNodeExits = {
+  nodes?: string[];
+  /**
+   * Will force the brain to choose one of the nodes in the nodes array, or default to the defaultExitNode.
+   */
+  forceNodes?: boolean;
+  /**
+   * If forceNode is true, and no node intent match from the nodes array, the defaultExitNode will be used.
+   */
+  defaultExitNode?: string;
+
+  /**
+   * Add requirements to allow leaving the node. As long as the requirements are not met, the agent will not continue forward and will remain at this node
+   * attempting to fulfill the requirements, staying into a loop.
+   */
+  requirements?: {
+    maxIterations?: 5; // Maximum number of iterations to perform before the agent is forced to abandon the node.
+
+    /**
+     * If the maxIterations is reached without satisfying the requirements, the agent will be forced to go to the onFailure node.
+     * The onFailure node doesn't have to be listed in the exits nodes array.
+     */
+    onFailure?: string;
+    evaluation: {
+      instructions: string[]; // // A set of instructions to evaluate the requirements. If each instruction is satisfied (check by AI), the agent can leave the node.
+    };
+  };
+};

package/src/types/index.ts

@@ -0,0 +1,7 @@
+export * from './agent';
+export * from './flow';
+export * from './file';
+export * from './engine';
+export * from './knowledge';
+export * from './organization';
+export * from './user';

package/src/types/knowledge.ts

@@ -0,0 +1,38 @@
+import { Agent } from './agent';
+import { FileStatusUio } from '@breign/client';
+
+export type KnowledgeBaseModule = {
+  type: string;
+  name: string;
+  configuration: { [key: string]: unknown };
+};
+
+export type KnowledgeBase = {
+  id: string;
+  name: string;
+  organizationId: string;
+  authorizedAgents: Agent['id'][];
+  modules: { [moduleName: string]: KnowledgeBaseModule };
+  createdAt: string;
+  updatedAt: string;
+};
+
+export type Knowledge = {
+  id: string;
+  knowledgeBaseId: string;
+  key: string;
+  name: string;
+
+  uploadId?: string;
+  postURL?: string;
+  formData?: string;
+  contentType?: string;
+  ext?: string;
+  size?: number;
+  hash?: string;
+
+  status: FileStatusUio;
+
+  createdAt: string;
+  updatedAt: string;
+};

package/src/types/organization.ts

@@ -0,0 +1,13 @@
+export type Organization = {
+  id: string;
+  slug: string;
+  name: string;
+  engine?: {
+    providerId: string;
+    model: string;
+  };
+  users: {
+    id: string;
+    role: 'admin' | 'user' | string;
+  }[];
+};

package/src/types/user.ts

@@ -0,0 +1,21 @@
+export type ApiKey = {
+  id: string;
+  name: string;
+  keySecret: string;
+};
+
+export type User = {
+  id: string;
+  user: {
+    email: string;
+  };
+  isAdmin: boolean;
+  canCreateAgents: boolean;
+  maxAgents?: number;
+  agents: string[];
+  allAgents: boolean;
+  apiKeys: ApiKey[];
+  createdAt: string;
+  locked?: boolean;
+  lockDate?: string;
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "commonjs",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "declaration": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules"]
+}