feat(infisical-pg): added database schema for project, its membership role and env

backend-pg/package.json

@@ -8,7 +8,7 @@
     "dev": "tsx watch --clear-screen=false ./src/main.ts  | pino-pretty --colorize --colorizeObjects --singleLine",
     "dev:docker": "nodemon",
     "build": "rimraf dist && tsup src --out-dir dist --loader '.handlebars=copy' --loader '.md=copy'",
-    "start": "node dist/server/app.js",
+    "start": "node dist/server/main.js",
     "type:check": "tsc --noEmit",
     "lint:fix": "eslint --fix --ext js,ts ./src",
     "lint": "eslint 'src/**/*.ts'",

backend-pg/src/@types/knex.d.ts

@@ -25,6 +25,17 @@ import {
   TOrgRoles,
   TOrgRolesInsert,
   TOrgRolesUpdate,
+  TProjectEnvironments,
+  TProjectEnvironmentsInsert,
+  TProjectMemberships,
+  TProjectMembershipsInsert,
+  TProjectMembershipsUpdate,
+  TProjectRoles,
+  TProjectRolesInsert,
+  TProjectRolesUpdate,
+  TProjects,
+  TProjectsInsert,
+  TProjectsUpdate,
   TSuperAdmin,
   TSuperAdminInsert,
   TSuperAdminUpdate,
@@ -89,5 +100,21 @@ declare module "knex/types/tables" {
       TSuperAdminUpdate
     >;
     [TableName.ApiKey]: Knex.CompositeTableType<TApiKeys, TApiKeysInsert, TApiKeysUpdate>;
+    [TableName.Project]: Knex.CompositeTableType<TProjects, TProjectsInsert, TProjectsUpdate>;
+    [TableName.ProjectMembership]: Knex.CompositeTableType<
+      TProjectMemberships,
+      TProjectMembershipsInsert,
+      TProjectMembershipsUpdate
+    >;
+    [TableName.Environment]: Knex.CompositeTableType<
+      TProjectEnvironments,
+      TProjectEnvironmentsInsert,
+      TPRo
+    >;
+    [TableName.ProjectRoles]: Knex.CompositeTableType<
+      TProjectRoles,
+      TProjectRolesInsert,
+      TProjectRolesUpdate
+    >;
   }
 }

backend-pg/src/db/migrations/20231204092747_org-membership.ts

@@ -33,7 +33,6 @@ export async function up(knex: Knex): Promise<void> {
       t.foreign("userId").references("id").inTable(TableName.Users).onDelete("CASCADE");
       t.uuid("orgId").notNullable();
       t.foreign("orgId").references("id").inTable(TableName.Organization).onDelete("CASCADE");
-      // until role is changed/removed the role should not deleted
       t.uuid("roleId");
       t.foreign("roleId").references("id").inTable(TableName.OrgRoles);
     });

backend-pg/src/db/migrations/20231212110939_project.ts

@@ -0,0 +1,33 @@
+import { Knex } from "knex";
+import { TableName } from "../schemas";
+import { createOnUpdateTrigger, dropOnUpdateTrigger } from "../utils";
+
+export async function up(knex: Knex): Promise<void> {
+  if (!(await knex.schema.hasTable(TableName.Project))) {
+    await knex.schema.createTable(TableName.Project, (t) => {
+      t.uuid("id", { primaryKey: true }).defaultTo(knex.fn.uuid());
+      t.string("name").notNullable();
+      t.boolean("autoCapitalization").defaultTo(true);
+      t.uuid("orgId").notNullable();
+      t.foreign("orgId").references("id").inTable(TableName.Organization).onDelete("CASCADE");
+      t.timestamps(true, true, true);
+    });
+  }
+  await createOnUpdateTrigger(knex, TableName.Project);
+  if (!(await knex.schema.hasTable(TableName.Environment))) {
+    await knex.schema.createTable(TableName.Environment, (t) => {
+      t.uuid("id", { primaryKey: true }).defaultTo(knex.fn.uuid());
+      t.string("name").notNullable();
+      t.string("slug").notNullable();
+      t.uuid("projectId").notNullable();
+      t.foreign("projectId").references("id").inTable(TableName.Project).onDelete("CASCADE");
+      t.timestamps(true, true, true);
+    });
+  }
+}
+
+export async function down(knex: Knex): Promise<void> {
+  await knex.schema.dropTableIfExists(TableName.Environment);
+  await knex.schema.dropTableIfExists(TableName.Project);
+  await dropOnUpdateTrigger(knex, TableName.Project);
+}

