graphile-schema 1.10.4 → 1.11.0

package/build-introspection.d.ts

@@ -0,0 +1,27 @@
+import type { TableMeta } from 'graphile-settings';
+import type { BuildSchemaOptions } from './build-schema';
+export type { BuildSchemaOptions as BuildIntrospectionOptions };
+/**
+ * Build introspection metadata for all tables visible in the given schemas.
+ *
+ * Internally calls `buildSchemaSDL()` which triggers the MetaSchemaPlugin
+ * gather hook, populating `_cachedTablesMeta` as a side-effect. The cached
+ * metadata is then returned as a plain array of `TableMeta` objects.
+ *
+ * The result includes every table's fields, types, constraints, indexes,
+ * relations, inflection names, and query entry-points — the same data
+ * exposed by the `_meta` GraphQL query at runtime.
+ *
+ * @example
+ * ```ts
+ * import { buildIntrospectionJSON } from 'graphile-schema';
+ * import fs from 'fs';
+ *
+ * const tables = await buildIntrospectionJSON({
+ *   database: 'my_db',
+ *   schemas: ['public', 'app_public'],
+ * });
+ * fs.writeFileSync('introspection.json', JSON.stringify(tables, null, 2));
+ * ```
+ */
+export declare function buildIntrospectionJSON(opts: BuildSchemaOptions): Promise<TableMeta[]>;

package/build-introspection.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildIntrospectionJSON = buildIntrospectionJSON;
+const graphile_settings_1 = require("graphile-settings");
+const build_schema_1 = require("./build-schema");
+/**
+ * Build introspection metadata for all tables visible in the given schemas.
+ *
+ * Internally calls `buildSchemaSDL()` which triggers the MetaSchemaPlugin
+ * gather hook, populating `_cachedTablesMeta` as a side-effect. The cached
+ * metadata is then returned as a plain array of `TableMeta` objects.
+ *
+ * The result includes every table's fields, types, constraints, indexes,
+ * relations, inflection names, and query entry-points — the same data
+ * exposed by the `_meta` GraphQL query at runtime.
+ *
+ * @example
+ * ```ts
+ * import { buildIntrospectionJSON } from 'graphile-schema';
+ * import fs from 'fs';
+ *
+ * const tables = await buildIntrospectionJSON({
+ *   database: 'my_db',
+ *   schemas: ['public', 'app_public'],
+ * });
+ * fs.writeFileSync('introspection.json', JSON.stringify(tables, null, 2));
+ * ```
+ */
+async function buildIntrospectionJSON(opts) {
+    await (0, build_schema_1.buildSchemaSDL)(opts);
+    return [...graphile_settings_1._cachedTablesMeta];
+}

package/esm/build-introspection.d.ts

@@ -0,0 +1,27 @@
+import type { TableMeta } from 'graphile-settings';
+import type { BuildSchemaOptions } from './build-schema';
+export type { BuildSchemaOptions as BuildIntrospectionOptions };
+/**
+ * Build introspection metadata for all tables visible in the given schemas.
+ *
+ * Internally calls `buildSchemaSDL()` which triggers the MetaSchemaPlugin
+ * gather hook, populating `_cachedTablesMeta` as a side-effect. The cached
+ * metadata is then returned as a plain array of `TableMeta` objects.
+ *
+ * The result includes every table's fields, types, constraints, indexes,
+ * relations, inflection names, and query entry-points — the same data
+ * exposed by the `_meta` GraphQL query at runtime.
+ *
+ * @example
+ * ```ts
+ * import { buildIntrospectionJSON } from 'graphile-schema';
+ * import fs from 'fs';
+ *
+ * const tables = await buildIntrospectionJSON({
+ *   database: 'my_db',
+ *   schemas: ['public', 'app_public'],
+ * });
+ * fs.writeFileSync('introspection.json', JSON.stringify(tables, null, 2));
+ * ```
+ */
+export declare function buildIntrospectionJSON(opts: BuildSchemaOptions): Promise<TableMeta[]>;

package/esm/build-introspection.js

