@prisma/studio-core 0.0.0-dev.202503182320

package/data/adapter/Adapter.ts

@@ -0,0 +1,145 @@
+export type Either<E, R> = [E] | [null, R];
+
+export interface Adapter {
+  introspect(): Promise<Either<Error, InstrospectResult>>;
+  query(input: QueryInput): Promise<Either<Error, QueryResult>>;
+  mutate(inputs: MutateInput[]): Promise<Either<Error, MutateResult>>;
+  alter(inputs: AlterInput[]): Promise<Either<Error, AlterResult>>;
+  rawQuery(input: RawQueryInput): Promise<Either<Error, RawQueryResult>>;
+}
+
+export type EnumName = string;
+export type TableName = string;
+export type ColumnName = string;
+export type SchemaName = string;
+
+export type InstrospectResult = {
+  schemas: Record<SchemaName, InstrospectSchemaMeta>;
+  filters: Record<QueryFilterOperator, boolean>;
+}
+
+export type InstrospectSchemaMeta = {
+  tables: Record<TableName, InstrospectTableMeta>;
+  enums: Record<EnumName, EnumMeta>
+}
+
+export type InstrospectTableMeta = {
+  schema: SchemaName;
+  name: TableName;
+  columns: Record<ColumnName, InstrospectColumnMeta>;
+}
+
+export type InstrospectColumnMeta = {
+  schema: SchemaName;
+  table: TableName;
+  name: ColumnName;
+  dataType: IntrospectDataType;
+  uiType: IntrospectUiType;
+  defaults: unknown;
+  nullable: boolean;
+  partOfPk: boolean;
+  reference: InstrospectTableMeta | null;
+}
+
+export type IntrospectDataType = {
+  name: string;
+  args: (string | number)[];
+}
+
+export type IntrospectUiType =
+  | {
+    kind: 'string'
+    isList: boolean;
+    max: number;
+    min: number;
+  }
+  | {
+    kind: 'number'
+    isList: boolean;
+    max: number;
+    min: number;
+  }
+  | {
+    kind: 'decimal'
+    isList: boolean;
+    max: number;
+    min: number;
+    decimalPlaces: number;
+  }
+  | {
+    kind: 'boolean'
+    isList: boolean;
+  }
+  | {
+    kind: 'datetime'
+    isList: boolean;
+  }
+  | {
+    kind: 'json'
+    isList: boolean;
+  }
+  | {
+    kind: 'blob'
+    isList: boolean;
+  }
+  | {
+    kind: 'enum'
+    isList: boolean;
+    name: EnumName;
+    values: string[];
+  }
+
+export type EnumMeta = {
+  name: EnumName;
+  values: string[];
+}
+
+export type QueryInput = {
+  schema: SchemaName;
+  table: TableName;
+  filters: QueryFilter[][];
+  sortings: QuerySorting[];
+  limit?: number;
+  offset?: number;
+}
+
+export type QueryFilter = {
+  column: ColumnName;
+  operator: QueryFilterOperator;
+  value: unknown[] | InstrospectColumnMeta[];
+  not?: boolean;
+}
+
+export type QuerySorting = {
+  column: ColumnName;
+  order: 'asc' | 'desc';
+}
+
+export type QueryFilterOperator = '=' | '>=' | '>' | '<=' | '<' | 'like' | 'ilike' | 'is null' | (string & {})
+
+export type QueryResult = {
+  schema: SchemaName;
+  table: TableName;
+  fetchedAt: number;
+  duration: number;
+  rows: Record<ColumnName, QueryResultColumn>[]
+  count: number;
+}
+
+export type QueryResultColumn = {
+  column: ColumnName;
+  value: unknown;
+  dataType?: IntrospectDataType;
+  uiType?: IntrospectUiType;
+}
+
+// TODO: Implement the following types
+
+export type MutateInput = {}
+export type MutateResult = {}
+
+export type AlterInput = {}
+export type AlterResult = {}
+
+export type RawQueryInput = {}
+export type RawQueryResult = {}

package/data/adapter/AdapterMock.ts