backend-pg/src/db/migrations/20231212110946_project-membership.ts

@@ -0,0 +1,42 @@
+import { Knex } from "knex";
+import { TableName } from "../schemas";
+import { createOnUpdateTrigger, dropOnUpdateTrigger } from "../utils";
+
+export async function up(knex: Knex): Promise<void> {
+  if (!(await knex.schema.hasTable(TableName.ProjectRoles))) {
+    await knex.schema.createTable(TableName.ProjectRoles, (t) => {
+      t.uuid("id", { primaryKey: true }).defaultTo(knex.fn.uuid());
+      t.string("name").notNullable();
+      t.string("description");
+      t.string("slug").notNullable();
+      t.jsonb("permissions").notNullable();
+      // does not need update trigger we will do it manually
+      t.timestamps(true, true, true);
+      t.uuid("projectId").notNullable();
+      t.foreign("projectId").references("id").inTable(TableName.ProjectRoles).onDelete("CASCADE");
+    });
+  }
+
+  if (!(await knex.schema.hasTable(TableName.ProjectMembership))) {
+    await knex.schema.createTable(TableName.ProjectMembership, (t) => {
+      t.uuid("id", { primaryKey: true }).defaultTo(knex.fn.uuid());
+      t.string("role").notNullable();
+      // does not need update trigger we will do it manually
+      t.timestamps(true, true, true);
+      t.uuid("userId").notNullable();
+      t.foreign("userId").references("id").inTable(TableName.Users).onDelete("CASCADE");
+      t.uuid("projectId").notNullable();
+      t.foreign("projectId").references("id").inTable(TableName.Project).onDelete("CASCADE");
+      // until role is changed/removed the role should not deleted
+      t.uuid("roleId");
+      t.foreign("roleId").references("id").inTable(TableName.ProjectRoles);
+    });
+  }
+  await createOnUpdateTrigger(knex, TableName.ProjectMembership);
+}
+
+export async function down(knex: Knex): Promise<void> {
+  await knex.schema.dropTableIfExists(TableName.ProjectMembership);
+  await knex.schema.dropTableIfExists(TableName.ProjectRoles);
+  await dropOnUpdateTrigger(knex, TableName.ProjectMembership);
+}

backend-pg/src/db/schemas/index.ts

@@ -7,6 +7,10 @@ export * from "./models";
 export * from "./org-memberships";
 export * from "./org-roles";
 export * from "./organizations";
+export * from "./project-environments";
+export * from "./project-memberships";
+export * from "./project-roles";
+export * from "./projects";
 export * from "./super-admin";
 export * from "./user-actions";
 export * from "./user-encryption-keys";

backend-pg/src/db/schemas/models.ts

@@ -12,7 +12,11 @@ export enum TableName {
   IncidentContact = "incident_contacts",
   UserAction = "user_actions",
   SuperAdmin = "super_admin",
-  ApiKey = "api_keys"
+  ApiKey = "api_keys",
+  Project = "projects",
+  Environment = "project_environments",
+  ProjectMembership = "project_memberships",
+  ProjectRoles = "project_roles"
 }
 
 export type TImmutableDBKeys = "id" | "createdAt" | "updatedAt";
@@ -36,6 +40,14 @@ export enum OrgMembershipStatus {
   Accepted = "accepted"
 }
 
+export enum ProjectMembershipRole {
+  Admin = "admin",
+  Member = "member",
+  Custom = "custom",
+  Viewer = "viewer",
+  NoAccess = "no-access"
+}
+
 export enum SecretEncryptionAlgo {
   AES_256_GCM = "aes-256-gcm"
 }

backend-pg/src/db/schemas/project-environments.ts