@@ -0,0 +1,29 @@
+import { _cachedTablesMeta } from 'graphile-settings';
+import { buildSchemaSDL } from './build-schema';
+/**
+ * Build introspection metadata for all tables visible in the given schemas.
+ *
+ * Internally calls `buildSchemaSDL()` which triggers the MetaSchemaPlugin
+ * gather hook, populating `_cachedTablesMeta` as a side-effect. The cached
+ * metadata is then returned as a plain array of `TableMeta` objects.
+ *
+ * The result includes every table's fields, types, constraints, indexes,
+ * relations, inflection names, and query entry-points — the same data
+ * exposed by the `_meta` GraphQL query at runtime.
+ *
+ * @example
+ * ```ts
+ * import { buildIntrospectionJSON } from 'graphile-schema';
+ * import fs from 'fs';
+ *
+ * const tables = await buildIntrospectionJSON({
+ *   database: 'my_db',
+ *   schemas: ['public', 'app_public'],
+ * });
+ * fs.writeFileSync('introspection.json', JSON.stringify(tables, null, 2));
+ * ```
+ */
+export async function buildIntrospectionJSON(opts) {
+    await buildSchemaSDL(opts);
+    return [..._cachedTablesMeta];
+}

package/esm/index.d.ts

@@ -1,5 +1,7 @@
 export { buildSchemaSDL } from './build-schema';
 export type { BuildSchemaOptions } from './build-schema';
+export { buildIntrospectionJSON } from './build-introspection';
 export { _cachedTablesMeta } from 'graphile-settings';
+export type { TableMeta, FieldMeta, TypeMeta, IndexMeta, ConstraintsMeta, PrimaryKeyConstraintMeta, UniqueConstraintMeta, ForeignKeyConstraintMeta, RelationsMeta, BelongsToRelation, HasRelation, ManyToManyRelation, InflectionMeta, QueryMeta, } from 'graphile-settings';
 export { fetchEndpointSchemaSDL } from './fetch-endpoint-schema';
 export type { FetchEndpointSchemaOptions } from './fetch-endpoint-schema';

package/esm/index.js

@@ -1,3 +1,4 @@
 export { buildSchemaSDL } from './build-schema';
+export { buildIntrospectionJSON } from './build-introspection';
 export { _cachedTablesMeta } from 'graphile-settings';
 export { fetchEndpointSchemaSDL } from './fetch-endpoint-schema';

package/index.d.ts

@@ -1,5 +1,7 @@
 export { buildSchemaSDL } from './build-schema';
 export type { BuildSchemaOptions } from './build-schema';
+export { buildIntrospectionJSON } from './build-introspection';
 export { _cachedTablesMeta } from 'graphile-settings';
+export type { TableMeta, FieldMeta, TypeMeta, IndexMeta, ConstraintsMeta, PrimaryKeyConstraintMeta, UniqueConstraintMeta, ForeignKeyConstraintMeta, RelationsMeta, BelongsToRelation, HasRelation, ManyToManyRelation, InflectionMeta, QueryMeta, } from 'graphile-settings';
 export { fetchEndpointSchemaSDL } from './fetch-endpoint-schema';
 export type { FetchEndpointSchemaOptions } from './fetch-endpoint-schema';

package/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchEndpointSchemaSDL = exports._cachedTablesMeta = exports.buildSchemaSDL = void 0;
+exports.fetchEndpointSchemaSDL = exports._cachedTablesMeta = exports.buildIntrospectionJSON = exports.buildSchemaSDL = void 0;
 var build_schema_1 = require("./build-schema");
 Object.defineProperty(exports, "buildSchemaSDL", { enumerable: true, get: function () { return build_schema_1.buildSchemaSDL; } });
+var build_introspection_1 = require("./build-introspection");
+Object.defineProperty(exports, "buildIntrospectionJSON", { enumerable: true, get: function () { return build_introspection_1.buildIntrospectionJSON; } });
 var graphile_settings_1 = require("graphile-settings");
 Object.defineProperty(exports, "_cachedTablesMeta", { enumerable: true, get: function () { return graphile_settings_1._cachedTablesMeta; } });
 var fetch_endpoint_schema_1 = require("./fetch-endpoint-schema");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-schema",
-  "version": "1.10.4",
+  "version": "1.11.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "Build GraphQL SDL from PostgreSQL databases using PostGraphile v5",
   "main": "index.js",
@@ -32,7 +32,7 @@
     "deepmerge": "^4.3.1",
     "graphile-build": "5.0.0-rc.6",
     "graphile-config": "1.0.0-rc.6",
-    "graphile-settings": "^4.16.2",
+    "graphile-settings": "^4.17.0",
     "graphql": "16.13.0",
     "pg-cache": "^3.4.1",
     "pg-env": "^1.8.1"
@@ -50,5 +50,5 @@
     "introspection",
     "constructive"
   ],
-  "gitHead": "deeabeceebf3300fd6424e157c9d952b0f436f43"
+  "gitHead": "1685145fa37391db10d757911b8a6fd00b8c87e7"
 }