@@ -0,0 +1,201 @@
+import { Adapter, AlterInput, AlterResult, Either, InstrospectResult, MutateInput, MutateResult, QueryInput, QueryResult, RawQueryInput, RawQueryResult } from "./Adapter";
+
+export class AdapterMock implements Adapter {
+  async introspect(): Promise<Either<Error, InstrospectResult>> {
+    return [null, {
+      schemas: {
+        public: {
+          tables: {
+            users: {
+              schema: "public",
+              name: "users",
+              columns: {
+                id: {
+                  schema: "public",
+                  table: "users",
+                  name: "id",
+                  dataType: { name: "integer", args: [] },
+                  uiType: { kind: "number", isList: false, max: 10000, min: 0 },
+                  defaults: null,
+                  nullable: false,
+                  partOfPk: true,
+                  reference: null,
+                },
+                name: {
+                  schema: "public",
+                  table: "users",
+                  name: "name",
+                  dataType: { name: "varchar", args: [255] },
+                  uiType: { kind: "string", isList: false, max: 255, min: 0 },
+                  defaults: null,
+                  nullable: false,
+                  partOfPk: false,
+                  reference: null,
+                },
+                role: {
+                  schema: "public",
+                  table: "users",
+                  name: "role",
+                  dataType: { name: "enum", args: [] },
+                  uiType: {
+                    kind: "enum",
+                    isList: false,
+                    name: "UserRole",
+                    values: ["admin", "user", "guest"],
+                  },
+                  defaults: "user",
+                  nullable: false,
+                  partOfPk: false,
+                  reference: null,
+                },
+              },
+            },
+            posts: {
+              schema: "public",
+              name: "posts",
+              columns: {
+                id: {
+                  schema: "public",
+                  table: "posts",
+                  name: "id",
+                  dataType: { name: "integer", args: [] },
+                  uiType: { kind: "number", isList: false, max: 10000, min: 0 },
+                  defaults: null,
+                  nullable: false,
+                  partOfPk: true,
+                  reference: null,
+                },
+                title: {
+                  schema: "public",
+                  table: "posts",
+                  name: "title",
+                  dataType: { name: "varchar", args: [255] },
+                  uiType: { kind: "string", isList: false, max: 255, min: 0 },
+                  defaults: null,
+                  nullable: false,
+                  partOfPk: false,
+                  reference: null,
+                },
+                content: {
+                  schema: "public",
+                  table: "posts",
+                  name: "content",
+                  dataType: { name: "text", args: [] },
+                  uiType: { kind: "string", isList: false, max: 10000, min: 0 },
+                  defaults: null,
+                  nullable: true,
+                  partOfPk: false,
+                  reference: null,
+                },
+                userId: {
+                  schema: "public",
+                  table: "posts",
+                  name: "userId",
+                  dataType: { name: "integer", args: [] },
+                  uiType: { kind: "number", isList: false, max: 10000, min: 0 },
+                  defaults: null,
+                  nullable: false,
+                  partOfPk: false,
+                  reference: {
+                    schema: "public",
+                    name: "users",
+                    columns: {}, // This can be expanded if needed.
+                  },
+                },
+              },
+            },
+          },
+          enums: {
+            UserRole: {
+              name: "UserRole",
+              values: ["admin", "user", "guest"],
+            },
+          },
+        },
+      },
+      filters: {
+        "=": true,
+        ">=": true,
+        ">": true,
+        "<=": true,
+        "<": true,
+        "like": true,
+        "ilike": false,
+        "is null": true,
+      },
+    }]
+  }
+  async query(input: QueryInput): Promise<Either<Error, QueryResult>> {
+    return [
+      null,
+      {
+        schema: "public",
+        table: "users",
+        fetchedAt: Date.now(),
+        duration: 35,
+        count: 2,
+        rows: [
+          {
+            id: {
+              column: "id",
+              value: 1,
+              dataType: { name: "integer", args: [] },
+              uiType: { kind: "number", isList: false, max: 10000, min: 0 },
+            },
+            name: {
+              column: "name",
+              value: "Alice",
+              dataType: { name: "varchar", args: [255] },
+              uiType: { kind: "string", isList: false, max: 255, min: 0 },
+            },
+            role: {
+              column: "role",
+              value: "admin",
+              dataType: { name: "enum", args: [] },
+              uiType: {
+                kind: "enum",
+                isList: false,
+                name: "UserRole",
+                values: ["admin", "user", "guest"],
+              },
+            },
+          },
+          {
+            id: {
+              column: "id",
+              value: 2,
+              dataType: { name: "integer", args: [] },
+              uiType: { kind: "number", isList: false, max: 10000, min: 0 },
+            },
+            name: {
+              column: "name",
+              value: "Bob",
+              dataType: { name: "varchar", args: [255] },
+              uiType: { kind: "string", isList: false, max: 255, min: 0 },
+            },
+            role: {
+              column: "role",
+              value: "user",
+              dataType: { name: "enum", args: [] },
+              uiType: {
+                kind: "enum",
+                isList: false,
+                name: "UserRole",
+                values: ["admin", "user", "guest"],
+              },
+            },
+          },
+        ],
+      },
+    ]
+  }
+  async mutate(inputs: MutateInput[]): Promise<Either<Error, MutateResult>> {
+    throw new Error("Method not implemented.");
+  }
+  async alter(inputs: AlterInput[]): Promise<Either<Error, AlterResult>> {
+    throw new Error("Method not implemented.");
+  }
+  async rawQuery(input: RawQueryInput): Promise<Either<Error, RawQueryResult>> {
+    throw new Error("Method not implemented.");
+  }
+}