@@ -0,0 +1,21 @@
+// Code generated by automation script, DO NOT EDIT.
+// Automated by pulling database and generating zod schema
+// To update. Just run npm run generate:schema
+// Written by akhilmhdh.
+
+import { z } from "zod";
+
+import { TImmutableDBKeys } from "./models";
+
+export const ProjectEnvironmentsSchema = z.object({
+  id: z.string().uuid(),
+  name: z.string(),
+  slug: z.string(),
+  projectId: z.string().uuid(),
+  createdAt: z.date(),
+  updatedAt: z.date(),
+});
+
+export type TProjectEnvironments = z.infer<typeof ProjectEnvironmentsSchema>;
+export type TProjectEnvironmentsInsert = Omit<TProjectEnvironments, TImmutableDBKeys>;
+export type TProjectEnvironmentsUpdate = Partial<Omit<TProjectEnvironments, TImmutableDBKeys>>;

backend-pg/src/db/schemas/project-memberships.ts

@@ -0,0 +1,22 @@
+// Code generated by automation script, DO NOT EDIT.
+// Automated by pulling database and generating zod schema
+// To update. Just run npm run generate:schema
+// Written by akhilmhdh.
+
+import { z } from "zod";
+
+import { TImmutableDBKeys } from "./models";
+
+export const ProjectMembershipsSchema = z.object({
+  id: z.string().uuid(),
+  role: z.string(),
+  createdAt: z.date(),
+  updatedAt: z.date(),
+  userId: z.string().uuid(),
+  projectId: z.string().uuid(),
+  roleId: z.string().uuid().nullable().optional(),
+});
+
+export type TProjectMemberships = z.infer<typeof ProjectMembershipsSchema>;
+export type TProjectMembershipsInsert = Omit<TProjectMemberships, TImmutableDBKeys>;
+export type TProjectMembershipsUpdate = Partial<Omit<TProjectMemberships, TImmutableDBKeys>>;

backend-pg/src/db/schemas/project-roles.ts

@@ -0,0 +1,23 @@
+// Code generated by automation script, DO NOT EDIT.
+// Automated by pulling database and generating zod schema
+// To update. Just run npm run generate:schema
+// Written by akhilmhdh.
+
+import { z } from "zod";
+
+import { TImmutableDBKeys } from "./models";
+
+export const ProjectRolesSchema = z.object({
+  id: z.string().uuid(),
+  name: z.string(),
+  description: z.string().nullable().optional(),
+  slug: z.string(),
+  permissions: z.unknown(),
+  createdAt: z.date(),
+  updatedAt: z.date(),
+  projectId: z.string().uuid(),
+});
+
+export type TProjectRoles = z.infer<typeof ProjectRolesSchema>;
+export type TProjectRolesInsert = Omit<TProjectRoles, TImmutableDBKeys>;
+export type TProjectRolesUpdate = Partial<Omit<TProjectRoles, TImmutableDBKeys>>;

backend-pg/src/db/schemas/projects.ts

@@ -0,0 +1,21 @@
+// Code generated by automation script, DO NOT EDIT.
+// Automated by pulling database and generating zod schema
+// To update. Just run npm run generate:schema
+// Written by akhilmhdh.
+
+import { z } from "zod";
+
+import { TImmutableDBKeys } from "./models";
+
+export const ProjectsSchema = z.object({
+  id: z.string().uuid(),
+  name: z.string(),
+  autoCapitalization: z.boolean().default(true).nullable().optional(),
+  orgId: z.string().uuid(),
+  createdAt: z.date(),
+  updatedAt: z.date(),
+});
+
+export type TProjects = z.infer<typeof ProjectsSchema>;
+export type TProjectsInsert = Omit<TProjects, TImmutableDBKeys>;
+export type TProjectsUpdate = Partial<Omit<TProjects, TImmutableDBKeys>>;

backend-pg/src/db/utils.ts

@@ -33,11 +33,11 @@ DROP FUNCTION IF EXISTS on_update_timestamp() CASCADE;
 // remember to set `timestamps(true,true,true)` before this on schema
 export const createOnUpdateTrigger = (knex: Knex, tableName: string) =>
   knex.raw(`
-CREATE TRIGGER ${tableName}_updatedAt
+CREATE TRIGGER "${tableName}_updatedAt"
 BEFORE UPDATE ON ${tableName}
 FOR EACH ROW
 EXECUTE PROCEDURE on_update_timestamp();
 `);
 
 export const dropOnUpdateTrigger = (knex: Knex, tableName: string) =>
-  knex.raw(`DROP TRIGGER IF EXISTS ${tableName}_updatedAt ON ${tableName}`);
+  knex.raw(`DROP TRIGGER IF EXISTS "${tableName}_updatedAt" ON ${tableName}`);