@indexeddb-orm/idb-orm 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (216) hide show
  1. package/.vscode/extensions.json +5 -0
  2. package/README.md +1280 -0
  3. package/angular-demo-app/README.md +84 -0
  4. package/angular-demo-app/angular.json +109 -0
  5. package/angular-demo-app/package-lock.json +14215 -0
  6. package/angular-demo-app/package.json +41 -0
  7. package/angular-demo-app/src/app/app.component.ts +481 -0
  8. package/angular-demo-app/src/app/app.routes.ts +8 -0
  9. package/angular-demo-app/src/app/components/actions.component.ts +202 -0
  10. package/angular-demo-app/src/app/components/cloud-sync-demo.component.ts +296 -0
  11. package/angular-demo-app/src/app/components/live-query-demo.component.ts +307 -0
  12. package/angular-demo-app/src/app/components/main-info.component.ts +148 -0
  13. package/angular-demo-app/src/app/components/posts-live-query-demo.component.ts +336 -0
  14. package/angular-demo-app/src/app/components/typescript-demo.component.ts +268 -0
  15. package/angular-demo-app/src/entities/post-tag.entity.ts +25 -0
  16. package/angular-demo-app/src/entities/post.entity.ts +49 -0
  17. package/angular-demo-app/src/entities/profile.entity.ts +42 -0
  18. package/angular-demo-app/src/entities/tag.entity.ts +36 -0
  19. package/angular-demo-app/src/entities/user.entity.ts +59 -0
  20. package/angular-demo-app/src/favicon.ico +1 -0
  21. package/angular-demo-app/src/index.html +16 -0
  22. package/angular-demo-app/src/main.ts +13 -0
  23. package/angular-demo-app/src/services/app-logic.service.ts +449 -0
  24. package/angular-demo-app/src/services/cloud-sync.service.ts +95 -0
  25. package/angular-demo-app/src/services/database.service.ts +26 -0
  26. package/angular-demo-app/src/services/live-query.service.ts +63 -0
  27. package/angular-demo-app/src/services/posts-live-query.service.ts +86 -0
  28. package/angular-demo-app/src/services/typescript-demo.service.ts +59 -0
  29. package/angular-demo-app/src/styles.scss +50 -0
  30. package/angular-demo-app/tsconfig.app.json +13 -0
  31. package/angular-demo-app/tsconfig.json +34 -0
  32. package/angular-demo-app/tsconfig.spec.json +13 -0
  33. package/dist/Database.d.ts +206 -0
  34. package/dist/Database.js +288 -0
  35. package/dist/decorators/Column.d.ts +79 -0
  36. package/dist/decorators/Column.js +236 -0
  37. package/dist/decorators/Entity.d.ts +32 -0
  38. package/dist/decorators/Entity.js +44 -0
  39. package/dist/decorators/Relation.d.ts +70 -0
  40. package/dist/decorators/Relation.js +120 -0
  41. package/dist/decorators/index.d.ts +3 -0
  42. package/dist/decorators/index.js +3 -0
  43. package/dist/errors/ValidationError.d.ts +4 -0
  44. package/dist/errors/ValidationError.js +8 -0
  45. package/dist/index.d.ts +8 -0
  46. package/dist/index.js +7 -0
  47. package/dist/metadata/Column.d.ts +8 -0
  48. package/dist/metadata/Column.js +44 -0
  49. package/dist/metadata/Entity.d.ts +11 -0
  50. package/dist/metadata/Entity.js +21 -0
  51. package/dist/metadata/Relation.d.ts +20 -0
  52. package/dist/metadata/Relation.js +74 -0
  53. package/dist/metadata/index.d.ts +3 -0
  54. package/dist/metadata/index.js +3 -0
  55. package/dist/services/AggregationService.d.ts +38 -0
  56. package/dist/services/AggregationService.js +229 -0
  57. package/dist/services/BaseEntity.d.ts +32 -0
  58. package/dist/services/BaseEntity.js +62 -0
  59. package/dist/services/CloudSyncService.d.ts +100 -0
  60. package/dist/services/CloudSyncService.js +196 -0
  61. package/dist/services/DecoratorUtils.d.ts +12 -0
  62. package/dist/services/DecoratorUtils.js +10 -0
  63. package/dist/services/EntityFactory.d.ts +25 -0
  64. package/dist/services/EntityFactory.js +27 -0
  65. package/dist/services/EntityRegistry.d.ts +61 -0
  66. package/dist/services/EntityRegistry.js +56 -0
  67. package/dist/services/EntitySchema.d.ts +56 -0
  68. package/dist/services/EntitySchema.js +125 -0
  69. package/dist/services/MigrationManager.d.ts +70 -0
  70. package/dist/services/MigrationManager.js +181 -0
  71. package/dist/services/RelationLoader.d.ts +66 -0
  72. package/dist/services/RelationLoader.js +310 -0
  73. package/dist/services/SchemaBuilder.d.ts +68 -0
  74. package/dist/services/SchemaBuilder.js +191 -0
  75. package/dist/services/index.d.ts +7 -0
  76. package/dist/services/index.js +7 -0
  77. package/dist/types.d.ts +152 -0
  78. package/dist/types.js +1 -0
  79. package/dist/utils/logger.d.ts +12 -0
  80. package/dist/utils/logger.js +16 -0
  81. package/eslint.config.js +49 -0
  82. package/homepage/favicon.svg +36 -0
  83. package/homepage/index.html +1725 -0
  84. package/package.json +78 -0
  85. package/react-demo-app/README.md +61 -0
  86. package/react-demo-app/eslint.config.js +60 -0
  87. package/react-demo-app/index.html +13 -0
  88. package/react-demo-app/package-lock.json +4955 -0
  89. package/react-demo-app/package.json +39 -0
  90. package/react-demo-app/src/App.tsx +172 -0
  91. package/react-demo-app/src/assets/react.svg +1 -0
  92. package/react-demo-app/src/components/Actions.tsx +171 -0
  93. package/react-demo-app/src/components/CloudSyncDemo.tsx +191 -0
  94. package/react-demo-app/src/components/LiveQueryDemo.tsx +122 -0
  95. package/react-demo-app/src/components/MainInfo.tsx +75 -0
  96. package/react-demo-app/src/components/PostsLiveQueryDemo.tsx +185 -0
  97. package/react-demo-app/src/components/TypeScriptDemo.tsx +190 -0
  98. package/react-demo-app/src/database/Database.ts +30 -0
  99. package/react-demo-app/src/entities/Post.ts +48 -0
  100. package/react-demo-app/src/entities/PostTag.ts +26 -0
  101. package/react-demo-app/src/entities/Profile.ts +41 -0
  102. package/react-demo-app/src/entities/Tag.ts +35 -0
  103. package/react-demo-app/src/entities/User.ts +61 -0
  104. package/react-demo-app/src/hooks/useAppLogic.ts +565 -0
  105. package/react-demo-app/src/hooks/useCloudSyncDemo.ts +84 -0
  106. package/react-demo-app/src/hooks/useLiveQueryDemo.ts +68 -0
  107. package/react-demo-app/src/hooks/usePostsLiveQueryDemo.ts +64 -0
  108. package/react-demo-app/src/hooks/useTypeScriptDemo.ts +43 -0
  109. package/react-demo-app/src/index.css +26 -0
  110. package/react-demo-app/src/main.tsx +18 -0
  111. package/react-demo-app/src/migrations/001-add-user-email-index.ts +17 -0
  112. package/react-demo-app/src/migrations/002-add-post-category.ts +37 -0
  113. package/react-demo-app/src/migrations/index.ts +8 -0
  114. package/react-demo-app/src/vite-env.d.ts +1 -0
  115. package/react-demo-app/tsconfig.app.json +22 -0
  116. package/react-demo-app/tsconfig.json +6 -0
  117. package/react-demo-app/vite.config.ts +10 -0
  118. package/src/Database.ts +405 -0
  119. package/src/errors/ValidationError.ts +9 -0
  120. package/src/index.ts +13 -0
  121. package/src/metadata/Column.ts +74 -0
  122. package/src/metadata/Entity.ts +42 -0
  123. package/src/metadata/Relation.ts +121 -0
  124. package/src/metadata/index.ts +5 -0
  125. package/src/services/AggregationService.ts +348 -0
  126. package/src/services/BaseEntity.ts +77 -0
  127. package/src/services/CloudSyncService.ts +248 -0
  128. package/src/services/EntityFactory.ts +35 -0
  129. package/src/services/EntityRegistry.ts +109 -0
  130. package/src/services/EntitySchema.ts +154 -0
  131. package/src/services/MigrationManager.ts +276 -0
  132. package/src/services/RelationLoader.ts +532 -0
  133. package/src/services/SchemaBuilder.ts +237 -0
  134. package/src/services/index.ts +7 -0
  135. package/src/types.d.ts +1 -0
  136. package/src/types.ts +169 -0
  137. package/src/utils/logger.ts +40 -0
  138. package/svelte-demo-app/README.md +61 -0
  139. package/svelte-demo-app/package-lock.json +3000 -0
  140. package/svelte-demo-app/package.json +30 -0
  141. package/svelte-demo-app/src/app.d.ts +12 -0
  142. package/svelte-demo-app/src/app.html +13 -0
  143. package/svelte-demo-app/src/components/Actions.svelte +121 -0
  144. package/svelte-demo-app/src/components/CloudSyncDemo.svelte +333 -0
  145. package/svelte-demo-app/src/components/LiveQueryDemo.svelte +191 -0
  146. package/svelte-demo-app/src/components/MainInfo.svelte +133 -0
  147. package/svelte-demo-app/src/components/PostsLiveQueryDemo.svelte +330 -0
  148. package/svelte-demo-app/src/components/TypeScriptDemo.svelte +251 -0
  149. package/svelte-demo-app/src/database/Database.ts +29 -0
  150. package/svelte-demo-app/src/entities/Post.ts +46 -0
  151. package/svelte-demo-app/src/entities/PostTag.ts +22 -0
  152. package/svelte-demo-app/src/entities/Profile.ts +39 -0
  153. package/svelte-demo-app/src/entities/Tag.ts +33 -0
  154. package/svelte-demo-app/src/entities/User.ts +62 -0
  155. package/svelte-demo-app/src/lib/database/Database.ts +30 -0
  156. package/svelte-demo-app/src/lib/entities/Post.ts +47 -0
  157. package/svelte-demo-app/src/lib/entities/PostTag.ts +23 -0
  158. package/svelte-demo-app/src/lib/entities/Profile.ts +40 -0
  159. package/svelte-demo-app/src/lib/entities/Tag.ts +34 -0
  160. package/svelte-demo-app/src/lib/entities/User.ts +59 -0
  161. package/svelte-demo-app/src/lib/index.ts +7 -0
  162. package/svelte-demo-app/src/lib/migrations/001-add-user-email-index.ts +17 -0
  163. package/svelte-demo-app/src/lib/migrations/002-add-post-category.ts +37 -0
  164. package/svelte-demo-app/src/lib/migrations/index.ts +8 -0
  165. package/svelte-demo-app/src/migrations/001-add-user-email-index.ts +17 -0
  166. package/svelte-demo-app/src/migrations/002-add-post-category.ts +37 -0
  167. package/svelte-demo-app/src/migrations/index.ts +8 -0
  168. package/svelte-demo-app/src/routes/+layout.js +3 -0
  169. package/svelte-demo-app/src/routes/+layout.svelte +228 -0
  170. package/svelte-demo-app/src/routes/+page.js +3 -0
  171. package/svelte-demo-app/src/routes/+page.svelte +1305 -0
  172. package/svelte-demo-app/src/stores/appStore.js +603 -0
  173. package/svelte-demo-app/svelte.config.js +18 -0
  174. package/svelte-demo-app/tsconfig.json +14 -0
  175. package/svelte-demo-app/vite.config.ts +6 -0
  176. package/tests/aggregation.e2e.test.ts +87 -0
  177. package/tests/base-entity.e2e.test.ts +47 -0
  178. package/tests/database-api.e2e.test.ts +177 -0
  179. package/tests/decorators.e2e.test.ts +40 -0
  180. package/tests/entity-schema.e2e.test.ts +58 -0
  181. package/tests/relation-loader-table-names.test.ts +192 -0
  182. package/tests/relations.e2e.test.ts +178 -0
  183. package/tests/zod-runtime.e2e.test.ts +69 -0
  184. package/tsconfig.json +21 -0
  185. package/vitest.config.ts +21 -0
  186. package/vitest.setup.ts +27 -0
  187. package/vue-demo-app/README.md +61 -0
  188. package/vue-demo-app/index.html +13 -0
  189. package/vue-demo-app/package-lock.json +1537 -0
  190. package/vue-demo-app/package.json +27 -0
  191. package/vue-demo-app/src/App.vue +100 -0
  192. package/vue-demo-app/src/components/Actions.vue +135 -0
  193. package/vue-demo-app/src/components/CloudSyncDemo.vue +139 -0
  194. package/vue-demo-app/src/components/LiveQueryDemo.vue +122 -0
  195. package/vue-demo-app/src/components/MainInfo.vue +80 -0
  196. package/vue-demo-app/src/components/PostsLiveQueryDemo.vue +136 -0
  197. package/vue-demo-app/src/components/TypeScriptDemo.vue +133 -0
  198. package/vue-demo-app/src/database/Database.ts +29 -0
  199. package/vue-demo-app/src/entities/Post.ts +48 -0
  200. package/vue-demo-app/src/entities/PostTag.ts +24 -0
  201. package/vue-demo-app/src/entities/Profile.ts +41 -0
  202. package/vue-demo-app/src/entities/Tag.ts +35 -0
  203. package/vue-demo-app/src/entities/User.ts +61 -0
  204. package/vue-demo-app/src/main.ts +29 -0
  205. package/vue-demo-app/src/migrations/001-add-user-email-index.ts +23 -0
  206. package/vue-demo-app/src/migrations/002-add-post-category.ts +46 -0
  207. package/vue-demo-app/src/migrations/index.ts +14 -0
  208. package/vue-demo-app/src/services/useAppLogic.ts +565 -0
  209. package/vue-demo-app/src/services/useCloudSyncDemo.ts +84 -0
  210. package/vue-demo-app/src/services/useLiveQueryDemo.ts +82 -0
  211. package/vue-demo-app/src/services/usePostsLiveQueryDemo.ts +77 -0
  212. package/vue-demo-app/src/services/useTypeScriptDemo.ts +56 -0
  213. package/vue-demo-app/src/vite-env.d.ts +1 -0
  214. package/vue-demo-app/tsconfig.json +25 -0
  215. package/vue-demo-app/tsconfig.node.json +10 -0
  216. package/vue-demo-app/vite.config.ts +16 -0
