@itrocks/framework 1.0.1 → 1.0.3

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.
package/README.md CHANGED
@@ -319,6 +319,7 @@ The browser `property-select-metadata.js` entry provides
319
319
  Bootstrap binds list state transactions to the configured HTTP session store. Each list article receives its router
320
320
  identity; selector state and list column settings share durable session coordination while retaining separate
321
321
  namespaces.
322
- The browser obtains authorised root advice before mounting the selector and supplies the list session adapter.
322
+ The list HTML includes authorised selector metadata, advice, template and session state for mounting without
323
+ additional application requests.
323
324
  A stable configured `session.secret` is needed to recognise existing cookies after a server restart.
324
325
  See [property selector integration](docs/property-select.md) for route-backed metadata and access.
@@ -32,7 +32,7 @@ const store_1 = require("@itrocks/store");
32
32
  const string_formats_1 = require("@itrocks/string-formats");
33
33
  const transformers_3 = require("@itrocks/string-formats/transformers");
34
34
  const template_1 = require("@itrocks/template");
35
- const template_insight_1 = require("@itrocks/template-insight");
35
+ const template_2 = require("@itrocks/template");
36
36
  const transformer_1 = require("@itrocks/transformer");
37
37
  const transformer_2 = require("@itrocks/transformer");
38
38
  const transformer_3 = require("@itrocks/transformer");
@@ -86,7 +86,7 @@ function bind() {
86
86
  setTransformers: core_transformers_2.initStoreTransformers,
87
87
  toStoreName: rename_1.toColumn
88
88
  });
