cl-orm 0.1.0

package/website/.prettierrc

@@ -0,0 +1,34 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "quoteProps": "as-needed",
+  "jsxSingleQuote": true,
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "arrowParens": "always",
+  "proseWrap": "preserve",
+  "endOfLine": "auto",
+  "embeddedLanguageFormatting": "auto",
+  "singleAttributePerLine": false,
+  "plugins": ["@ianvs/prettier-plugin-sort-imports"],
+  "importOrder": [
+    "<TYPES>^(node:)",
+    "<TYPES>",
+    "<TYPES>^[.]",
+    "<BUILTIN_MODULES>",
+    "<THIRD_PARTY_MODULES>",
+    "^[.]"
+  ],
+  "overrides": [
+    {
+      "files": "*.jsonc",
+      "options": {
+        "trailingComma": "none"
+      }
+    }
+  ]
+}

package/website/README.md

@@ -0,0 +1,3 @@
+# Website
+
+This [website](https://wellwelwel.github.io/cl-orm/docs) is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.

package/website/docs/documentation/connection.mdx

@@ -0,0 +1,123 @@
+---
+sidebar_position: 1
+tags: [Connection, D1, Durable Objects]
+---
+
+import TabItem from '@theme/TabItem';
+import Tabs from '@theme/Tabs';
+
+# Connection
+
+**CL ORM** provides two driver functions to create a unified **Connection** interface.
+
+## D1
+
+```ts
+import { useD1 } from 'cl-orm';
+
+const db = useD1(env.DB);
+```
+
+> `env.DB` is a `D1Database` binding from your Cloudflare Worker.
+
+## Durable Objects
+
+```ts
+import { useDO } from 'cl-orm';
+
+const db = useDO(ctx.storage.sql);
+```
+
+> `ctx.storage.sql` is a `SqlStorage` from your Durable Object.
+
+---
+
+## Available Connection Methods
+
+- [**insert**](/docs/documentation/queries/insert)
+- [**select**](/docs/documentation/queries/select)
+- [**update**](/docs/documentation/queries/update)
+- [**delete**](/docs/documentation/queries/delete)
+- **query** — execute raw SQL queries directly
+
+---
+
+## Raw Query
+
+You can execute raw SQL queries using the `query` method:
+
+<Tabs>
+  <TabItem value='D1' default>
+
+```ts
+import { useD1 } from 'cl-orm';
+
+const db = useD1(env.DB);
+
+const { rows, meta } = await db.query<{ id: number; name: string }>(
+  'SELECT * FROM users WHERE id = ?',
+  [1]
+);
+
+const user = rows[0] || null;
+```
+
+  </TabItem>
+  <TabItem value='Durable Objects'>
+
+```ts
+import { useDO } from 'cl-orm';
+
+const db = useDO(ctx.storage.sql);
+
+const { rows, meta } = await db.query<{ id: number; name: string }>(
+  'SELECT * FROM users WHERE id = ?',
+  [1]
+);
+
+const user = rows[0] || null;
+```
+
+  </TabItem>
+</Tabs>
+
+---
+
+## Raw WHERE
+
+You can use a raw string as the `where` clause in `select`, `update` and `delete`, passing the params manually:
+
+<Tabs>
+  <TabItem value='D1' default>
+
+```ts
+import { useD1 } from 'cl-orm';
+
+const db = useD1(env.DB);
+
+const user = await db.select<{ id: number; name: string }>({
+  table: 'users',
+  where: 'id = ?',
+  params: [1],
+  limit: 1,
+});
+```
+
+  </TabItem>
+  <TabItem value='Durable Objects'>
+
+```ts
+import { useDO } from 'cl-orm';
+
+const db = useDO(ctx.storage.sql);
+
+const user = await db.select<{ id: number; name: string }>({
+  table: 'users',
+  where: 'id = ?',
+  params: [1],
+  limit: 1,
+});
+```
+
+  </TabItem>
+</Tabs>

package/website/docs/documentation/queries/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Queries",
+  "link": {
+    "type": "generated-index"
+  },
+  "position": 2
+}

package/website/docs/documentation/queries/delete.mdx

@@ -0,0 +1,51 @@
+---
+sidebar_position: 4
+---
+
+# DELETE
+
+> For **WHERE** examples, please see the **WHERE** section.
+
+## Delete all rows
+
+```ts
+// highlight-start
+import { useD1 } from 'cl-orm';
+
+const db = useD1(env.DB);
+// highlight-end
+
+await db.delete({
+  table: 'temp',
+});
+```
+
+> SQL Query
+
+```sql
+DELETE FROM temp
+```
+
+<hr />
+
+## Limit the rows to be deleted
+
+```ts
+// highlight-start
+import { useD1 } from 'cl-orm';
+
+const db = useD1(env.DB);
+// highlight-end
+
+await db.delete({
+  table: 'test',
+  limit: 1,
+});
+```
+
+> SQL Query
+
+```sql
+DELETE FROM test LIMIT ?
+-- params: [1]
+```