@@ -0,0 +1,82 @@
1
+ import {
2
+ onMounted,ref,
3
+ } from 'vue';
4
+
5
+ import { db } from '../database/Database';
6
+ import { PostEntity } from '../entities/Post';
7
+ import { ProfileEntity } from '../entities/Profile';
8
+ import { UserEntity } from '../entities/User';
9
+
10
+ export function useLiveQueryDemo() {
11
+ const allUsers = ref<UserEntity[] | undefined>(undefined);
12
+ const adultUsers = ref<UserEntity[] | undefined>(undefined);
13
+ const userCount = ref<number | undefined>(undefined);
14
+ const firstUser = ref<UserEntity | undefined>(undefined);
15
+ const usersWithProfiles = ref<Array<UserEntity
16
+ & { profile?: ProfileEntity }> | undefined>(undefined);
17
+ const allPosts = ref<PostEntity[] | undefined>(undefined);
18
+ const allProfiles = ref<ProfileEntity[] | undefined>(undefined);
19
+
20
+ const loadData = async () => {
21
+ try {
22
+ // Load all users
23
+ allUsers.value = await db.table('users').toArray();
24
+
25
+ // Load adult users
26
+ adultUsers.value = await db.getRepository(UserEntity).where('age').above(18).toArray();
27
+
28
+ // Load user count
29
+ userCount.value = await db.getRepository(UserEntity).count();
30
+
31
+ // Load first user
32
+ firstUser.value = await db.getRepository(UserEntity).orderBy('id').first();
33
+
34
+ // Load users with profiles
35
+ const users = await db.getRepository(UserEntity).toArray();
36
+ const usersWithProfilesData: Array<UserEntity
37
+ & { profile?: ProfileEntity }> = [];
38
+
39
+ for (const user of users) {
40
+ if (user.id == null) {
41
+ usersWithProfilesData.push(user as UserEntity
42
+ & { profile?: ProfileEntity });
43
+ continue;
44
+ }
45
+ const profile = await db
46
+ .getRepository(ProfileEntity)
47
+ .where('userId')
48
+ .equals(user.id)
49
+ .first();
50
+ usersWithProfilesData.push(Object.assign(user, { profile }));
51
+ }
52
+ usersWithProfiles.value = usersWithProfilesData;
53
+
54
+ // Load all posts
55
+ allPosts.value = await db.getRepository(PostEntity).toArray();
56
+
57
+ // Load all profiles
58
+ allProfiles.value = await db.getRepository(ProfileEntity).toArray();
59
+ } catch (error) {
60
+ console.error('Error loading live query data:', error);
61
+ }
62
+ };
63
+
64
+ onMounted(() => {
65
+ loadData();
66
+ });
67
+
68
+ // Watch for changes in the database and reload data
69
+ // This is a simplified approach
70
+ // - in a real app you might want to use a more sophisticated reactivity system
71
+ setInterval(loadData, 1000);
72
+
73
+ return {
74
+ allUsers,
75
+ adultUsers,
76
+ userCount,
77
+ firstUser,
78
+ usersWithProfiles,
79
+ allPosts,
80
+ allProfiles,
81
+ };
82
+ }
@@ -0,0 +1,77 @@
1
+ import { newEntity } from 'idb-orm';
2
+ import {
3
+ onMounted,ref,
4
+ } from 'vue';
5
+
6
+ import { db } from '../database/Database';
7
+ import { PostEntity } from '../entities/Post';
8
+
9
+ export function usePostsLiveQueryDemo() {
10
+ const allPosts = ref<PostEntity[] | undefined>(undefined);
11
+ const publishedPosts = ref<PostEntity[] | undefined>(undefined);
12
+ const topPosts = ref<PostEntity[] | undefined>(undefined);
13
+ const postStats = ref<{
14
+ total: number;
15
+ published: number;
16
+ totalLikes: number;
17
+ } | undefined>(undefined);
18
+
19
+ const loadData = async () => {
20
+ try {
21
+ // All posts with sorting
22
+ allPosts.value = await db.getRepository(PostEntity).orderBy('createdAt').reverse().toArray();
23
+
24
+ // Published posts
25
+ publishedPosts.value = await db.getRepository(PostEntity).where('published').equals(1).toArray();
26
+
27
+ // Most liked posts
28
+ topPosts.value = await db.getRepository(PostEntity).orderBy('likes').reverse().limit(3).toArray();
29
+
30
+ // Post statistics
31
+ const total = await db.getRepository(PostEntity).count();
32
+ const published = await db
33
+ .getRepository(PostEntity)
34
+ .where('published')
35
+ .equals(1)
36
+ .count();
37
+ const allPostsData = await db.getRepository(PostEntity).toArray();
38
+ const totalLikes = allPostsData
39
+ .reduce((sum, post) => sum + (post.likes || 0), 0);
40
+
41
+ postStats.value = { total, published, totalLikes };
42
+ } catch (error) {
43
+ console.error('Error loading posts live query data:', error);
44
+ }
45
+ };
46
+
47
+ onMounted(() => {
48
+ loadData();
49
+ });
50
+
51
+ const addSamplePost = async () => {
52
+ try {
53
+ const post = newEntity(PostEntity, {
54
+ title: `Post ${Date.now()}`,
55
+ content: 'This is a sample post added by the useLiveQuery demo!',
56
+ published: Math.random() > 0.5,
57
+ likes: Math.floor(Math.random() * 100),
58
+ postTags: ['demo', 'useLiveQuery'],
59
+ createdAt: Date.now(),
60
+ updatedAt: Date.now(),
61
+ });
62
+
63
+ await db.getRepository(PostEntity).add(post);
64
+ await loadData(); // Reload data after adding
65
+ } catch (error) {
66
+ console.error('Error adding post:', error);
67
+ }
68
+ };
69
+
70
+ return {
71
+ allPosts,
72
+ publishedPosts,
73
+ topPosts,
74
+ postStats,
75
+ addSamplePost,
76
+ };
77
+ }
@@ -0,0 +1,56 @@
1
+ import {
2
+ onMounted,ref,
3
+ } from 'vue';
4
+
5
+ import { db } from '../database/Database';
6
+ import { PostEntity } from '../entities/Post';
7
+ import { ProfileEntity } from '../entities/Profile';
8
+ import { UserEntity } from '../entities/User';
9
+
10
+ export function useTypeScriptDemo() {
11
+ const users = ref<UserEntity[] | undefined>(undefined);
12
+ const posts = ref<PostEntity[] | undefined>(undefined);
13
+ const profiles = ref<ProfileEntity[] | undefined>(undefined);
14
+
15
+ const loadData = async () => {
16
+ try {
17
+ users.value = await db.getRepository(UserEntity).toArray();
18
+ posts.value = await db.getRepository(PostEntity).toArray();
19
+ profiles.value = await db.getRepository(ProfileEntity).toArray();
20
+ } catch (error) {
21
+ console.error('Error loading TypeScript demo data:', error);
22
+ }
23
+ };
24
+
25
+ onMounted(() => {
26
+ loadData();
27
+ });
28
+
29
+ // Test functions - TypeScript should suggest properties
30
+ const handleUserClick = (user: UserEntity) => {
31
+ // IDE should suggest:
32
+ // user.id, user.name, user.email, user.age, user.tags, user.metadata
33
+ console.log('User clicked:', user.name, user.email, user.age);
34
+ };
35
+
36
+ const handlePostClick = (post: PostEntity) => {
37
+ // IDE should suggest:
38
+ // post.id, post.title, post.content, post.published, post.likes, etc.
39
+ console.log('Post clicked:', post.title, post.published, post.likes);
40
+ };
41
+
42
+ const handleProfileClick = (profile: ProfileEntity) => {
43
+ // IDE should suggest:
44
+ // profile.id, profile.userId, profile.bio, profile.avatar, etc.
45
+ console.log('Profile clicked:', profile.bio, profile.website);
46
+ };
47
+
48
+ return {
49
+ users,
50
+ posts,
51
+ profiles,
52
+ handleUserClick,
53
+ handlePostClick,
54
+ handleProfileClick,
55
+ };
56
+ }
@@ -0,0 +1 @@
1
+ /// <reference types="vite/client" />
@@ -0,0 +1,25 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "ES2020",
4
+ "useDefineForClassFields": true,
5
+ "lib": ["ES2020", "DOM", "DOM.Iterable"],
6
+ "module": "ESNext",
7
+ "skipLibCheck": true,
8
+ "moduleResolution": "bundler",
9
+ "allowImportingTsExtensions": true,
10
+ "resolveJsonModule": true,
11
+ "isolatedModules": true,
12
+ "noEmit": true,
13
+ "jsx": "preserve",
14
+ "strict": true,
15
+ "noUnusedLocals": true,
16
+ "noUnusedParameters": true,
17
+ "noFallthroughCasesInSwitch": true,
18
+ "baseUrl": ".",
19
+ "paths": {
20
+ "@/*": ["./src/*"]
21
+ }
22
+ },
23
+ "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"],
24
+ "references": [{ "path": "./tsconfig.node.json" }]
25
+ }
@@ -0,0 +1,10 @@
1
+ {
2
+ "compilerOptions": {
3
+ "composite": true,
4
+ "skipLibCheck": true,
5
+ "module": "ESNext",
6
+ "moduleResolution": "bundler",
7
+ "allowSyntheticDefaultImports": true
8
+ },
9
+ "include": ["vite.config.ts"]
10
+ }
@@ -0,0 +1,16 @@
1
+ import { defineConfig } from 'vite'
2
+ import vue from '@vitejs/plugin-vue'
3
+ import vuetify from 'vite-plugin-vuetify'
4
+ import { fileURLToPath, URL } from 'node:url'
5
+
6
+ export default defineConfig({
7
+ plugins: [
8
+ vue(),
9
+ vuetify({ autoImport: true }),
10
+ ],
11
+ resolve: {
12
+ alias: {
13
+ '@': fileURLToPath(new URL('./src', import.meta.url))
14
+ }
15
+ }
16
+ })