graphile-settings 4.17.0 → 4.18.0

package/esm/plugins/meta-schema/graphql-meta-field.js

@@ -25,6 +25,9 @@ function createMetaSchemaType() {
             type: { type: nn(MetaTypeType) },
             isNotNull: { type: nn(GraphQLBoolean) },
             hasDefault: { type: nn(GraphQLBoolean) },
+            isPrimaryKey: { type: nn(GraphQLBoolean) },
+            isForeignKey: { type: nn(GraphQLBoolean) },
+            description: { type: GraphQLString },
         }),
     });
     const MetaIndexType = new GraphQLObjectType({

package/esm/plugins/meta-schema/table-meta-builder.js

@@ -9,7 +9,25 @@ function buildTableMeta(resource, schemaName, context) {
     const attributes = codec.attributes;
     const uniques = getUniques(resource);
     const relations = getRelations(resource);
-    const fields = Object.entries(attributes).map(([attrName, attr]) => buildFieldMeta(context.inflectAttr(attrName, codec), attr, context.build));
+    // Compute PK and FK attribute name sets for field metadata
+    const pkAttrNames = new Set();
+    const fkAttrNames = new Set();
+    for (const unique of uniques) {
+        if (unique.isPrimary) {
+            for (const attrName of unique.attributes)
+                pkAttrNames.add(attrName);
+        }
+    }
+    for (const relation of Object.values(relations)) {
+        if (relation.isReferencee !== false)
+            continue;
+        for (const attrName of relation.localAttributes || [])
+            fkAttrNames.add(attrName);
+    }
+    const fields = Object.entries(attributes).map(([attrName, attr]) => buildFieldMeta(context.inflectAttr(attrName, codec), attr, context.build, {
+        isPrimaryKey: pkAttrNames.has(attrName),
+        isForeignKey: fkAttrNames.has(attrName),
+    }));
     const indexes = buildIndexes(codec, attributes, uniques, context);
     const primaryKey = buildPrimaryKey(codec, attributes, uniques, context);
     const uniqueConstraints = buildUniqueConstraints(codec, attributes, uniques, context);

package/esm/plugins/meta-schema/type-mappings.d.ts

@@ -1,3 +1,7 @@
 import type { FieldMeta, GqlTypeResolverBuild, PgAttribute } from './types';
 export declare function pgTypeToGqlType(pgTypeName: string): string;
-export declare function buildFieldMeta(name: string, attr: PgAttribute | null | undefined, build?: GqlTypeResolverBuild): FieldMeta;
+export interface BuildFieldMetaOptions {
+    isPrimaryKey?: boolean;
+    isForeignKey?: boolean;
+}
+export declare function buildFieldMeta(name: string, attr: PgAttribute | null | undefined, build?: GqlTypeResolverBuild, options?: BuildFieldMetaOptions): FieldMeta;

package/esm/plugins/meta-schema/type-mappings.js

@@ -56,7 +56,7 @@ function resolveGqlTypeName(build, codec) {
     const nestedTypeName = codec.arrayOfCodec?.name;
     return nestedTypeName ? pgTypeToGqlType(nestedTypeName) : pgTypeName;
 }
-export function buildFieldMeta(name, attr, build) {
+export function buildFieldMeta(name, attr, build, options) {
     const pgType = attr?.codec?.name || 'unknown';
     const isNotNull = attr?.notNull || false;
     const hasDefault = attr?.hasDefault || false;
@@ -71,5 +71,8 @@ export function buildFieldMeta(name, attr, build) {
         },
         isNotNull,
         hasDefault,
+        isPrimaryKey: options?.isPrimaryKey ?? false,
+        isForeignKey: options?.isForeignKey ?? false,
+        description: attr?.description ?? null,
     };
 }

package/esm/plugins/meta-schema/types.d.ts

@@ -16,6 +16,9 @@ export interface FieldMeta {
     type: TypeMeta;
     isNotNull: boolean;
     hasDefault: boolean;
+    isPrimaryKey: boolean;
+    isForeignKey: boolean;
+    description: string | null;
 }
 export interface TypeMeta {
     pgType: string;
@@ -131,6 +134,7 @@ export interface PgAttribute {
     codec?: PgCodec | null;
     notNull?: boolean;
     hasDefault?: boolean;
+    description?: string | null;
 }
 export interface PgUnique {
     attributes: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-settings",
-  "version": "4.17.0",
+  "version": "4.18.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "graphile settings",
   "main": "index.js",
@@ -29,48 +29,48 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@constructive-io/graphql-env": "^3.5.1",
-    "@constructive-io/graphql-types": "^3.4.1",
-    "@constructive-io/s3-streamer": "^2.17.1",
-    "@constructive-io/upload-names": "^2.10.1",
-    "@dataplan/json": "1.0.0-rc.6",
-    "@dataplan/pg": "1.0.0-rc.8",
+    "@constructive-io/graphql-env": "^3.5.2",
+    "@constructive-io/graphql-types": "^3.4.2",
+    "@constructive-io/s3-streamer": "^2.17.2",
+    "@constructive-io/upload-names": "^2.10.2",
+    "@dataplan/json": "1.0.0",
+    "@dataplan/pg": "1.0.0",
     "@graphile-contrib/pg-many-to-many": "2.0.0-rc.2",
-    "@pgpmjs/logger": "^2.5.1",
-    "@pgpmjs/types": "^2.20.1",
+    "@pgpmjs/logger": "^2.5.2",
+    "@pgpmjs/types": "^2.20.2",
     "@pgsql/quotes": "^17.1.0",
     "cors": "^2.8.6",
     "express": "^5.2.1",
-    "grafast": "1.0.0-rc.9",
-    "grafserv": "1.0.0-rc.7",
-    "graphile-build": "5.0.0-rc.6",
-    "graphile-build-pg": "5.0.0-rc.8",
-    "graphile-config": "1.0.0-rc.6",
-    "graphile-connection-filter": "^1.3.1",
-    "graphile-postgis": "^2.9.1",
-    "graphile-search": "^1.5.1",
-    "graphile-sql-expression-validator": "^2.6.1",
-    "graphile-upload-plugin": "^2.5.1",
-    "graphile-utils": "5.0.0-rc.8",
+    "grafast": "1.0.0",
+    "grafserv": "1.0.0",
+    "graphile-build": "5.0.0",
+    "graphile-build-pg": "5.0.0",
+    "graphile-config": "1.0.0",
+    "graphile-connection-filter": "^1.3.3",
+    "graphile-postgis": "^2.9.3",
+    "graphile-search": "^1.5.3",
+    "graphile-sql-expression-validator": "^2.6.2",
+    "graphile-upload-plugin": "^2.5.2",
+    "graphile-utils": "5.0.0",
     "graphql": "16.13.0",
-    "inflekt": "^0.5.1",
+    "inflekt": "^0.6.0",
     "lru-cache": "^11.2.7",
     "pg": "^8.20.0",
-    "pg-query-context": "^2.9.1",
-    "pg-sql2": "5.0.0-rc.5",
-    "postgraphile": "5.0.0-rc.10",
+    "pg-query-context": "^2.9.2",
+    "pg-sql2": "5.0.0",
+    "postgraphile": "5.0.0",
     "request-ip": "^3.3.0",
-    "tamedevil": "0.1.0-rc.6"
+    "tamedevil": "0.1.0"
   },
   "devDependencies": {
     "@types/cors": "^2.8.17",
     "@types/express": "^5.0.6",
     "@types/pg": "^8.18.0",
     "@types/request-ip": "^0.0.41",
-    "graphile-test": "^4.7.1",
-    "makage": "^0.1.10",
+    "graphile-test": "^4.7.3",
+    "makage": "^0.3.0",
     "nodemon": "^3.1.14",
-    "pgsql-test": "^4.7.1",
+    "pgsql-test": "^4.7.3",
     "ts-node": "^10.9.2"
   },
   "keywords": [
@@ -80,5 +80,5 @@
     "constructive",
     "graphql"
   ],
-  "gitHead": "1685145fa37391db10d757911b8a6fd00b8c87e7"
+  "gitHead": "baae875effd00af36577612c861d0f6f9a1a792a"
 }

package/plugins/meta-schema/graphql-meta-field.js

@@ -28,6 +28,9 @@ function createMetaSchemaType() {
             type: { type: nn(MetaTypeType) },
             isNotNull: { type: nn(graphql_1.GraphQLBoolean) },
             hasDefault: { type: nn(graphql_1.GraphQLBoolean) },
+            isPrimaryKey: { type: nn(graphql_1.GraphQLBoolean) },
+            isForeignKey: { type: nn(graphql_1.GraphQLBoolean) },
+            description: { type: graphql_1.GraphQLString },
         }),
     });
     const MetaIndexType = new graphql_1.GraphQLObjectType({

package/plugins/meta-schema/table-meta-builder.js

@@ -12,7 +12,25 @@ function buildTableMeta(resource, schemaName, context) {
     const attributes = codec.attributes;
     const uniques = (0, table_resource_utils_1.getUniques)(resource);
     const relations = (0, table_resource_utils_1.getRelations)(resource);
-    const fields = Object.entries(attributes).map(([attrName, attr]) => (0, type_mappings_1.buildFieldMeta)(context.inflectAttr(attrName, codec), attr, context.build));
+    // Compute PK and FK attribute name sets for field metadata
+    const pkAttrNames = new Set();
+    const fkAttrNames = new Set();
+    for (const unique of uniques) {
+        if (unique.isPrimary) {
+            for (const attrName of unique.attributes)
+                pkAttrNames.add(attrName);
+        }
+    }
+    for (const relation of Object.values(relations)) {
+        if (relation.isReferencee !== false)
+            continue;
+        for (const attrName of relation.localAttributes || [])
+            fkAttrNames.add(attrName);
+    }
+    const fields = Object.entries(attributes).map(([attrName, attr]) => (0, type_mappings_1.buildFieldMeta)(context.inflectAttr(attrName, codec), attr, context.build, {
+        isPrimaryKey: pkAttrNames.has(attrName),
+        isForeignKey: fkAttrNames.has(attrName),
+    }));
     const indexes = (0, constraint_meta_builders_1.buildIndexes)(codec, attributes, uniques, context);
     const primaryKey = (0, constraint_meta_builders_1.buildPrimaryKey)(codec, attributes, uniques, context);
     const uniqueConstraints = (0, constraint_meta_builders_1.buildUniqueConstraints)(codec, attributes, uniques, context);

package/plugins/meta-schema/type-mappings.d.ts

@@ -1,3 +1,7 @@
 import type { FieldMeta, GqlTypeResolverBuild, PgAttribute } from './types';
 export declare function pgTypeToGqlType(pgTypeName: string): string;
-export declare function buildFieldMeta(name: string, attr: PgAttribute | null | undefined, build?: GqlTypeResolverBuild): FieldMeta;
+export interface BuildFieldMetaOptions {
+    isPrimaryKey?: boolean;
+    isForeignKey?: boolean;
+}
+export declare function buildFieldMeta(name: string, attr: PgAttribute | null | undefined, build?: GqlTypeResolverBuild, options?: BuildFieldMetaOptions): FieldMeta;

package/plugins/meta-schema/type-mappings.js

@@ -60,7 +60,7 @@ function resolveGqlTypeName(build, codec) {
     const nestedTypeName = codec.arrayOfCodec?.name;
     return nestedTypeName ? pgTypeToGqlType(nestedTypeName) : pgTypeName;
 }
-function buildFieldMeta(name, attr, build) {
+function buildFieldMeta(name, attr, build, options) {
     const pgType = attr?.codec?.name || 'unknown';
     const isNotNull = attr?.notNull || false;
     const hasDefault = attr?.hasDefault || false;
@@ -75,5 +75,8 @@ function buildFieldMeta(name, attr, build) {
         },
         isNotNull,
         hasDefault,
+        isPrimaryKey: options?.isPrimaryKey ?? false,
+        isForeignKey: options?.isForeignKey ?? false,
+        description: attr?.description ?? null,
     };
 }

package/plugins/meta-schema/types.d.ts

@@ -16,6 +16,9 @@ export interface FieldMeta {
     type: TypeMeta;
     isNotNull: boolean;
     hasDefault: boolean;
+    isPrimaryKey: boolean;
+    isForeignKey: boolean;
+    description: string | null;
 }
 export interface TypeMeta {
     pgType: string;
@@ -131,6 +134,7 @@ export interface PgAttribute {
     codec?: PgCodec | null;
     notNull?: boolean;
     hasDefault?: boolean;
+    description?: string | null;
 }
 export interface PgUnique {
     attributes: string[];