@hotfusion/modeller 0.0.11 → 0.0.15

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 (121) hide show
  1. package/README.md +99 -0
  2. package/dist/adapters/cipher.js +51 -0
  3. package/dist/adapters/cipher.js.map +1 -0
  4. package/dist/connector.js +81 -41
  5. package/dist/connector.js.map +1 -1
  6. package/dist/core.js +2 -48
  7. package/dist/core.js.map +1 -1
  8. package/dist/index.js +9 -1
  9. package/dist/index.js.map +1 -1
  10. package/dist/model.js +27 -50
  11. package/dist/model.js.map +1 -1
  12. package/dist/oidc/adapter.js +177 -0
  13. package/dist/oidc/adapter.js.map +1 -0
  14. package/dist/oidc/adapters/cipher.js +51 -0
  15. package/dist/oidc/adapters/cipher.js.map +1 -0
  16. package/dist/oidc/client.js +66 -0
  17. package/dist/oidc/client.js.map +1 -0
  18. package/dist/oidc/code.js +37 -0
  19. package/dist/oidc/code.js.map +1 -0
  20. package/dist/oidc/default.config.js +200 -0
  21. package/dist/oidc/default.config.js.map +1 -0
  22. package/dist/oidc/federation.js +51 -0
  23. package/dist/oidc/federation.js.map +1 -0
  24. package/dist/oidc/grant.js +37 -0
  25. package/dist/oidc/grant.js.map +1 -0
  26. package/dist/oidc/interaction.js +36 -0
  27. package/dist/oidc/interaction.js.map +1 -0
  28. package/dist/oidc/oidc.config.js +79 -0
  29. package/dist/oidc/oidc.config.js.map +1 -0
  30. package/dist/oidc/schemas/client.schema.json +62 -0
  31. package/dist/oidc/schemas/code.schema.json +16 -0
  32. package/dist/oidc/schemas/grant.schema.json +13 -0
  33. package/dist/oidc/schemas/interaction.schema.json +26 -0
  34. package/dist/oidc/schemas/session.schema.json +14 -0
  35. package/dist/oidc/schemas/token.schema.json +16 -0
  36. package/dist/oidc/schemas/user.schema.json +44 -0
  37. package/dist/oidc/session.js +36 -0
  38. package/dist/oidc/session.js.map +1 -0
  39. package/dist/oidc/session.token.js +24 -0
  40. package/dist/oidc/session.token.js.map +1 -0
  41. package/dist/oidc/token.js +23 -0
  42. package/dist/oidc/token.js.map +1 -0
  43. package/dist/oidc/user.js +95 -0
  44. package/dist/oidc/user.js.map +1 -0
  45. package/dist/oidc/utils.js +154 -0
  46. package/dist/oidc/utils.js.map +1 -0
  47. package/dist/server.js +722 -113
  48. package/dist/server.js.map +1 -1
  49. package/dist/types/adapters/cipher.d.ts +12 -0
  50. package/dist/types/adapters/cipher.d.ts.map +1 -0
  51. package/dist/types/connector.d.ts +13 -1
  52. package/dist/types/connector.d.ts.map +1 -1
  53. package/dist/types/core.d.ts +2 -2
  54. package/dist/types/core.d.ts.map +1 -1
  55. package/dist/types/index.d.ts +4 -0
  56. package/dist/types/index.d.ts.map +1 -1
  57. package/dist/types/model.d.ts +26 -2
  58. package/dist/types/model.d.ts.map +1 -1
  59. package/dist/types/oidc/adapter.d.ts +16 -0
  60. package/dist/types/oidc/adapter.d.ts.map +1 -0
  61. package/dist/types/oidc/adapters/cipher.d.ts +12 -0
  62. package/dist/types/oidc/adapters/cipher.d.ts.map +1 -0
  63. package/dist/types/oidc/client.d.ts +3 -0
  64. package/dist/types/oidc/client.d.ts.map +1 -0
  65. package/dist/types/oidc/code.d.ts +3 -0
  66. package/dist/types/oidc/code.d.ts.map +1 -0
  67. package/dist/types/oidc/default.config.d.ts +33 -0
  68. package/dist/types/oidc/default.config.d.ts.map +1 -0
  69. package/dist/types/oidc/federation.d.ts +3 -0
  70. package/dist/types/oidc/federation.d.ts.map +1 -0
  71. package/dist/types/oidc/grant.d.ts +3 -0
  72. package/dist/types/oidc/grant.d.ts.map +1 -0
  73. package/dist/types/oidc/interaction.d.ts +3 -0
  74. package/dist/types/oidc/interaction.d.ts.map +1 -0
  75. package/dist/types/oidc/oidc.config.d.ts +7 -0
  76. package/dist/types/oidc/oidc.config.d.ts.map +1 -0
  77. package/dist/types/oidc/session.d.ts +3 -0
  78. package/dist/types/oidc/session.d.ts.map +1 -0
  79. package/dist/types/oidc/session.token.d.ts +3 -0
  80. package/dist/types/oidc/session.token.d.ts.map +1 -0
  81. package/dist/types/oidc/token.d.ts +3 -0
  82. package/dist/types/oidc/token.d.ts.map +1 -0
  83. package/dist/types/oidc/user.d.ts +3 -0
  84. package/dist/types/oidc/user.d.ts.map +1 -0
  85. package/dist/types/oidc/utils.d.ts +56 -0
  86. package/dist/types/oidc/utils.d.ts.map +1 -0
  87. package/dist/types/server.d.ts +8 -3
  88. package/dist/types/server.d.ts.map +1 -1
  89. package/dist/types/types.d.ts +264 -0
  90. package/dist/types/utils/bundler.d.ts.map +1 -1
  91. package/dist/types/utils/display.d.ts +23 -0
  92. package/dist/types/utils/display.d.ts.map +1 -0
  93. package/dist/utils/_secret.key +1 -1
  94. package/dist/utils/bundler.js +47 -8
  95. package/dist/utils/bundler.js.map +1 -1
  96. package/dist/utils/display.js +207 -0
  97. package/dist/utils/display.js.map +1 -0
  98. package/package.json +30 -7
  99. package/dist/View.js +0 -3
  100. package/dist/View.js.map +0 -1
  101. package/dist/extensions/oidc/client.js +0 -221
  102. package/dist/extensions/oidc/client.js.map +0 -1
  103. package/dist/extensions/oidc/index.js +0 -192
  104. package/dist/extensions/oidc/index.js.map +0 -1
  105. package/dist/types/View.d.ts +0 -2
  106. package/dist/types/View.d.ts.map +0 -1
  107. package/dist/types/extensions/oidc/client.d.ts +0 -32
  108. package/dist/types/extensions/oidc/client.d.ts.map +0 -1
  109. package/dist/types/extensions/oidc/index.d.ts +0 -20
  110. package/dist/types/extensions/oidc/index.d.ts.map +0 -1
  111. package/dist/types/extensions/oidc/oidc.d.ts +0 -20
  112. package/dist/types/extensions/oidc/oidc.d.ts.map +0 -1
  113. package/dist/types/extensions/oidc.d.ts +0 -20
  114. package/dist/types/extensions/oidc.d.ts.map +0 -1
  115. package/dist/utils/entry.js +0 -13
  116. package/docs/CORE.md +0 -191
  117. package/docs/ERRORS.md +0 -90
  118. package/docs/MODEL.md +0 -296
  119. package/docs/PATTERNS.md +0 -182
  120. package/docs/SERVER.md +0 -88
  121. package/docs/UTILITIES.md +0 -111