package/website/docs/documentation/queries/insert.mdx

@@ -0,0 +1,63 @@
+---
+sidebar_position: 0
+---
+
+# INSERT
+
+## Single insertion
+
+```ts
+// highlight-start
+import { useD1 } from 'cl-orm';
+
+const db = useD1(env.DB);
+// highlight-end
+
+await db.insert({
+  table: 'test',
+  values: {
+    column1: 'foo',
+    column2: 1,
+  },
+});
+```
+
+> SQL Query
+
+```sql
+INSERT INTO test (column1, column2) VALUES (?, ?)
+-- params: ['foo', 1]
+```
+
+<hr />
+
+## Multiple insertions
+
+```ts
+// highlight-start
+import { useD1 } from 'cl-orm';
+
+const db = useD1(env.DB);
+// highlight-end
+
+await db.insert({
+  table: 'test',
+  values: [
+    {
+      column1: 'foo',
+      column2: 1,
+    },
+    {
+      column1: 'bar',
+      column2: 2,
+    },
+  ],
+});
+```
+
+> SQL Query
+
+```sql
+INSERT INTO test (column1, column2) VALUES (?, ?), (?, ?)
+-- params: ['foo', 1,  'bar', 2]
+```

package/website/docs/documentation/queries/operators/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Operators",
+  "link": {
+    "type": "generated-index"
+  },
+  "position": 6
+}

package/website/docs/documentation/queries/operators/between.mdx

@@ -0,0 +1,17 @@
+---
+sidebar_position: 13
+tags: [OP, Operators]
+---
+
+# between
+
+> between(column: string, params: [Param, Param])
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: '`createdAt` BETWEEN ? AND ?', params: ['2023-01-01', '2024-01-01'] }
+ */
+OP.between('createdAt', ['2023-01-01', '2024-01-01']);
+```

package/website/docs/documentation/queries/operators/eq.mdx

@@ -0,0 +1,22 @@
+---
+sidebar_position: 1
+tags: [OP, Operators]
+---
+
+# eq (equal)
+
+> eq(column: string, param: Param)
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: '`id` = ?', params: [16] }
+ */
+OP.eq('id', 16);
+
+/**
+ * { condition: '`name` = ?', params: ['John'] }
+ */
+OP.eq('name', 'John');
+```

package/website/docs/documentation/queries/operators/gt.mdx

@@ -0,0 +1,22 @@
+---
+sidebar_position: 5
+tags: [OP, Operators]
+---
+
+# gt (greaterThan)
+
+> gt(column: string, param: Param)
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: '`id` > ?', params: [16] }
+ */
+OP.gt('id', 16);
+
+/**
+ * { condition: '`createdAt` > ?', params: ['2024-01-01'] }
+ */
+OP.gt('createdAt', '2024-01-01');
+```

package/website/docs/documentation/queries/operators/gte.mdx

@@ -0,0 +1,22 @@
+---
+sidebar_position: 7
+tags: [OP, Operators]
+---
+
+# gte (greaterThanOrEqual)
+
+> gte(column: string, param: Param)
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: '`id` >= ?', params: [16] }
+ */
+OP.gte('id', 16);
+
+/**
+ * { condition: '`createdAt` >= ?', params: ['2024-01-01'] }
+ */
+OP.gte('createdAt', '2024-01-01');
+```

package/website/docs/documentation/queries/operators/in.mdx

@@ -0,0 +1,28 @@
+---
+sidebar_position: 11
+tags: [OP, Operators, Sub Query, Sub Queries]
+---
+
+# in
+
+> in(column: string, params: Param[])
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: 'id IN (?, ?, ?)', params: [16, 20, 50] }
+ */
+OP.in('id', [16, 20, 50]);
+```
+
+> in(column: string, subquery: string, params: Param[])
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: 'userId IN (SELECT id FROM users WHERE status IN (?, ?))', params: [0, 2] }
+ */
+OP.in('userId', 'SELECT id FROM users WHERE status IN (?, ?)', [0, 2]);
+```

package/website/docs/documentation/queries/operators/is-not-null.mdx