89
- (0, template_1.templateDependsOn)({
89
+ (0, template_2.templateDependsOn)({
90
90
  toString: async (data) => (((typeof data)[0] === 'o') && (data.toString === Object.prototype.toString))
91
91
  ? (await require('@itrocks/class-view').representativeValueOf(data))
92
92
  : '' + data
@@ -95,7 +95,7 @@ function bind() {
95
95
  action_1.Action.prototype.htmlTemplateResponse = async function (data, request, templateFile, statusCode = 200, headers = {}) {
96
96
  const containerData = Object.assign(defaultContainerData(request), this);
97
97
  const contained = !request.request.headers['xhr-info'] && config_1.config.container?.file;
98
- const template = new template_insight_1.Template(data, containerData);
98
+ const template = new template_1.Template(data, containerData);
99
99
  return this.htmlResponse(await template.parseFile(templateFile, contained && (0, node_path_1.join)(app_dir_1.appDir, config_1.config.container.file)), statusCode, headers);
100
100
  };
101
101
  }
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.PropertySelectTemplate = exports.MetadataResolve = exports.MetadataContext = exports.MetadataConfiguration = void 0;
4
4
  const action_1 = require("@itrocks/action");
5
- const promises_1 = require("node:fs/promises");
5
+ const template_1 = require("@itrocks/template");
6
6
  const property_select_1 = require("./property-select");
7
7
  const property_select_2 = require("./property-select");
8
8
  const property_select_provider_1 = require("./property-select-provider");
@@ -46,7 +46,7 @@ exports.MetadataResolve = MetadataResolve;
46
46
  class PropertySelectTemplate extends action_1.Action {
47
47
  async html() {
48
48
  const template = require.resolve('@itrocks/property-select/front/property-select.html');
49
- return this.htmlResponse(await (0, promises_1.readFile)(template, 'utf8'));
49
+ return this.htmlResponse(await new template_1.Template({}).parseFile(template));
50
50
  }
51
51
  }
52
52
  exports.PropertySelectTemplate = PropertySelectTemplate;
@@ -1,6 +1,8 @@
1
1
  import { Request } from '@itrocks/action-request';
2
2
  import { Type } from '@itrocks/class-type';
3
+ import { ObjectContext } from '@itrocks/property-select';
3
4
  import { RootId } from '@itrocks/property-select';
5
+ import { StateRecord } from '@itrocks/property-select';
4
6
  import { ReflectionMetadataProvider } from './property-select-provider';
5
7
  export type MetadataRoot = {
6
8
  advice?: readonly string[];
@@ -17,6 +19,21 @@ export type { MetadataErrorCode } from './property-select-provider';
17
19
  export { ReflectionMetadataProvider } from './property-select-provider';
18
20
  export declare function bindPropertySelect(): void;
19
21
  export declare function createMetadataProvider(request: Request, root?: RootId): ReflectionMetadataProvider;
22
+ /** Prepare only the contexts used by restoration, suggestions and the bounded saved search. */
23
+ export declare function metadataBootstrap(request: Request, root: RootId, usedPaths: string[], record: StateRecord): Promise<{
24
+ contexts: ObjectContext[];
25
+ errors: [string, string][];
26
+ record: {
27
+ state: import("@itrocks/property-select").SelectorState;
28
+ revision: number;
29
+ };
30
+ template: string;
31
+ translations: {
32
+ 'Add columns': string;
33
+ };
34
+ advice: readonly string[];
35
+ version: string;
36
+ }>;
20
37
  export declare function metadataConfiguration(request: Request, root: RootId): Promise<{
21
38
  advice: readonly string[];
22
39
  version: string;
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ReflectionMetadataProvider = exports.MetadataError = void 0;
4
4
  exports.bindPropertySelect = bindPropertySelect;
5
5
  exports.createMetadataProvider = createMetadataProvider;
6
+ exports.metadataBootstrap = metadataBootstrap;
6
7
  exports.metadataConfiguration = metadataConfiguration;
7
8
  exports.propertySelectDependsOn = propertySelectDependsOn;
8
9
  const action_1 = require("@itrocks/action");
@@ -12,7 +13,10 @@ const fastify_1 = require("@itrocks/fastify");
12
13
  const list_1 = require("@itrocks/list");
13
14
  const selector_state_1 = require("@itrocks/list/selector-state");
14
15
  const property_select_1 = require("@itrocks/property-select");
16
+ const property_select_2 = require("@itrocks/property-select");
15
17
  const route_1 = require("@itrocks/route");
18
+ const template_1 = require("@itrocks/template");
19
+ const translate_1 = require("@itrocks/translate");
16
20
  const property_select_provider_1 = require("./property-select-provider");
17
21
  const property_select_provider_2 = require("./property-select-provider");
18
22
  const dependencies = { advice: () => [], authorise: () => true };
@@ -35,7 +39,10 @@ function bindPropertySelect() {
35
39
  return { authorise: async () => { } };
36
40
  const provider = createMetadataProvider(request, root);
37
41
  await provider.context(root, '');
38
- return { authorise: async (path) => { await provider.resolve(root, path); }, root };
42
+ return {
43
+ authorise: async (path) => { await provider.resolve(root, path); },
44
+ bootstrap: (paths, state) => metadataBootstrap(request, root, paths, state), root
45
+ };
39
46
  } });
40
47
  // Loaded after composition; action classes never trigger the framework bootstrap.
41
48
  route_1.routes.add('/property-select/template', '@itrocks/framework/property-select-actions:PropertySelectTemplate');
@@ -48,13 +55,63 @@ function createMetadataProvider(request, root = request.route) {
48
55
  const roots = type ? { [root]: { type } } : {};
49
56
  return new property_select_provider_2.ReflectionMetadataProvider(roots, (root, path) => dependencies.authorise(request, root, path));
50
57
  }
58
+ /** Prepare only the contexts used by restoration, suggestions and the bounded saved search. */
59
+ async function metadataBootstrap(request, root, usedPaths, record) {
60
+ const provider = createMetadataProvider(request, root);
61
+ const configuration = await metadataConfiguration(request, root);
62
+ const contexts = new Map();
63
+ const errors = new Map();
64
+ const selector = new property_select_1.PropertySelect({
65
+ advice: configuration.advice, root, stateKey: root, stateMode: 'session', usedPaths,
66
+ metadata: {
67
+ context: async (root, path, signal) => {
68
+ try {
69
+ const context = await provider.context(root, path, signal);
70
+ contexts.set(path, context);
71
+ return context;
72
+ }
73
+ catch (error) {
74
+ errors.set(path, error instanceof Error ? error.message : 'Metadata unavailable');
75
+ throw error;
76
+ }
77
+ },
78
+ resolve: (root, path, signal) => provider.resolve(root, path, signal)
79
+ },
80
+ stateStore: {
81
+ read: async () => record,
82
+ remove: async () => { throw new Error('Read-only bootstrap'); },
83
+ write: async () => { throw new Error('Read-only bootstrap'); }
84
+ }
85
+ });
86
+ try {
87
+ await selector.mount();
88
+ if (selector.search.status === 'loading')
89
+ await new Promise(resolve => {
90
+ const unsubscribe = selector.subscribe(() => {
91
+ if (selector.search.status === 'loading')
92
+ return;
93
+ unsubscribe();
94
+ resolve();
95
+ });
96
+ });
97
+ return {
98
+ ...configuration, contexts: [...contexts.values()], errors: [...errors],
99
+ record: { ...record, state: selector.snapshot() },
100
+ template: await new template_1.Template({}).parseFile(require.resolve('@itrocks/property-select/front/property-select.html')),
101
+ translations: { 'Add columns': (0, translate_1.tr)('Add columns') }
102
+ };
103
+ }
104
+ finally {
105
+ selector.dispose();
106
+ }
107
+ }
51
108
  async function metadataConfiguration(request, root) {
52
109
  const provider = createMetadataProvider(request, root);
53
110
  await provider.context(root, '');
54
111
  const advice = [];
55
112
  for (const path of await dependencies.advice(request, root)) {
56
113
  try {
57
- const canonical = (0, property_select_1.normalisePath)(path);
114
+ const canonical = (0, property_select_2.normalisePath)(path);
58
115
  if (!canonical)
59
116
  continue;
60
117
  const description = await provider.resolve(root, canonical);
package/config.yaml CHANGED
@@ -1,6 +1,7 @@
1
1
  compose:
2
2
  '@itrocks/reflect:ReflectClass': '@itrocks/framework:ReflectClass'
3
3
  '@itrocks/reflect:ReflectProperty': '@itrocks/framework:ReflectProperty'
4
+ '@itrocks/template:Template': '@itrocks/template-insight:Template'
4
5
 
5
6
  server:
6
7
  host: 127.0.0.1
@@ -89,7 +89,8 @@ const context = await metadata.context('/invoice', '')
89
89
  const configuration = await metadata.configuration('/invoice')
90
90
  ```
91
91
 
92
- Options accept `endpoint` (default `/property-select`) and a substitutable `fetch` function.
92
+ Options accept `endpoint` (default `/property-select`), a substitutable `fetch` function and an optional
93
+ `initial: { root, contexts, errors }` snapshot. The snapshot supplies authorised metadata for the current list response.
93
94
  Requests use same-origin credentials and forward `AbortSignal`. A cancelled response is also checked after JSON
94
95
  parsing. The selector's generation checks discard obsolete responses even when the network cannot be interrupted.
95
96
  Session restoration, rendered controls, searching and host column integration belong to their respective adapters.
@@ -121,5 +122,9 @@ The `/property-select/template/html` action serves only the selector's exported
121
122
  arbitrary HTML asset access. The view's optional template URL allows this transport while standalone hosts retain the
122
123
  adjacent static template. Neither the view nor list imports server framework code.
123
124
 
124
- Selector state remains mounted-instance state at this stage; list columns retain their existing request-session
125
- persistence. The selector session transaction and external pointer transport have separate contracts and deliveries.
125
+ The list access adapter supplies a request-scoped bootstrap. `metadataBootstrap(request, root, usedPaths, record)`
126
+ prepares the contexts needed by the restored branch, suggestions and bounded saved search, together with the selector
127
+ template and validated state. No business records are read. List adds the authoritative session revision and generation
128
+ to its encoded `data-selector-bootstrap` attribute. The browser consumes this response without configuration,
129
+ metadata, template or state requests on mount. New navigation and searches can fetch additional contexts lazily.
130
+ Column removal and reordering reuse existing contexts and cells; only configuration persistence requires a request.
package/fr-FR.csv CHANGED
@@ -10,6 +10,7 @@ $1 saved;$1 enregistré
10
10
  an email for password reset was sent to you;un mail de réinitialisation de mot de passe vous a été envoyé
11
11
  active;actif
12
12
  add;ajouter
13
+ add columns;ajouter des colonnes
13
14
  add $1;ajouter $1
14
15
  age;age
15
16
  all data will be lost;toutes les données seront perdues
@@ -17,6 +18,7 @@ authenticate user;authentifier l'utilisateur
17
18
  back;retour
18
19
  birthday;date de naissance
19
20
  cancel;annuler
21
+ clear search;effacer la recherche
20
22
  close;fermer
21
23
  confirm;confirmer
22
24
  continue;continuer
package/package.json CHANGED
@@ -121,5 +121,5 @@
121
121
  "build:test": "tsc -p test/tsconfig.json",
122
122
  "test": "npm run build && npm run build:test && node --test test/*.test.js test/*.test.mjs"
123
123
  },
124
- "version": "1.0.1"
124
+ "version": "1.0.3"
125
125
  }
@@ -11,10 +11,14 @@ async function activate(entry) {
11
11
  return;
12
12
  loadCss('/@itrocks/property-select/front/property-select.css');
13
13
  loadCss('/@itrocks/table/column-add.css');
14
- const metadata = new HttpMetadataProvider();
14
+ const initial = entry.article.dataset.selectorBootstrap
15
+ ? JSON.parse(decodeURIComponent(entry.article.dataset.selectorBootstrap)) : undefined;
16
+ const metadata = new HttpMetadataProvider({
17
+ initial: initial && { ...initial, root: entry.article.dataset.propertyRoot }
18
+ });
15
19
  let integration;
16
20
  try {
17
- const configuration = await metadata.configuration(entry.article.dataset.propertyRoot);
21
+ const configuration = initial ?? await metadata.configuration(entry.article.dataset.propertyRoot);
18
22
  if (!entry.article.isConnected || mounted.has(entry.article))
19
23
  return;
20
24
  integration = new ListPropertySelect(entry.article, {
@@ -4,10 +4,16 @@ import type { PropertyDescription } from '@itrocks/property-select/property-sele
4
4
  export type MetadataTransportOptions = {
5
5
  endpoint?: string;
6
6
  fetch?: typeof fetch;
7
+ initial?: {
8
+ contexts: ObjectContext[];
9
+ errors: [string, string][];
10
+ root: string;
11
+ };
7
12
  };
8
13
  export declare class HttpMetadataProvider implements MetadataProvider {
9
14
  private readonly endpoint;
10
15
  private readonly fetcher;
16
+ private readonly initial?;
11
17
  constructor(options?: MetadataTransportOptions);
12
18
  configuration(root: string, signal?: AbortSignal): Promise<{
13
19
  advice: readonly string[];
@@ -1,7 +1,9 @@
1
1
  export class HttpMetadataProvider {
2
2
  endpoint;
3
3
  fetcher;
4
+ initial;
4
5
  constructor(options = {}) {
6
+ this.initial = options.initial;
5
7
  this.endpoint = options.endpoint ?? '/property-select';
6
8
  this.fetcher = options.fetch ?? globalThis.fetch.bind(globalThis);
7
9
  }
@@ -9,6 +11,15 @@ export class HttpMetadataProvider {
9
11
  return this.request('configuration', root, '', signal);
10
12
  }
11
13
  context(root, path, signal) {
14
+ signal?.throwIfAborted();
15
+ if (this.initial?.root === root) {
16
+ const context = this.initial.contexts.find(context => context.path === path);
17
+ if (context)
18
+ return Promise.resolve(structuredClone(context));
19
+ const error = this.initial.errors.find(([failed]) => failed === path);
20
+ if (error)
21
+ return Promise.reject(new Error(error[1]));
22
+ }
12
23
  return this.request('context', root, path, signal);
13
24
  }
14
25
  async request(operation, root, path, signal) {