@constructive-io/data 0.3.0
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/LICENSE +21 -0
- package/README.md +34 -0
- package/dist/index.cjs +5837 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +2616 -0
- package/dist/index.d.ts +2616 -0
- package/dist/index.js +5714 -0
- package/dist/index.js.map +1 -0
- package/package.json +59 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Constructive
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# @constructive-io/data
|
|
2
|
+
|
|
3
|
+
Runtime query generation and metadata utilities for Constructive/PostGraphile data endpoints.
|
|
4
|
+
|
|
5
|
+
The package combines Constructive's versioned `_meta` contract with standard GraphQL introspection. `_meta` supplies PostgreSQL encodings, advisory CRUD inflections, relations, constraints, scope, storage, search, i18n, and realtime metadata; standard introspection supplies the exact executable roots, input objects, filters, ordering, pagination, enums, and custom operations.
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import {
|
|
9
|
+
META_CONTRACT_INTROSPECTION_DOCUMENT,
|
|
10
|
+
META_DOCUMENT,
|
|
11
|
+
SCHEMA_INTROSPECTION_QUERY,
|
|
12
|
+
assessSchemaIntrospectionCompatibility,
|
|
13
|
+
assertMetaContract,
|
|
14
|
+
selectConsoleDataTables,
|
|
15
|
+
} from '@constructive-io/data';
|
|
16
|
+
|
|
17
|
+
const signature = await execute(META_CONTRACT_INTROSPECTION_DOCUMENT);
|
|
18
|
+
assertMetaContract(signature);
|
|
19
|
+
|
|
20
|
+
const meta = await execute(META_DOCUMENT);
|
|
21
|
+
const schema = await executeSource(SCHEMA_INTROSPECTION_QUERY);
|
|
22
|
+
const compatibility = assessSchemaIntrospectionCompatibility(schema, meta);
|
|
23
|
+
if (compatibility.status === 'incompatible') {
|
|
24
|
+
throw new Error(`GraphQL schema drift: ${compatibility.missingPaths.join(', ')}`);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
const tables = selectConsoleDataTables(meta._meta?.tables ?? [], {
|
|
28
|
+
applicationScopes: ['app'],
|
|
29
|
+
});
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
`assessSchemaIntrospectionCompatibility` follows the root type names declared by `__schema`, then cross-checks `_meta` operation hints, the arguments required by the query builders, referenced object/input/enum types, table fields, and declared enum values. An incompatible result reports the exact missing GraphQL paths. `_meta` can include hidden tables or naive inflections, so callers must use standard introspection as the authority for any operation they execute.
|
|
33
|
+
|
|
34
|
+
`selectConsoleDataTables` classifies ownership only from the July `_meta` `table.scope.scope` smart tag, with `app` as the default exact scope. It excludes storage-owned tables and every table identified as a many-to-many junction, regardless of extra domain fields; physical schema names are used only for explicit exclusions and deduplication.
|