@@ -1,192 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.OIDCExtension = void 0;
4
- const jose_1 = require("jose");
5
- const client_1 = require("./client");
6
- class OIDCExtensionImpl {
7
- id = 'oidc';
8
- providers = [];
9
- authPath = 'auth';
10
- async setup(server, config) {
11
- console.log('[OIDCExtension] setup called with config:', config);
12
- this.providers = config.providers || [];
13
- this.authPath = config.authPath || 'auth';
14
- console.log('[OIDCExtension] Providers:', this.providers.map(p => p.id));
15
- console.log('[OIDCExtension] Auth path:', this.authPath);
16
- // Register auth routes
17
- await this._setupAuthRoutes(server);
18
- console.log('[OIDCExtension] Auth routes setup complete');
19
- }
20
- async _setupAuthRoutes(server) {
21
- try {
22
- console.log('[OIDCExtension] _setupAuthRoutes called');
23
- let path = this.authPath;
24
- if (server.config?.domain)
25
- path = `${server.config.domain}/${path}`;
26
- path = path.split('/').filter((x) => x).join('/');
27
- const trimmedPath = '/' + path.split('/').filter((x) => x).join('/');
28
- console.log('[OIDCExtension] Registering routes with path:', trimmedPath);
29
- // ?? Callback route ??????????????????????????????????????????????????????
30
- console.log('[OIDCExtension] About to register callback route at:', trimmedPath + '/callback');
31
- server.router.get(trimmedPath + '/callback', async (ctx) => {
32
- console.log('[OIDCExtension] Callback handler called');
33
- try {
34
- let origin = ctx.session?.oidc?.query?.origin || '';
35
- const session = ctx.session?.oidc;
36
- console.log('[OIDCExtension] Session data in callback:', {
37
- hasSession: !!session,
38
- hasProvider: !!session?.provider,
39
- hasCodeVerifier: !!session?.code_verifier,
40
- codeVerifierLength: session?.code_verifier?.length,
41
- providerId: session?.provider?.id,
42
- });
43
- if (session?.code_verifier) {
44
- console.log('[OIDCExtension] Code verifier found:', session.code_verifier.substring(0, 20) + '...');
45
- }
46
- if (!session) {
47
- ctx.status = 400;
48
- ctx.body = { error: 'No session found' };
49
- return;
50
- }
51
- const code = ctx.query.code;
52
- if (!code) {
53
- ctx.status = 400;
54
- ctx.body = { error: 'No authorization code provided' };
55
- return;
56
- }
57
- console.log('[OIDCExtension] Token exchange params:', {
58
- code: code.substring(0, 20) + '...',
59
- codeVerifier: session.code_verifier.substring(0, 20) + '...',
60
- provider: session.provider.id,
61
- });
62
- // Build IClient config from session provider
63
- const clientConfig = {
64
- clientId: session.provider.clientId,
65
- clientSecret: session.provider.clientSecret,
66
- redirectUri: `http://localhost:${server['port'] || 3030}/auth/callback`,
67
- endpoints: {
68
- authentication: session.provider.endpoints?.authentication || 'https://accounts.google.com',
69
- token: session.provider.endpoints?.token || 'https://oauth2.googleapis.com/token',
70
- profile: session.provider.endpoints?.profile || 'https://www.googleapis.com/oauth2/v1/userinfo',
71
- }
72
- };
73
- console.log('[OIDCExtension] Creating OIDCClient with config:', {
74
- clientId: clientConfig.clientId,
75
- redirectUri: clientConfig.redirectUri,
76
- });
77
- const oidcClient = new client_1.OIDCClient(clientConfig);
78
- console.log('[OIDCExtension] Calling getToken with full URL...');
79
- // Construct full callback URL - ctx.originalUrl already includes the path and query
80
- const fullCallbackUrl = `http://localhost:${server['port'] || 3030}${ctx.originalUrl}`;
81
- console.log('[OIDCExtension] Full callback URL:', fullCallbackUrl);
82
- const TokenCollection = await oidcClient.getToken(code, session.code_verifier, fullCallbackUrl);
83
- console.log('[OIDCExtension] Token received:', {
84
- hasAccessToken: !!TokenCollection.accessToken,
85
- hasRefreshToken: !!TokenCollection.refreshToken,
86
- claimsEmail: TokenCollection.claims?.email,
87
- });
88
- server.emit('provider', { token: TokenCollection, sid: session.__SID, session });
89
- ctx.type = 'html';
90
- ctx.body = `<script>window?.close?.()</script>`;
91
- }
92
- catch (err) {
93
- console.error('[OIDCExtension] Error in callback handler:', err.message);
94
- console.error('[OIDCExtension] Full error:', err);
95
- ctx.status = 500;
96
- ctx.body = { error: err.message, details: err.toString() };
97
- }
98
- });
99
- // ?? Login route ????????????????????????????????????????????????????????
100
- server.router.get(trimmedPath + '/:provider', async (ctx) => {
101
- if (ctx.params.provider === 'callback')
102
- return;
103
- let provider = this.providers.find(x => x.id === ctx.params.provider);
104
- if (provider) {
105
- try {
106
- console.log('[OIDCExtension] Login handler called for provider:', provider.id);
107
- // Build IClient config from IOIDCProvider
108
- const clientConfig = {
109
- clientId: provider.clientId,
110
- clientSecret: provider.clientSecret,
111
- redirectUri: `http://localhost:${server['port'] || 3030}/auth/callback`,
112
- endpoints: {
113
- authentication: provider.endpoints?.authentication || 'https://accounts.google.com',
114
- token: provider.endpoints?.token || 'https://oauth2.googleapis.com/token',
115
- profile: provider.endpoints?.profile || 'https://www.googleapis.com/oauth2/v1/userinfo',
116
- }
117
- };
118
- console.log('[OIDCExtension] Client config:', clientConfig);
119
- let { url, code_verifier, state } = await new client_1.OIDCClient(clientConfig).buildURL(provider.scopes.join(' '));
120
- console.log('[OIDCExtension] Got OAuth URL:', url.toString());
121
- let { middleware } = ctx.request.query || {};
122
- if (!ctx.session)
123
- ctx.session = {};
124
- ctx.session.oidc = {
125
- __SID: ctx.query.__SID,
126
- provider,
127
- code_verifier,
128
- state,
129
- middleware: middleware || false,
130
- query: (ctx.request.querystring || '').replace(/^\?/, '')
131
- .split('&')
132
- .filter(Boolean)
133
- .reduce((acc, pair) => {
134
- const [key, value = ''] = pair.split('=');
135
- acc[decodeURIComponent(key)] = decodeURIComponent(value);
136
- return acc;
137
- }, {})
138
- };
139
- await ctx.session.save?.();
140
- console.log('[OIDCExtension] Session saved with OIDC data:', {
141
- hasSID: !!ctx.session.oidc?.__SID,
142
- hasProvider: !!ctx.session.oidc?.provider?.id,
143
- hasCodeVerifier: !!ctx.session.oidc?.code_verifier,
144
- hasState: !!ctx.session.oidc?.state,
145
- codeVerifierLength: ctx.session.oidc?.code_verifier?.length,
146
- });
147
- console.log('[OIDCExtension] Full session OIDC:', JSON.stringify(ctx.session.oidc, null, 2));
148
- console.log('[OIDCExtension] Redirecting to OAuth URL');
149
- ctx.redirect(url.toString());
150
- return;
151
- }
152
- catch (e) {
153
- console.error('[OIDCExtension] Error in login handler:', e.message, e.stack);
154
- ctx.status = 500;
155
- ctx.body = { error: e.message, stack: e.stack };
156
- }
157
- }
158
- });
159
- // ?? Logout route ???????????????????????????????????????????????????????
160
- server.router.post(trimmedPath + '/:provider/logout', async (ctx) => {
161
- if (ctx.params.provider === 'callback' || !ctx.path.includes('/logout'))
162
- return;
163
- let provider = this.providers.find(x => x.id === ctx.params.provider);
164
- if (provider) {
165
- let SESSION = ctx.headers.authorization || '';
166
- if (!SESSION)
167
- ctx.throw(401, 'Unauthorized');
168
- if (SESSION) {
169
- SESSION = SESSION.split(' ').pop() || '';
170
- let token;
171
- try {
172
- token = (await (0, jose_1.jwtVerify)(SESSION, new TextEncoder().encode(Array.isArray(server.app?.keys) ? server.app.keys[0] : undefined))).payload;
173
- }
174
- catch (e) {
175
- token = (0, jose_1.decodeJwt)(SESSION);
176
- }
177
- let body = {};
178
- await new Promise(resolve => setTimeout(resolve, 1000));
179
- ctx.body = body;
180
- }
181
- }
182
- });
183
- console.log('[OIDCExtension] All routes registered successfully');
184
- }
185
- catch (err) {
186
- console.error('[OIDCExtension] ERROR in _setupAuthRoutes:', err.message, err.stack);
187
- throw err;
188
- }
189
- }
190
- }
191
- exports.OIDCExtension = new OIDCExtensionImpl();
192
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/extensions/oidc/index.ts"],"names":[],"mappings":";;;AACA,+BAA4C;AAG5C,qCAAmC;AAgBnC,MAAM,iBAAiB;IACnB,EAAE,GAAG,MAAM,CAAC;IACJ,SAAS,GAAoB,EAAE,CAAC;IAChC,QAAQ,GAAW,MAAM,CAAC;IAElC,KAAK,CAAC,KAAK,CAAC,MAAc,EAAE,MAA4B;QACpD,OAAO,CAAC,GAAG,CAAC,2CAA2C,EAAE,MAAM,CAAC,CAAC;QACjE,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC;QAE1C,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACzE,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEzD,uBAAuB;QACvB,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC;IAC9D,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,MAAc;QACzC,IAAI,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;YACvD,IAAI,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC;YACzB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM;gBACrB,IAAI,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YAE7C,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC1D,MAAM,WAAW,GAAG,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAE7E,OAAO,CAAC,GAAG,CAAC,+CAA+C,EAAE,WAAW,CAAC,CAAC;YAE1E,2EAA2E;YAC3E,OAAO,CAAC,GAAG,CAAC,sDAAsD,EAAE,WAAW,GAAG,WAAW,CAAC,CAAC;YAC/F,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,EAAE,KAAK,EAAE,GAAmB,EAAE,EAAE;gBACvE,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;gBACvD,IAAI,CAAC;oBACD,IAAI,MAAM,GACJ,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,IAAI,EAAE,CAAC;oBAE7C,MAAM,OAAO,GACP,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC;oBAExB,OAAO,CAAC,GAAG,CAAC,2CAA2C,EAAE;wBACrD,UAAU,EAAE,CAAC,CAAC,OAAO;wBACrB,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,QAAQ;wBAChC,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,aAAa;wBACzC,kBAAkB,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM;wBAClD,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE;qBACpC,CAAC,CAAC;oBAEH,IAAI,OAAO,EAAE,aAAa,EAAE,CAAC;wBACzB,OAAO,CAAC,GAAG,CAAC,sCAAsC,EAAE,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC;oBACxG,CAAC;oBAED,IAAI,CAAC,OAAO,EAAE,CAAC;wBACX,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;wBACjB,GAAG,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;wBACzC,OAAO;oBACX,CAAC;oBAED,MAAM,IAAI,GACJ,GAAG,CAAC,KAAK,CAAC,IAAc,CAAC;oBAE/B,IAAI,CAAC,IAAI,EAAE,CAAC;wBACR,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;wBACjB,GAAG,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,gCAAgC,EAAE,CAAC;wBACvD,OAAO;oBACX,CAAC;oBAED,OAAO,CAAC,GAAG,CAAC,wCAAwC,EAAE;wBAClD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK;wBACnC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK;wBAC5D,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE;qBAChC,CAAC,CAAC;oBAEH,6CAA6C;oBAC7C,MAAM,YAAY,GAAG;wBACjB,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ;wBACnC,YAAY,EAAE,OAAO,CAAC,QAAQ,CAAC,YAAY;wBAC3C,WAAW,EAAE,oBAAoB,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,gBAAgB;wBACvE,SAAS,EAAE;4BACP,cAAc,EAAG,OAAO,CAAC,QAAgB,CAAC,SAAS,EAAE,cAAc,IAAI,6BAA6B;4BACpG,KAAK,EAAG,OAAO,CAAC,QAAgB,CAAC,SAAS,EAAE,KAAK,IAAI,qCAAqC;4BAC1F,OAAO,EAAG,OAAO,CAAC,QAAgB,CAAC,SAAS,EAAE,OAAO,IAAI,+CAA+C;yBAC3G;qBACJ,CAAC;oBAEF,OAAO,CAAC,GAAG,CAAC,kDAAkD,EAAE;wBAC5D,QAAQ,EAAE,YAAY,CAAC,QAAQ;wBAC/B,WAAW,EAAE,YAAY,CAAC,WAAW;qBACxC,CAAC,CAAC;oBAEH,MAAM,UAAU,GACV,IAAI,mBAAU,CAAC,YAAmB,CAAC,CAAC;oBAE1C,OAAO,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC;oBACjE,oFAAoF;oBACpF,MAAM,eAAe,GAAG,oBAAoB,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;oBACvF,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,eAAe,CAAC,CAAC;oBAEnE,MAAM,eAAe,GACf,MAAM,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,aAAa,EAAE,eAAe,CAAC,CAAA;oBAE7E,OAAO,CAAC,GAAG,CAAC,iCAAiC,EAAE;wBAC3C,cAAc,EAAE,CAAC,CAAC,eAAe,CAAC,WAAW;wBAC7C,eAAe,EAAE,CAAC,CAAC,eAAe,CAAC,YAAY;wBAC/C,WAAW,EAAE,eAAe,CAAC,MAAM,EAAE,KAAK;qBAC7C,CAAC,CAAC;oBAEH,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,EAAC,KAAK,EAAE,eAAe,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,EAAC,CAAC,CAAC;oBAC/E,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC;oBAClB,GAAG,CAAC,IAAI,GAAG,oCAAoC,CAAA;gBACnD,CAAC;gBAAC,OAAO,GAAQ,EAAE,CAAC;oBAChB,OAAO,CAAC,KAAK,CAAC,4CAA4C,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;oBACzE,OAAO,CAAC,KAAK,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAC;oBAClD,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;oBACjB,GAAG,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC;gBAC/D,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,0EAA0E;YAC1E,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,GAAG,YAAY,EAAE,KAAK,EAAE,GAAmB,EAAE,EAAE;gBACxE,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,KAAK,UAAU;oBAClC,OAAO;gBAEX,IAAI,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBAEtE,IAAI,QAAQ,EAAE,CAAC;oBACX,IAAG,CAAC;wBACA,OAAO,CAAC,GAAG,CAAC,oDAAoD,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;wBAE/E,0CAA0C;wBAC1C,MAAM,YAAY,GAAG;4BACjB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;4BAC3B,YAAY,EAAE,QAAQ,CAAC,YAAY;4BACnC,WAAW,EAAE,oBAAoB,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,gBAAgB;4BACvE,SAAS,EAAE;gCACP,cAAc,EAAG,QAAgB,CAAC,SAAS,EAAE,cAAc,IAAI,6BAA6B;gCAC5F,KAAK,EAAG,QAAgB,CAAC,SAAS,EAAE,KAAK,IAAI,qCAAqC;gCAClF,OAAO,EAAG,QAAgB,CAAC,SAAS,EAAE,OAAO,IAAI,+CAA+C;6BACnG;yBACJ,CAAC;wBAEF,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,YAAY,CAAC,CAAC;wBAE5D,IAAI,EAAC,GAAG,EAAE,aAAa,EAAE,KAAK,EAAC,GACzB,MAAM,IAAI,mBAAU,CAAC,YAAmB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;wBAEpF,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;wBAE9D,IAAI,EAAC,UAAU,EAAC,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;wBAC3C,IAAI,CAAC,GAAG,CAAC,OAAO;4BAAE,GAAG,CAAC,OAAO,GAAG,EAAE,CAAC;wBAEnC,GAAG,CAAC,OAAO,CAAC,IAAI,GAAG;4BACf,KAAK,EAAG,GAAG,CAAC,KAAK,CAAC,KAAK;4BACvB,QAAQ;4BACR,aAAa;4BACb,KAAK;4BACL,UAAU,EAAE,UAAU,IAAI,KAAK;4BAC/B,KAAK,EAAG,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;iCACrD,KAAK,CAAC,GAAG,CAAC;iCACV,MAAM,CAAC,OAAO,CAAC;iCACf,MAAM,CAAyB,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;gCAC1C,MAAM,CAAC,GAAG,EAAE,KAAK,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gCAC1C,GAAG,CAAC,kBAAkB,CAAC,GAAU,CAAE,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;gCACjE,OAAO,GAAG,CAAC;4BACf,CAAC,EAAE,EAAE,CAAC;yBACb,CAAC;wBAEF,MAAM,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;wBAC3B,OAAO,CAAC,GAAG,CAAC,+CAA+C,EAAE;4BACzD,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK;4BACjC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;4BAC7C,eAAe,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,aAAa;4BAClD,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK;4BACnC,kBAAkB,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM;yBAC9D,CAAC,CAAC;wBACH,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;wBAC7F,OAAO,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAC;wBACxD,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;wBAC7B,OAAO;oBACX,CAAC;oBAAA,OAAO,CAAM,EAAC,CAAC;wBACZ,OAAO,CAAC,KAAK,CAAC,yCAAyC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;wBAC7E,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;wBACjB,GAAG,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;oBACpD,CAAC;gBACL,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,0EAA0E;YAC1E,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,GAAG,mBAAmB,EAAE,KAAK,EAAE,GAAmB,EAAE,EAAE;gBAChF,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,KAAK,UAAU,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;oBACnE,OAAO;gBAEX,IAAI,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBAEtE,IAAI,QAAQ,EAAE,CAAC;oBACX,IAAI,OAAO,GAAW,GAAG,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC;oBAEtD,IAAI,CAAC,OAAO;wBACR,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;oBAEnC,IAAG,OAAO,EAAE,CAAC;wBACT,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;wBACzC,IAAI,KAAW,CAAC;wBAEhB,IAAG,CAAC;4BACA,KAAK,GAAG,CAAC,MAAM,IAAA,gBAAS,EAAC,OAAiB,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAc,CAAC;wBAC5J,CAAC;wBAAA,OAAM,CAAC,EAAC,CAAC;4BACN,KAAK,GAAG,IAAA,gBAAS,EAAC,OAAiB,CAAC,CAAC;wBACzC,CAAC;wBAED,IAAI,IAAI,GAAG,EAAE,CAAA;wBACb,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;wBACxD,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;oBACpB,CAAC;gBACL,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,OAAO,CAAC,GAAG,CAAC,oDAAoD,CAAC,CAAC;QACtE,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,OAAO,CAAC,KAAK,CAAC,4CAA4C,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;YACpF,MAAM,GAAG,CAAC;QACd,CAAC;IACL,CAAC;CACJ;AAEY,QAAA,aAAa,GAAG,IAAI,iBAAiB,EAAE,CAAC"}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=View.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"View.d.ts","sourceRoot":"","sources":["../../src/View.ts"],"names":[],"mappings":""}
@@ -1,32 +0,0 @@
1
- import type { IClient } from '../../types.d.ts';
2
- export declare class OIDCClient {
3
- client: IClient;
4
- constructor(client: IClient);
5
- static decodeIdToken(idToken: string): import("jose", { with: { "resolution-mode": "import" } }).JWTPayload;
6
- validateIdToken(idToken: string): Promise<any>;
7
- retrieveUser(accessToken: string): Promise<any>;
8
- retrieveAccessToken(code: string): Promise<{
9
- access_token: string;
10
- }>;
11
- isDiscoverable(): Promise<boolean>;
12
- getProfile(code: string, code_verifier?: string): Promise<{
13
- protocol: 'oidc' | 'oauth2';
14
- claims: any;
15
- idToken: any;
16
- accessToken: any;
17
- refreshToken: any;
18
- }>;
19
- getToken(code: string, code_verifier: string, callbackUrlFull?: string): Promise<{
20
- refreshToken: string;
21
- accessToken: string;
22
- claims: any;
23
- }>;
24
- readWHATWGStream(body: ReadableStream): Promise<string>;
25
- buildURL(scope: string): Promise<{
26
- url: URL;
27
- code_verifier: string;
28
- code_challenge: string;
29
- state: string;
30
- }>;
31
- }
32
- //# sourceMappingURL=client.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/extensions/oidc/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAIhD,qBAAa,UAAU;IACnB,MAAM,EAAE,OAAO,CAAA;gBACF,MAAM,EAAC,OAAO;IAG3B,MAAM,CAAC,aAAa,CAAC,OAAO,EAAC,MAAM;IAG7B,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyB9C,YAAY,CAAC,WAAW,EAAC,MAAM;IAM/B,mBAAmB,CAAC,IAAI,EAAC,MAAM,GAAE,OAAO,CAAC;QAAC,YAAY,EAAC,MAAM,CAAA;KAAC,CAAC;IAmB/D,cAAc;IAad,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAE,OAAO,CAAC;QAAC,QAAQ,EAAC,MAAM,GAAG,QAAQ,CAAC;QAAC,MAAM,EAAC,GAAG,CAAC;QAAA,OAAO,EAAC,GAAG,CAAC;QAAA,WAAW,EAAC,GAAG,CAAC;QAAA,YAAY,EAAC,GAAG,CAAA;KAAE,CAAC;IAmDhJ,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QACnF,YAAY,EAAE,MAAM,CAAC;QACrB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,GAAG,CAAA;KACd,CAAC;IAiCI,gBAAgB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAevD,QAAQ,CAAC,KAAK,EAAC,MAAM,GAAI,OAAO,CAAC;QAAC,GAAG,EAAC,GAAG,CAAC;QAAA,aAAa,EAAC,MAAM,CAAC;QAAA,cAAc,EAAC,MAAM,CAAC;QAAA,KAAK,EAAC,MAAM,CAAA;KAAC,CAAC;CA2D5G"}
@@ -1,20 +0,0 @@
1
- import type { Server } from '../../server';
2
- import type { IOIDCProvider } from '../../types.d.ts';
3
- export interface IServerExtension {
4
- id: string;
5
- setup(server: Server, config: any): void | Promise<void>;
6
- }
7
- export interface IOIDCExtensionConfig {
8
- providers: IOIDCProvider[];
9
- authPath?: string;
10
- }
11
- declare class OIDCExtensionImpl implements IServerExtension {
12
- id: string;
13
- private providers;
14
- private authPath;
15
- setup(server: Server, config: IOIDCExtensionConfig): Promise<void>;
16
- private _setupAuthRoutes;
17
- }
18
- export declare const OIDCExtension: OIDCExtensionImpl;
19
- export {};
20
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/extensions/oidc/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGtD,MAAM,WAAW,gBAAgB;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,oBAAoB;IACjC,SAAS,EAAE,aAAa,EAAE,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAMD,cAAM,iBAAkB,YAAW,gBAAgB;IAC/C,EAAE,SAAU;IACZ,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,QAAQ,CAAkB;IAE5B,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;YAa1D,gBAAgB;CA8MjC;AAED,eAAO,MAAM,aAAa,mBAA0B,CAAC"}
@@ -1,20 +0,0 @@
1
- import type { Server } from '../../server';
2
- import type { IOIDCProvider } from '../../types.d.ts';
3
- export interface IServerExtension {
4
- id: string;
5
- setup(server: Server, config: any): void | Promise<void>;
6
- }
7
- export interface IOIDCExtensionConfig {
8
- providers: IOIDCProvider[];
9
- authPath?: string;
10
- }
11
- declare class OIDCExtensionImpl implements IServerExtension {
12
- id: string;
13
- private providers;
14
- private authPath;
15
- setup(server: Server, config: IOIDCExtensionConfig): Promise<void>;
16
- private _setupAuthRoutes;
17
- }
18
- export declare const OIDCExtension: OIDCExtensionImpl;
19
- export {};
20
- //# sourceMappingURL=oidc.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"oidc.d.ts","sourceRoot":"","sources":["../../../../src/extensions/oidc/oidc.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEtD,MAAM,WAAW,gBAAgB;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,oBAAoB;IACjC,SAAS,EAAE,aAAa,EAAE,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,cAAM,iBAAkB,YAAW,gBAAgB;IAC/C,EAAE,SAAU;IACZ,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,QAAQ,CAAkB;IAE5B,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQxE,OAAO,CAAC,gBAAgB;CAoG3B;AAED,eAAO,MAAM,aAAa,mBAA0B,CAAC"}
@@ -1,20 +0,0 @@
1
- import type { Server } from '../server';
2
- import type { IOIDCProvider } from '../types.d.ts';
3
- export interface IServerExtension {
4
- id: string;
5
- setup(server: Server, config: any): void | Promise<void>;
6
- }
7
- export interface IOIDCExtensionConfig {
8
- providers: IOIDCProvider[];
9
- authPath?: string;
10
- }
11
- declare class OIDCExtensionImpl implements IServerExtension {
12
- id: string;
13
- private providers;
14
- private authPath;
15
- setup(server: Server, config: IOIDCExtensionConfig): Promise<void>;
16
- private _setupAuthRoutes;
17
- }
18
- export declare const OIDCExtension: OIDCExtensionImpl;
19
- export {};
20
- //# sourceMappingURL=oidc.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"oidc.d.ts","sourceRoot":"","sources":["../../../src/extensions/oidc.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnD,MAAM,WAAW,gBAAgB;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,oBAAoB;IACjC,SAAS,EAAE,aAAa,EAAE,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,cAAM,iBAAkB,YAAW,gBAAgB;IAC/C,EAAE,SAAU;IACZ,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,QAAQ,CAAkB;IAE5B,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQxE,OAAO,CAAC,gBAAgB;CAoG3B;AAED,eAAO,MAAM,aAAa,mBAA0B,CAAC"}
@@ -1,13 +0,0 @@
1
- import "./index.less"
2
- import {createApp} from 'vue';
3
- import Component from '${relPath}';
4
-
5
-
6
- window.__HF_MOUNT__ = async (props = {}) => {
7
- try {
8
- createApp(Component, props).mount('#app');
9
- } catch (error) {
10
- console.error('Error in bundle:', error);
11
- }
12
-
13
- };
package/docs/CORE.md DELETED
@@ -1,191 +0,0 @@
1
- # Core Layer
2
-
3
- `Core` is the in-memory data primitive. It holds documents, validates them against a schema, supports indexed lookups, mingo queries, and an optional persistence adapter. Everything in this doc is inherited by `Model`, so you can ignore Core if you only ever use `Model` — but understanding it explains where the behavior comes from.
4
-
5
- > [← Back to README](../README.md)
6
-
7
- ---
8
-
9
- ## Table of Contents
10
-
11
- - [Schema](#schema)
12
- - [Validator](#validator)
13
- - [CRUD primitives](#crud-primitives)
14
- - [Indexes](#indexes)
15
- - [Adapter](#adapter)
16
- - [Trash](#trash)
17
-
18
- ---
19
-
20
- ## Schema
21
-
22
- Schemas are JSON Schema (AJV-compatible) plus a few Modeller-specific keywords:
23
-
24
- | Keyword | Effect |
25
- |-------------|-------------------------------------------------------------------------|
26
- | `unique` | Enforces uniqueness across all documents on `insert` / `update`. |
27
- | `private` | Field stripped from read responses unless `{ private: true }` is set. |
28
- | `index` | Builds an in-memory index on the field for fast lookups. |
29
- | `protected` | Reserved for transport-layer protection (consumed by `Server`). |
30
- | `hidden` | Hint for client rendering. Not enforced. |
31
- | `default` | Standard JSON Schema default. |
32
- | `model` | Async FK-style validation against another model by id. |
33
-
34
- ### `$ref` resolution
35
-
36
- `$ref` resolves against `$defs` / `definitions` first, then against any `schemes` passed to the constructor (via `$id` match).
37
-
38
- A `$ref` may also carry a query string:
39
-
40
- ```
41
- "someModel?key=_id&label=name&search=name,email&columns=name,role&min=1&max=5&unique"
42
- ```
43
-
44
- This rewrites the property into a model reference with display metadata (`key`, `label`, `search`, `columns`) — used by client tooling to render pickers. For `type: 'array'`, `min` / `max` / `unique` become `minItems` / `maxItems` / `uniqueItemProperties`.
45
-
46
- ### Inspecting the schema
47
-
48
- ```ts
49
- model.getSchema(); // public — strips `private` fields
50
- model.getSchema({ private: true }); // full
51
- ```
52
-
53
- ---
54
-
55
- ## Validator
56
-
57
- AJV with `allErrors`, `strict: false`, `ajv-formats`, and `ajv-errors`. Two custom formats are registered:
58
-
59
- - `phone` — `+?[0-9 \-()]{7,10}`
60
- - `password` — at least 8 chars, mixed case, digit, symbol
61
-
62
- And one custom keyword:
63
-
64
- - `model` (async) — value must reference an existing document in the named model. Used for FK-style references.
65
-
66
- ```ts
67
- properties: {
68
- ownerId: { type: 'string', model: 'users.email' }
69
- }
70
- ```
71
-
72
- ---
73
-
74
- ## CRUD primitives
75
-
76
- All CRUD methods are async. They throw `{ code, ... }` on failure (see [Errors](./ERRORS.md)).
77
-
78
- ### `insert(key?, ...patches, opts?)`
79
-
80
- Merges `key` and any patch objects into a single document, validates, assigns a BSON `ObjectId`, and stores it.
81
-
82
- ```ts
83
- await users.insert({ email: 'a@b.com' }, { name: 'Alex' });
84
- await users.insert({ email: 'admin@b.com' }, { role: 'admin' }, { private: true });
85
- ```
86
-
87
- Returns the inserted document. `private: true` includes `private` fields in the response.
88
-
89
- ### `update(key, updates, opts?)`
90
-
91
- Finds a document by `key` (mingo query), shallow-merges `updates`, re-validates, and saves.
92
-
93
- ```ts
94
- await users.update({ _id }, { name: 'Alex H.' });
95
- ```
96
-
97
- Returns the merged document, or `null` if no match.
98
-
99
- ### `delete(key)`
100
-
101
- Removes the matching document. If an adapter is configured and `trash` is not disabled, the document is moved to the trash bin.
102
-
103
- ```ts
104
- await users.delete({ _id }); // → { _id } or null
105
- ```
106
-
107
- ### `get(key, opts?)`
108
-
109
- Returns a single document or `null`.
110
-
111
- ```ts
112
- await users.get({ email: 'a@b.com' });
113
- await users.get({ _id }, { private: true });
114
- ```
115
-
116
- ### `list(query?, opts?)`
117
-
118
- Paginated, **exact-match** mingo query.
119
-
120
- ```ts
121
- await users.list({ role: 'admin' }, { start: 0, count: 25, private: false });
122
- ```
123
-
124
- Default `count` is 10.
125
-
126
- ### `find(query?, opts?)`
127
-
128
- Like `list`, but **strings match as case-insensitive substrings**. Non-string values match exactly. Returns an array.
129
-
130
- ```ts
131
- await users.find({ name: 'al' }, { max: 10 });
132
- // → [{ name: 'Alex' }, { name: 'Albert' }, ...]
133
- ```
134
-
135
- Default `max` is 10.
136
-
137
- > **`list` vs `find`** — `list` is for paginated, exact-match queries (admin views, dashboards). `find` is for autocomplete and search. `list` fires hooks; `find` does not.
138
-
139
- ---
140
-
141
- ## Indexes
142
-
143
- Any property with `index: <number>` in its schema gets a per-field hash index built and maintained automatically. Indexes are used internally to keep large collections fast.
144
-
145
- ```ts
146
- properties: {
147
- email : { type: 'string', index: 1 }
148
- }
149
- ```
150
-
151
- ---
152
-
153
- ## Adapter
154
-
155
- Models are in-memory by default. Provide an `Adapter` subclass to persist on every write and rehydrate on `pull()`.
156
-
157
- ```ts
158
- import { Adapter, Model } from '@hotfusion/modeller';
159
-
160
- class FileAdapter extends Adapter {
161
- async sync(id, doc) { /* called on every write */ }
162
- async pull() { /* return array of docs to load */ return []; }
163
- }
164
-
165
- const users = new Model('users', schema, { adapter: FileAdapter });
166
- await users.pull(); // hydrate before serving traffic
167
- ```
168
-
169
- The Adapter contract:
170
-
171
- ```ts
172
- class Adapter {
173
- constructor(id: string) {}
174
- async sync(id: string, doc: { _id: string, ... }): Promise<void>;
175
- async pull(): Promise<any[]>;
176
- }
177
- ```
178
-
179
- Modeller calls `sync` on every `insert`, `update`, and `delete` — including trash moves. `pull()` is called manually when you want to rehydrate.
180
-
181
- ---
182
-
183
- ## Trash
184
-
185
- When an adapter is configured, deleted documents go to an in-memory trash bin keyed by `_id`. The bin supports `restore`, `has`, `get`, `permanentDelete`, `empty`, `size`, `list({ start, count })`, `find(query)`, `findAll(query)`. Every trash operation also calls `adapter.sync('trash', doc)` so it can be persisted.
186
-
187
- Pass `{ trash: false }` in model options to disable.
188
-
189
- ---
190
-
191
- > **Next:** [Model layer →](./MODEL.md)
package/docs/ERRORS.md DELETED
@@ -1,90 +0,0 @@
1
- # Errors
2
-
3
- All errors thrown by Modeller are plain objects with a `code` field. They aren't `Error` instances — catch them as plain objects and branch on `code`.
4
-
5
- > [← Back to README](../README.md)
6
-
7
- ---
8
-
9
- ## Error codes
10
-
11
- | Code | Source | Extra fields |
12
- |---------------------|-------------------------------------------------|-------------------------|
13
- | `VALIDATION_ERROR` | AJV failed on `insert` / `update` / event args. | `errors` (AJV errors[]) |
14
- | `UNIQUE_VIOLATION` | A `unique` field collided. | `field` |
15
- | `METHOD_NOT_FOUND` | `call('id', ...)` with unregistered id. | `id` |
16
- | `UPLOAD_NOT_FOUND` | `callUpload('id', ...)` with unregistered id. | `id` |
17
- | `STREAM_NOT_FOUND` | `callStream('id', ...)` with unregistered id. | `id` |
18
- | `EVENT_NOT_FOUND` | `subscription.dispatch('id', ...)` mismatch. | `id` |
19
-
20
- ---
21
-
22
- ## Catching
23
-
24
- ```ts
25
- try {
26
- await users.insert({ email: 'bad' });
27
- } catch (err) {
28
- switch (err.code) {
29
- case 'VALIDATION_ERROR':
30
- console.log('AJV errors:', err.errors);
31
- break;
32
- case 'UNIQUE_VIOLATION':
33
- console.log('duplicate field:', err.field);
34
- break;
35
- default:
36
- throw err;
37
- }
38
- }
39
- ```
40
-
41
- ---
42
-
43
- ## Validation error shape
44
-
45
- `VALIDATION_ERROR` carries the raw AJV error array on `errors`. Each entry has `instancePath`, `keyword`, `message`, `params`, and `schemaPath`.
46
-
47
- ```ts
48
- {
49
- code: 'VALIDATION_ERROR',
50
- errors: [
51
- {
52
- instancePath : '/email',
53
- keyword : 'format',
54
- message : 'must match format "email"',
55
- params : { format: 'email' },
56
- schemaPath : '#/properties/email/format'
57
- }
58
- ]
59
- }
60
- ```
61
-
62
- `ajv-errors` is enabled, so per-field custom messages declared via `errorMessage` in the schema show up in `message`.
63
-
64
- ---
65
-
66
- ## Hooks and errors
67
-
68
- A non-scheduled hook that throws aborts the operation. The thrown value is logged at `error` level via the [logger](./MODEL.md#logging) and re-thrown to the caller. Throw a plain object with a `code` to keep error handling consistent:
69
-
70
- ```ts
71
- users.hook({
72
- id: 'check-quota',
73
- on: 'before:insert',
74
- callback: async ({ data }) => {
75
- if (await overQuota(data)) throw { code: 'QUOTA_EXCEEDED' };
76
- }
77
- });
78
- ```
79
-
80
- Scheduled hooks (those with `schedule: <ms>`) are fire-and-forget. Errors from them are logged but not propagated.
81
-
82
- ---
83
-
84
- ## Workers and errors
85
-
86
- Worker handler errors are caught and logged at `error` level. They never crash the interval — the worker keeps ticking. If you want a worker to stop on failure, call `model.stop('worker-id')` from inside the handler's catch block.
87
-
88
- ---
89
-
90
- > **Related:** [Core →](./CORE.md) · [Model →](./MODEL.md)