package/data/index.ts

@@ -0,0 +1,2 @@
+export { type Adapter } from './adapter/Adapter';
+export { AdapterMock } from './adapter/AdapterMock';

package/dist/data/index.d.ts

@@ -0,0 +1,127 @@
+type Either<E, R> = [E] | [null, R];
+interface Adapter {
+    introspect(): Promise<Either<Error, InstrospectResult>>;
+    query(input: QueryInput): Promise<Either<Error, QueryResult>>;
+    mutate(inputs: MutateInput[]): Promise<Either<Error, MutateResult>>;
+    alter(inputs: AlterInput[]): Promise<Either<Error, AlterResult>>;
+    rawQuery(input: RawQueryInput): Promise<Either<Error, RawQueryResult>>;
+}
+type EnumName = string;
+type TableName = string;
+type ColumnName = string;
+type SchemaName = string;
+type InstrospectResult = {
+    schemas: Record<SchemaName, InstrospectSchemaMeta>;
+    filters: Record<QueryFilterOperator, boolean>;
+};
+type InstrospectSchemaMeta = {
+    tables: Record<TableName, InstrospectTableMeta>;
+    enums: Record<EnumName, EnumMeta>;
+};
+type InstrospectTableMeta = {
+    schema: SchemaName;
+    name: TableName;
+    columns: Record<ColumnName, InstrospectColumnMeta>;
+};
+type InstrospectColumnMeta = {
+    schema: SchemaName;
+    table: TableName;
+    name: ColumnName;
+    dataType: IntrospectDataType;
+    uiType: IntrospectUiType;
+    defaults: unknown;
+    nullable: boolean;
+    partOfPk: boolean;
+    reference: InstrospectTableMeta | null;
+};
+type IntrospectDataType = {
+    name: string;
+    args: (string | number)[];
+};
+type IntrospectUiType = {
+    kind: 'string';
+    isList: boolean;
+    max: number;
+    min: number;
+} | {
+    kind: 'number';
+    isList: boolean;
+    max: number;
+    min: number;
+} | {
+    kind: 'decimal';
+    isList: boolean;
+    max: number;
+    min: number;
+    decimalPlaces: number;
+} | {
+    kind: 'boolean';
+    isList: boolean;
+} | {
+    kind: 'datetime';
+    isList: boolean;
+} | {
+    kind: 'json';
+    isList: boolean;
+} | {
+    kind: 'blob';
+    isList: boolean;
+} | {
+    kind: 'enum';
+    isList: boolean;
+    name: EnumName;
+    values: string[];
+};
+type EnumMeta = {
+    name: EnumName;
+    values: string[];
+};
+type QueryInput = {
+    schema: SchemaName;
+    table: TableName;
+    filters: QueryFilter[][];
+    sortings: QuerySorting[];
+    limit?: number;
+    offset?: number;
+};
+type QueryFilter = {
+    column: ColumnName;
+    operator: QueryFilterOperator;
+    value: unknown[] | InstrospectColumnMeta[];
+    not?: boolean;
+};
+type QuerySorting = {
+    column: ColumnName;
+    order: 'asc' | 'desc';
+};
+type QueryFilterOperator = '=' | '>=' | '>' | '<=' | '<' | 'like' | 'ilike' | 'is null' | (string & {});
+type QueryResult = {
+    schema: SchemaName;
+    table: TableName;
+    fetchedAt: number;
+    duration: number;
+    rows: Record<ColumnName, QueryResultColumn>[];
+    count: number;
+};
+type QueryResultColumn = {
+    column: ColumnName;
+    value: unknown;
+    dataType?: IntrospectDataType;
+    uiType?: IntrospectUiType;
+};
+type MutateInput = {};
+type MutateResult = {};
+type AlterInput = {};
+type AlterResult = {};
+type RawQueryInput = {};
+type RawQueryResult = {};
+
+declare class AdapterMock implements Adapter {
+    introspect(): Promise<Either<Error, InstrospectResult>>;
+    query(input: QueryInput): Promise<Either<Error, QueryResult>>;
+    mutate(inputs: MutateInput[]): Promise<Either<Error, MutateResult>>;
+    alter(inputs: AlterInput[]): Promise<Either<Error, AlterResult>>;
+    rawQuery(input: RawQueryInput): Promise<Either<Error, RawQueryResult>>;
+}
+
+export { type Adapter, AdapterMock };

package/dist/data/index.js