@@ -0,0 +1,22 @@
+---
+sidebar_position: 10
+tags: [OP, Operators]
+---
+
+# isNotNull
+
+> isNotNull(column: string)
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: '`preferences` IS NOT NULL', params: [] }
+ */
+OP.isNotNull('preferences');
+
+/**
+ * { condition: '`updatedAt` IS NOT NULL', params: [] }
+ */
+OP.isNotNull('updatedAt');
+```

package/website/docs/documentation/queries/operators/is-null.mdx

@@ -0,0 +1,22 @@
+---
+sidebar_position: 9
+tags: [OP, Operators]
+---
+
+# isNull
+
+> isNull(column: string)
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: '`preferences` IS NULL', params: [] }
+ */
+OP.isNull('preferences');
+
+/**
+ * { condition: '`updatedAt` IS NULL', params: [] }
+ */
+OP.isNull('updatedAt');
+```

package/website/docs/documentation/queries/operators/like.mdx

@@ -0,0 +1,27 @@
+---
+sidebar_position: 3
+tags: [OP, Operators]
+---
+
+# like
+
+> like(column: string, param: Param)
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: '`email` LIKE ?', params: ['%gmail.com'] }
+ */
+OP.like('email', '%gmail.com');
+
+/**
+ * { condition: '`email` LIKE ?', params: ['john@%'] }
+ */
+OP.like('email', 'john@%');
+
+/**
+ * { condition: '`email` LIKE ?', params: ['%gmail%'] }
+ */
+OP.like('email', '%gmail%');
+```

package/website/docs/documentation/queries/operators/lt.mdx

@@ -0,0 +1,22 @@
+---
+sidebar_position: 6
+tags: [OP, Operators]
+---
+
+# lt (lessThan)
+
+> lt(column: string, param: Param)
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: '`id` < ?', params: [16] }
+ */
+OP.lt('id', 16);
+
+/**
+ * { condition: '`createdAt` < ?', params: ['2024-01-01'] }
+ */
+OP.lt('createdAt', '2024-01-01');
+```

package/website/docs/documentation/queries/operators/lte.mdx

@@ -0,0 +1,22 @@
+---
+sidebar_position: 8
+tags: [OP, Operators]
+---
+
+# lte (lessThanOrEqual)
+
+> lte(column: string, param: Param)
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: '`id` <= ?', params: [16] }
+ */
+OP.lte('id', 16);
+
+/**
+ * { condition: '`createdAt` <= ?', params: ['2024-01-01'] }
+ */
+OP.lte('createdAt', '2024-01-01');
+```

package/website/docs/documentation/queries/operators/ne.mdx

@@ -0,0 +1,22 @@
+---
+sidebar_position: 2
+tags: [OP, Operators]
+---
+
+# ne (notEqual)
+
+> ne(column: string, param: Param)
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: '`id` != ?', params: [16] }
+ */
+OP.ne('id', 16);
+
+/**
+ * { condition: '`name` != ?', params: ['John'] }
+ */
+OP.ne('name', 'John');
+```

package/website/docs/documentation/queries/operators/not-between.mdx

@@ -0,0 +1,17 @@
+---
+sidebar_position: 14
+tags: [OP, Operators]
+---
+
+# notBetween
+
+> notBetween(column: string, params: [Param, Param])
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: '`createdAt` NOT BETWEEN ? AND ?', params: ['2023-01-01', '2024-01-01'] }
+ */
+OP.notBetween('createdAt', ['2023-01-01', '2024-01-01']);
+```

package/website/docs/documentation/queries/operators/not-like.mdx

@@ -0,0 +1,27 @@
+---
+sidebar_position: 4
+tags: [OP, Operators]
+---
+
+# notLike
+
+> notLike(column: string, param: Param)
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: '`email` NOT LIKE ?', params: ['%gmail.com'] }
+ */
+OP.notLike('email', '%gmail.com');
+
+/**
+ * { condition: '`email` NOT LIKE ?', params: ['john@%'] }
+ */
+OP.notLike('email', 'john@%');
+
+/**
+ * { condition: '`email` NOT LIKE ?', params: ['%gmail%'] }
+ */
+OP.notLike('email', '%gmail%');
+```

package/website/docs/documentation/queries/operators/notIn.mdx

@@ -0,0 +1,28 @@
+---
+sidebar_position: 12
+tags: [OP, Operators, Sub Query, Sub Queries]
+---
+
+# notIn
+
+> notIn(column: string, params: Param[])
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: 'id NOT IN (?, ?, ?)', params: [16, 20, 50] }
+ */
+OP.notIn('id', [16, 20, 50]);
+```
+
+> notIn(column: string, subquery: string, params: Param[])
+
+```ts
+import { OP, Param } from 'cl-orm';
+
+/**
+ * { condition: 'userId NOT IN (SELECT id FROM users WHERE status IN (?, ?))', params: [0, 2] }
+ */
+OP.notIn('userId', 'SELECT id FROM users WHERE status IN (?, ?)', [0, 2]);
+```