@haustle/notion-orm 0.0.42 → 0.0.44

package/src/GenerateTypes.ts

@@ -1,421 +0,0 @@
-import {
-	DatabaseObjectResponse,
-	GetDatabaseResponse,
-} from "@notionhq/client/build/src/api-endpoints";
-import * as ts from "typescript";
-import fs from "fs";
-import path from "path";
-import { DATABASES_DIR } from "./index";
-import { NotionColumnTypes } from "queryTypes";
-
-type propNameToColumnNameType = Record<
-	string,
-	{ columnName: string; type: NotionColumnTypes }
->;
-
-/* 
-Responsible for generating `.ts` files
-*/
-export async function createTypescriptFileForDatabase(
-	dbResponse: GetDatabaseResponse
-) {
-	const {
-		id: databaseId,
-		properties,
-		title,
-	} = dbResponse as DatabaseObjectResponse;
-	const propNameToColumnName: propNameToColumnNameType = {};
-	const databaseName = title[0].plain_text;
-	const databaseClassName = camelize(databaseName).replace(/[^a-zA-Z0-9]/g, "");
-
-	const databaseColumnTypeProps: ts.TypeElement[] = [];
-
-	// Looping through each column of database
-	Object.values(properties).forEach((value) => {
-		const { type: columnType, name: columnName } = value;
-
-		// Taking the column name and camelizing it for typescript use
-		const camelizedColumnName = camelize(columnName);
-
-		// Creating map of column name to the column's name in the database's typescript type
-		propNameToColumnName[camelizedColumnName] = {
-			columnName,
-			type: columnType,
-		};
-
-		if (
-			columnType === "title" ||
-			columnType === "rich_text" ||
-			columnType === "email" ||
-			columnType === "phone_number"
-		) {
-			// add text column to collection type
-			databaseColumnTypeProps.push(
-				createTextProperty({
-					name: camelizedColumnName,
-					isTitle: columnType === "title",
-				})
-			);
-		} else if (columnType === "number") {
-			// add number column to collection type
-			databaseColumnTypeProps.push(createNumberProperty(camelizedColumnName));
-		} else if (columnType === "url") {
-			// add url column to collection type
-			databaseColumnTypeProps.push(
-				createTextProperty({ name: camelizedColumnName, isTitle: false })
-			);
-		} else if (columnType === "date") {
-			// add Date column to collection type
-			databaseColumnTypeProps.push(createDateProperty(camelizedColumnName));
-		} else if (
-			columnType === "select" ||
-			columnType === "status" ||
-			columnType === "multi_select"
-		) {
-			// @ts-ignore
-			const options = value[columnType].options.map((x) => x.name);
-			databaseColumnTypeProps.push(
-				createMultiOptionProp({
-					name: camelizedColumnName,
-					options,
-					isArray: columnType === "multi_select", // Union or Union Array
-				})
-			);
-		}
-	});
-
-	// Object type that represents the database schema
-	const DatabaseSchemaType = ts.factory.createTypeAliasDeclaration(
-		undefined,
-		ts.factory.createIdentifier("DatabaseSchemaType"),
-		undefined,
-		ts.factory.createTypeLiteralNode(databaseColumnTypeProps)
-	);
-
-	// Top level non-nested variable, functions, types for database files
-	const TsNodesForDatabaseFile = ts.factory.createNodeArray([
-		createDatabaseActionsClassImport(),
-		createDatabaseIdVariable(databaseId),
-		DatabaseSchemaType,
-		createColumnNameToColumnProperties(propNameToColumnName),
-		createColumnNameToColumnType(),
-		createDatabaseClassExport({ databaseName: databaseClassName }),
-	]);
-
-	const sourceFile = ts.createSourceFile(
-		"",
-		"",
-		ts.ScriptTarget.ESNext,
-		true,
-		ts.ScriptKind.TS
-	);
-	const printer = ts.createPrinter();
-
-	const typescriptCodeToString = printer.printList(
-		ts.ListFormat.MultiLine,
-		TsNodesForDatabaseFile,
-		sourceFile
-	);
-	const transpileToJavaScript = ts.transpile(typescriptCodeToString, {
-		module: ts.ModuleKind.None,
-		target: ts.ScriptTarget.ESNext,
-	});
-
-	// Create databases output folder
-	if (!fs.existsSync(DATABASES_DIR)) {
-		fs.mkdirSync(DATABASES_DIR);
-	}
-
-	// Create TypeScript and JavaScript files
-	fs.writeFileSync(
-		path.resolve(DATABASES_DIR, `${databaseClassName}.ts`),
-		typescriptCodeToString
-	);
-	fs.writeFileSync(
-		path.resolve(DATABASES_DIR, `${databaseClassName}.js`),
-		transpileToJavaScript
-	);
-
-	return { databaseName, databaseClassName, databaseId };
-}
-
-// generate text property
-function createTextProperty(args: { name: string; isTitle: boolean }) {
-	const { name, isTitle } = args;
-	const text = ts.factory.createPropertySignature(
-		undefined,
-		ts.factory.createIdentifier(name),
-		!isTitle ? ts.factory.createToken(ts.SyntaxKind.QuestionToken) : undefined,
-		ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
-	);
-	return text;
-}
-
-/**
- * Generate number property to go inside a type
- * name: number
- */
-function createNumberProperty(name: string) {
-	const number = ts.factory.createPropertySignature(
-		undefined,
-		ts.factory.createIdentifier(name),
-		ts.factory.createToken(ts.SyntaxKind.QuestionToken),
-		ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword)
-	);
-	return number;
-}
-
-/**
- * For selects and multi-select collection properties
- * array = true for multi-select
- */
-function createMultiOptionProp(args: {
-	name: string;
-	options: string[];
-	isArray: boolean;
-}) {
-	const { isArray, name, options } = args;
-	return ts.factory.createPropertySignature(
-		undefined,
-		ts.factory.createIdentifier(name),
-		ts.factory.createToken(ts.SyntaxKind.QuestionToken),
-		isArray
-			? ts.factory.createArrayTypeNode(
-					ts.factory.createParenthesizedType(
-						ts.factory.createUnionTypeNode([
-							...options.map((option) =>
-								ts.factory.createLiteralTypeNode(
-									ts.factory.createStringLiteral(option)
-								)
-							),
-							createOtherStringProp(),
-						])
-					)
-			  )
-			: ts.factory.createUnionTypeNode([
-					...options.map((option) =>
-						ts.factory.createLiteralTypeNode(
-							ts.factory.createStringLiteral(option)
-						)
-					),
-					createOtherStringProp(),
-			  ])
-	);
-}
-
-// string & {}. Allows users to pass in values
-function createOtherStringProp() {
-	return ts.factory.createIntersectionTypeNode([
-		ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
-		ts.factory.createTypeLiteralNode([]),
-	]);
-}
-
-function createDateProperty(name: string) {
-	return ts.factory.createPropertySignature(
-		undefined,
-		ts.factory.createIdentifier(name),
-		ts.factory.createToken(ts.SyntaxKind.QuestionToken),
-		ts.factory.createTypeLiteralNode([
-			ts.factory.createPropertySignature(
-				undefined,
-				ts.factory.createIdentifier("start"),
-				undefined,
-				ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
-			),
-			ts.factory.createPropertySignature(
-				undefined,
-				ts.factory.createIdentifier("end"),
-				ts.factory.createToken(ts.SyntaxKind.QuestionToken),
-				ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
-			),
-		])
-	);
-}
-
-// Generate database Id variable
-// const databaseId = <database-id>
-function createDatabaseIdVariable(databaseId: string) {
-	return ts.factory.createVariableStatement(
-		undefined,
-		ts.factory.createVariableDeclarationList(
-			[
-				ts.factory.createVariableDeclaration(
-					ts.factory.createIdentifier("databaseId"),
-					undefined,
-					undefined,
-					ts.factory.createStringLiteral(databaseId)
-				),
-			],
-			ts.NodeFlags.Const
-		)
-	);
-}
-
-/**
- * Instead of refering to the column names 1:1 such as "Book Rating", we transform them to
- * camelcase (eg. bookRating). So we need to keep track of the original name and the type
- * for when we construct request for API
- *
- * Example
- *
- * const columnNameToColumnProperties = {
- *
- *      "bookRating": {
- *          columnName: "Book Rating",
- *          type: "select"
- *      },
- *      "genre": {
- *          columnName: "Genre",
- *          type: "multi_select"
- *      }
- *
- * }
- */
-function createColumnNameToColumnProperties(colMap: propNameToColumnNameType) {
-	return ts.factory.createVariableDeclarationList(
-		[
-			ts.factory.createVariableDeclaration(
-				ts.factory.createIdentifier("columnNameToColumnProperties"),
-				undefined,
-				undefined,
-				ts.factory.createAsExpression(
-					ts.factory.createObjectLiteralExpression(
-						[
-							...Object.entries(colMap).map(([propName, value]) =>
-								ts.factory.createPropertyAssignment(
-									ts.factory.createStringLiteral(propName),
-									ts.factory.createObjectLiteralExpression(
-										[
-											ts.factory.createPropertyAssignment(
-												ts.factory.createIdentifier("columnName"),
-												ts.factory.createStringLiteral(value.columnName)
-											),
-											ts.factory.createPropertyAssignment(
-												ts.factory.createIdentifier("type"),
-												ts.factory.createStringLiteral(value.type)
-											),
-										],
-										true
-									)
-								)
-							),
-						],
-						true
-					),
-					ts.factory.createTypeReferenceNode(
-						ts.factory.createIdentifier("const"),
-						undefined
-					)
-				)
-			),
-		],
-		ts.NodeFlags.Const
-	);
-}
-
-function createColumnNameToColumnType() {
-	return ts.factory.createTypeAliasDeclaration(
-		undefined,
-		ts.factory.createIdentifier("ColumnNameToColumnType"),
-		undefined,
-		ts.factory.createMappedTypeNode(
-			undefined,
-			ts.factory.createTypeParameterDeclaration(
-				undefined,
-				ts.factory.createIdentifier("Property"),
-				ts.factory.createTypeOperatorNode(
-					ts.SyntaxKind.KeyOfKeyword,
-					ts.factory.createTypeQueryNode(
-						ts.factory.createIdentifier("columnNameToColumnProperties"),
-						undefined
-					)
-				),
-				undefined
-			),
-			undefined,
-			undefined,
-			ts.factory.createIndexedAccessTypeNode(
-				ts.factory.createIndexedAccessTypeNode(
-					ts.factory.createTypeQueryNode(
-						ts.factory.createIdentifier("columnNameToColumnProperties"),
-						undefined
-					),
-					ts.factory.createTypeReferenceNode(
-						ts.factory.createIdentifier("Property"),
-						undefined
-					)
-				),
-				ts.factory.createLiteralTypeNode(ts.factory.createStringLiteral("type"))
-			),
-			undefined
-			/* unknown */
-		)
-	);
-}
-
-// Need to import the database class used to execute database actions (adding + querying)
-function createDatabaseActionsClassImport() {
-	return ts.factory.createImportDeclaration(
-		undefined,
-		ts.factory.createImportClause(
-			false,
-			undefined,
-			ts.factory.createNamedImports([
-				ts.factory.createImportSpecifier(
-					false,
-					undefined,
-					ts.factory.createIdentifier("DatabaseActions")
-				),
-			])
-		),
-		ts.factory.createStringLiteral("../src/DatabaseActions"),
-		undefined
-	);
-}
-
-/**
- * Create export statement for the database class
- * export const <databaseName> = new DatabaseActions<DatabaseSchemaType>(datbaseId, columnNameToColumnProperties)
- */
-function createDatabaseClassExport(args: { databaseName: string }) {
-	const { databaseName } = args;
-	return ts.factory.createVariableStatement(
-		[ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
-		ts.factory.createVariableDeclarationList(
-			[
-				ts.factory.createVariableDeclaration(
-					ts.factory.createIdentifier(databaseName),
-					undefined,
-					undefined,
-					ts.factory.createNewExpression(
-						ts.factory.createIdentifier("DatabaseActions"),
-						[
-							ts.factory.createTypeReferenceNode(
-								ts.factory.createIdentifier("DatabaseSchemaType"),
-								undefined
-							),
-							ts.factory.createTypeReferenceNode(
-								ts.factory.createIdentifier("ColumnNameToColumnType"),
-								undefined
-							),
-						],
-						[
-							ts.factory.createIdentifier("databaseId"),
-							ts.factory.createIdentifier("columnNameToColumnProperties"),
-						]
-					)
-				),
-			],
-			ts.NodeFlags.Const
-		)
-	);
-}
-
-// for a type's property name
-function camelize(str: string) {
-	return str.replace(/(?:^\w|[A-Z]|\b\w|\s+)/g, function (match, index) {
-		if (+match === 0) return ""; // or if (/\s+/.test(match)) for white spaces
-		return index === 0 ? match.toLowerCase() : match.toUpperCase();
-	});
-}

package/src/cli.ts

@@ -1,40 +0,0 @@
-#! /usr/bin/env node
-
-import fs from "fs";
-import { createDatabaseTypes } from "./index";
-import path from "path";
-
-async function main() {
-	const args = process.argv.slice(2);
-
-	if (args.length === 1 && args[0] === "generate") {
-		const projDir = process.cwd();
-
-		const notionConfigDirJS = fs.existsSync(
-			path.join(projDir, "notion.config.js")
-		);
-		const notionConfigDirTS = fs.existsSync(
-			path.join(projDir, "notion.config.ts")
-		);
-
-		console.log(path.join(projDir, "notion.config"));
-		if (notionConfigDirJS || notionConfigDirTS) {
-			const config = require(path.join(projDir, "notion.config"));
-
-			const { databaseNames } = await createDatabaseTypes(config);
-			if (databaseNames.length < 0) {
-				console.log("generated no types");
-			} else {
-				console.log("Generated types for the following Database's: ");
-				for (let x = 0; x < databaseNames.length; x++) {
-					console.log(`${x}. ${databaseNames[x]}`);
-				}
-			}
-		} else {
-			console.error("Could not find file `notion.config.ts` in root");
-			process.exit(1);
-		}
-	}
-}
-
-main();

package/src/index.ts

@@ -1,136 +0,0 @@
-/**
- * Responsible for consuming notion.config.js
- */
-
-import { Client } from "@notionhq/client";
-import { GetDatabaseResponse } from "@notionhq/client/build/src/api-endpoints";
-import { createTypescriptFileForDatabase } from "./GenerateTypes";
-import * as ts from "typescript";
-import fs from "fs";
-import path from "path";
-
-export const DATABASES_DIR = path.join(__dirname, "../../build", "databases");
-
-export type NotionConfigType = {
-	auth: string;
-	databaseIds: string[];
-};
-
-export const createDatabaseTypes = async (args: NotionConfigType) => {
-	const { auth, databaseIds } = args;
-
-	// Making sure the user is passing valid arguments
-	if (!auth) {
-		console.error("Please pass a valid Notion Integration Key");
-		process.exit(1);
-	}
-
-	if (databaseIds.length < 0) {
-		console.error("Please pass some database Ids");
-		process.exit(1);
-	}
-
-	// Initialize client
-	const NotionClient = new Client({
-		auth: auth,
-	});
-
-	const databaseNames: string[] = [];
-	const databaseClassExportStatements: ts.ExportDeclaration[] = [];
-
-	// Remove the previous databases, so they can call get updated
-	fs.rmdir(DATABASES_DIR, () =>
-		console.log("Deleting current database types...")
-	);
-
-	for (const database_id of databaseIds) {
-		let dbOjbect: GetDatabaseResponse;
-
-		try {
-			// Get the database schema
-			dbOjbect = await NotionClient.databases.retrieve({
-				database_id,
-			});
-
-			// Create typescript file based on schema
-			const { databaseClassName, databaseId, databaseName } =
-				await createTypescriptFileForDatabase(dbOjbect);
-
-			databaseNames.push(databaseName);
-			databaseClassExportStatements.push(
-				databaseExportStatement({
-					databaseClassName,
-				})
-			);
-		} catch (e) {
-			console.error(e);
-			return { databaseNames: [] };
-		}
-	}
-
-	// Create a file that exports all databases
-	createDatabaseBarrelFile({
-		databaseClassExportStatements,
-	});
-	return { databaseNames };
-};
-
-// Create the export statement for database file file
-// export { databaseName } from "./databaseName"
-function databaseExportStatement(args: { databaseClassName: string }) {
-	const { databaseClassName } = args;
-	return ts.factory.createExportDeclaration(
-		undefined,
-		false,
-		ts.factory.createNamedExports([
-			ts.factory.createExportSpecifier(
-				false,
-				undefined,
-				ts.factory.createIdentifier(databaseClassName)
-			),
-		]),
-		ts.factory.createStringLiteral(`./${databaseClassName}`),
-		undefined
-	);
-}
-
-// Creates file that import all generated notion database Ids
-function createDatabaseBarrelFile(args: {
-	databaseClassExportStatements: ts.Node[];
-}) {
-	const { databaseClassExportStatements } = args;
-	const nodes = ts.factory.createNodeArray(databaseClassExportStatements);
-	const sourceFile = ts.createSourceFile(
-		"placeholder.ts",
-		"",
-		ts.ScriptTarget.ESNext,
-		true,
-		ts.ScriptKind.TS
-	);
-	const printer = ts.createPrinter();
-
-	const typescriptCodeToString = printer.printList(
-		ts.ListFormat.MultiLine,
-		nodes,
-		sourceFile
-	);
-
-	const transpileToJavaScript = ts.transpile(typescriptCodeToString, {
-		module: ts.ModuleKind.None,
-		target: ts.ScriptTarget.ES2015,
-	});
-
-	if (!fs.existsSync(DATABASES_DIR)) {
-		fs.mkdirSync(DATABASES_DIR);
-	}
-
-	// Create TypeScript and JavaScript file
-	fs.writeFileSync(
-		path.resolve(DATABASES_DIR, "index.ts"),
-		typescriptCodeToString
-	);
-	fs.writeFileSync(
-		path.resolve(DATABASES_DIR, "index.js"),
-		transpileToJavaScript
-	);
-}