@@ -0,0 +1 @@
+var a=class{async introspect(){return[null,{schemas:{public:{tables:{users:{schema:"public",name:"users",columns:{id:{schema:"public",table:"users",name:"id",dataType:{name:"integer",args:[]},uiType:{kind:"number",isList:!1,max:1e4,min:0},defaults:null,nullable:!1,partOfPk:!0,reference:null},name:{schema:"public",table:"users",name:"name",dataType:{name:"varchar",args:[255]},uiType:{kind:"string",isList:!1,max:255,min:0},defaults:null,nullable:!1,partOfPk:!1,reference:null},role:{schema:"public",table:"users",name:"role",dataType:{name:"enum",args:[]},uiType:{kind:"enum",isList:!1,name:"UserRole",values:["admin","user","guest"]},defaults:"user",nullable:!1,partOfPk:!1,reference:null}}},posts:{schema:"public",name:"posts",columns:{id:{schema:"public",table:"posts",name:"id",dataType:{name:"integer",args:[]},uiType:{kind:"number",isList:!1,max:1e4,min:0},defaults:null,nullable:!1,partOfPk:!0,reference:null},title:{schema:"public",table:"posts",name:"title",dataType:{name:"varchar",args:[255]},uiType:{kind:"string",isList:!1,max:255,min:0},defaults:null,nullable:!1,partOfPk:!1,reference:null},content:{schema:"public",table:"posts",name:"content",dataType:{name:"text",args:[]},uiType:{kind:"string",isList:!1,max:1e4,min:0},defaults:null,nullable:!0,partOfPk:!1,reference:null},userId:{schema:"public",table:"posts",name:"userId",dataType:{name:"integer",args:[]},uiType:{kind:"number",isList:!1,max:1e4,min:0},defaults:null,nullable:!1,partOfPk:!1,reference:{schema:"public",name:"users",columns:{}}}}}},enums:{UserRole:{name:"UserRole",values:["admin","user","guest"]}}}},filters:{"=":!0,">=":!0,">":!0,"<=":!0,"<":!0,like:!0,ilike:!1,"is null":!0}}]}async query(e){return[null,{schema:"public",table:"users",fetchedAt:Date.now(),duration:35,count:2,rows:[{id:{column:"id",value:1,dataType:{name:"integer",args:[]},uiType:{kind:"number",isList:!1,max:1e4,min:0}},name:{column:"name",value:"Alice",dataType:{name:"varchar",args:[255]},uiType:{kind:"string",isList:!1,max:255,min:0}},role:{column:"role",value:"admin",dataType:{name:"enum",args:[]},uiType:{kind:"enum",isList:!1,name:"UserRole",values:["admin","user","guest"]}}},{id:{column:"id",value:2,dataType:{name:"integer",args:[]},uiType:{kind:"number",isList:!1,max:1e4,min:0}},name:{column:"name",value:"Bob",dataType:{name:"varchar",args:[255]},uiType:{kind:"string",isList:!1,max:255,min:0}},role:{column:"role",value:"user",dataType:{name:"enum",args:[]},uiType:{kind:"enum",isList:!1,name:"UserRole",values:["admin","user","guest"]}}}]}]}async mutate(e){throw new Error("Method not implemented.")}async alter(e){throw new Error("Method not implemented.")}async rawQuery(e){throw new Error("Method not implemented.")}};export{a as AdapterMock};

package/dist/ui/index.d.ts

@@ -0,0 +1,3 @@
+declare function HelloWorld(): void;
+
+export { HelloWorld as default };

package/dist/ui/index.js

@@ -0,0 +1 @@
+function l(){console.log("Hello World")}export{l as default};

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@prisma/studio-core",
+  "version": "0.0.0-dev.202503182320",
+  "description": "Modular Prisma Studio components",
+  "sideEffects": false,
+  "main": "./dist/data/index.js",
+  "types": "./dist/data/index.d.ts",
+  "type": "module",
+  "exports": {
+    "./data": {
+      "types": "./dist/data/index.d.ts",
+      "import": "./dist/data/index.js",
+      "default": "./dist/data/index.js"
+    },
+    "./ui": {
+      "types": "./dist/ui/index.d.ts",
+      "import": "./dist/ui/index.js",
+      "default": "./dist/ui/index.js"
+    }
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "tsup": "8.0.2",
+    "tsx": "4.17.0",
+    "typescript": "5.5.4"
+  },
+  "peerDependencies": {
+    "@types/react": "18.3.3",
+    "react": "18.3.0-canary-a870b2d54-20240314"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint --fix .",
+    "test": ""
+  }
+}

package/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "lib": ["DOM", "DOM.Iterable", "ES2022"]
+  }
+}

package/tsup.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  cjsInterop: true,
+  clean: true,
+  dts: true,
+  entry: ["./data/index.ts", "./ui/index.tsx"],
+  format: ["esm"],
+  minify: true,
+  outDir: "dist",
+});

package/ui/index.tsx

@@ -0,0 +1,3 @@
+export default function HelloWorld() {
+  console.log("Hello World");
+}