@axinom/mosaic-graphql-common 0.7.0 → 0.8.0-rc.1

package/dist/plugins/subscriptions-plugin-factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions-plugin-factory.d.ts","sourceRoot":"","sources":["../../src/plugins/subscriptions-plugin-factory.ts"],"names":[],"mappings":"AAUA,OAAO,EAAS,MAAM,EAAE,MAAM,cAAc,CAAC;AAyD7C;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,kBACtB,MAAM,YACX,MAAM,kBACD,KAAK,GAAG,MAAM,KAC5B,MAoCC,CAAC"}
+{"version":3,"file":"subscriptions-plugin-factory.d.ts","sourceRoot":"","sources":["../../src/plugins/subscriptions-plugin-factory.ts"],"names":[],"mappings":"AAcA,OAAO,EAAS,MAAM,EAAE,MAAM,cAAc,CAAC;AAuG7C;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,kBACtB,MAAM,YACX,MAAM,kBACD,KAAK,GAAG,MAAM,KAC5B,MAmDC,CAAC"}

package/dist/plugins/subscriptions-plugin-factory.js

@@ -1,4 +1,15 @@
 "use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -25,6 +36,36 @@ function recordByIdFromTable(build, sqlTable) {
 function getId() {
     return async (event) => event.subject;
 }
+/**
+ * Produces parts of the type definitions with the objective to not break
+ * existing GraphQL subscription implementations if only the libraries were
+ * updated, but database triggers were not.
+ */
+const getEventTypeDefComponents = (build, mainTableName, typeName) => {
+    // Tag that is put on a table involved in a subscription by an `ax_define.define_subscription_triggers` call.
+    const tag = `subscription_events_${mainTableName}`;
+    const introspection = build.pgIntrospectionResultsByKind;
+    const enumValues = introspection.class
+        .filter((cls) => cls.tags[tag])
+        .flatMap((cls) => cls.tags[tag].split(','))
+        .join('\n');
+    const typeNameSuffix = 'SubscriptionEventKey';
+    let enumType = `enum ${typeName}${typeNameSuffix} { ${enumValues} }`;
+    let deprecationReason = `@deprecated(reason: "Use 'eventKey' instead.")`;
+    let eventEnumProperty = `eventKey: ${typeName}${typeNameSuffix}`;
+    // TODO: Drop this and `event` property when it is time to drop backward
+    // compatibility support for subscription event property.
+    if (enumValues === '') {
+        enumType = '';
+        deprecationReason = `@deprecated(reason: "Update the subscription triggers to add a strongly-typed 'eventKey' property to be used instead.")`;
+        eventEnumProperty = '';
+        // eslint-disable-next-line no-console
+        console.warn(`Deprecation Warning: The "event" property on all subscription payloads is deprecated. 
+      Please re-initialize the subscription database triggers with the updated "ax_define" functions. 
+      The last parameter of "ax_define.define_subscription_triggers" shall now be screaming snake-case string (e.g. MOVIE_TAG instead of MovieTag).`, { context: exports.SubscriptionsPluginFactory.name });
+    }
+    return { enumType, deprecationReason, eventEnumProperty };
+};
 /**
  * Factory function to create a makeExtendSchemaPlugin that adds a subscription endpoint for specific entity.
  * @param mainTableName name of the table in the database without schema
@@ -36,12 +77,16 @@ const SubscriptionsPluginFactory = (mainTableName, typeName, gqlIdDataType = 'In
     const variableName = inflection_1.default.camelize(typeName, true);
     const payloadName = inflection_1.default.camelize(typeName, false) + 'SubscriptionPayload';
     const topicName = 'graphql:' + mainTableName;
+    const { enumType, deprecationReason, eventEnumProperty } = getEventTypeDefComponents(build, mainTableName, typeName);
     return {
         typeDefs: (0, graphile_utils_1.gql) `
+      ${enumType}
+
       type ${payloadName} {
         id: ${gqlIdDataType}! # Populated by our resolver below 
         ${variableName}: ${typeName} # Populated by our resolver below
-        event: String # Part of the NOTIFY payload
+        event: String ${deprecationReason} # Part of the NOTIFY payload
+        ${eventEnumProperty} # Part of the NOTIFY payload
       }
 
       extend type Subscription {
@@ -58,7 +103,12 @@ const SubscriptionsPluginFactory = (mainTableName, typeName, gqlIdDataType = 'In
                 [variableName]: recordByIdFromTable(build, sql.fragment([`app_public.${mainTableName}`])),
             },
             Subscription: {
-                [`${variableName}Mutated`]: (event) => event,
+                [`${variableName}Mutated`]: (data) => {
+                    const { event } = data, rest = __rest(data, ["event"]);
+                    return Object.assign(Object.assign({}, rest), { eventKey: event, event: /[a-z]/.test(event) // if event value has lowercase letters
+                            ? event
+                            : inflection_1.default.camelize(event.toLowerCase(), false) });
+                },
             },
         },
     };

package/dist/plugins/subscriptions-plugin-factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions-plugin-factory.js","sourceRoot":"","sources":["../../src/plugins/subscriptions-plugin-factory.ts"],"names":[],"mappings":";;;;;;AAEA,mDAIwB;AAGxB,4DAAoC;AAsBpC;;;;GAIG;AACH,SAAS,mBAAmB,CAC1B,KAAY,EACZ,QAAa;IAEb,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;IAC7B,OAAO,KAAK,EACV,KAAoC,EACpC,KAA8B,EAC9B,QAAa;IACb,sDAAsD;IACtD,EAAE,QAAQ,EAAE,EAAE,4BAA4B,EAAE,EAAE,EAC9C,EAAE;QACF,MAAM,IAAI,GAAG,MAAM,4BAA4B,CAC7C,QAAQ,EACR,CAAC,UAAe,EAAE,UAAwB,EAAE,EAAE;YAC5C,UAAU,CAAC,KAAK,CACd,GAAG,CAAC,QAAQ,CAAA,GAAG,UAAU,SAAS,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAC7D,CAAC;QACJ,CAAC,CACF,CAAC;QACF,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,KAAK;IAIZ,OAAO,KAAK,EAAE,KAAoC,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;AACvE,CAAC;AAED;;;;;GAKG;AACI,MAAM,0BAA0B,GAAG,CACxC,aAAqB,EACrB,QAAgB,EAChB,gBAAgC,KAAK,EAC7B,EAAE,CACV,IAAA,uCAAsB,EAAC,CAAC,KAAY,EAAE,EAAE;IACtC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;IAC7B,MAAM,YAAY,GAAG,oBAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACzD,MAAM,WAAW,GACf,oBAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,qBAAqB,CAAC;IAC/D,MAAM,SAAS,GAAG,UAAU,GAAG,aAAa,CAAC;IAC7C,OAAO;QACL,QAAQ,EAAE,IAAA,oBAAG,EAAA;aACN,WAAW;cACV,aAAa;UACjB,YAAY,KAAK,QAAQ;;;;;;2BAMR,QAAQ;;UAEzB,YAAY,YAAY,WAAW;oCACT,SAAS;;KAExC;QACC,SAAS,EAAE;YACT,CAAC,WAAW,CAAC,EAAE;gBACb,EAAE,EAAE,KAAK,EAAE;gBACX,CAAC,YAAY,CAAC,EAAE,mBAAmB,CACjC,KAAK,EACL,GAAG,CAAC,QAAQ,CAAC,CAAC,cAAc,aAAa,EAAE,CAAC,CAAC,CAC9C;aACF;YACD,YAAY,EAAE;gBACZ,CAAC,GAAG,YAAY,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK;aAC7C;SACF;KACqB,CAAC;AAC3B,CAAC,CAAC,CAAC;AAxCQ,QAAA,0BAA0B,8BAwClC"}
+{"version":3,"file":"subscriptions-plugin-factory.js","sourceRoot":"","sources":["../../src/plugins/subscriptions-plugin-factory.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAMA,mDAIwB;AAGxB,4DAAoC;AAsBpC;;;;GAIG;AACH,SAAS,mBAAmB,CAC1B,KAAY,EACZ,QAAa;IAEb,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;IAC7B,OAAO,KAAK,EACV,KAAoC,EACpC,KAA8B,EAC9B,QAAa;IACb,sDAAsD;IACtD,EAAE,QAAQ,EAAE,EAAE,4BAA4B,EAAE,EAAE,EAC9C,EAAE;QACF,MAAM,IAAI,GAAG,MAAM,4BAA4B,CAC7C,QAAQ,EACR,CAAC,UAAe,EAAE,UAAwB,EAAE,EAAE;YAC5C,UAAU,CAAC,KAAK,CACd,GAAG,CAAC,QAAQ,CAAA,GAAG,UAAU,SAAS,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAC7D,CAAC;QACJ,CAAC,CACF,CAAC;QACF,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,KAAK;IAIZ,OAAO,KAAK,EAAE,KAAoC,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;AACvE,CAAC;AAED;;;;GAIG;AACH,MAAM,yBAAyB,GAAG,CAChC,KAAY,EACZ,aAAqB,EACrB,QAAgB,EAKhB,EAAE;IACF,6GAA6G;IAC7G,MAAM,GAAG,GAAG,uBAAuB,aAAa,EAAE,CAAC;IACnD,MAAM,aAAa,GACjB,KAAK,CAAC,4BAA4B,CAAC;IACrC,MAAM,UAAU,GAAG,aAAa,CAAC,KAAK;SACnC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC9B,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SACtD,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,MAAM,cAAc,GAAG,sBAAsB,CAAC;IAC9C,IAAI,QAAQ,GAAG,QAAQ,QAAQ,GAAG,cAAc,MAAM,UAAU,IAAI,CAAC;IACrE,IAAI,iBAAiB,GAAG,gDAAgD,CAAC;IACzE,IAAI,iBAAiB,GAAG,aAAa,QAAQ,GAAG,cAAc,EAAE,CAAC;IAEjE,wEAAwE;IACxE,yDAAyD;IACzD,IAAI,UAAU,KAAK,EAAE,EAAE;QACrB,QAAQ,GAAG,EAAE,CAAC;QACd,iBAAiB,GAAG,yHAAyH,CAAC;QAC9I,iBAAiB,GAAG,EAAE,CAAC;QACvB,sCAAsC;QACtC,OAAO,CAAC,IAAI,CACV;;oJAE8I,EAC9I,EAAE,OAAO,EAAE,kCAA0B,CAAC,IAAI,EAAE,CAC7C,CAAC;KACH;IAED,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,CAAC;AAC5D,CAAC,CAAC;AAEF;;;;;GAKG;AACI,MAAM,0BAA0B,GAAG,CACxC,aAAqB,EACrB,QAAgB,EAChB,gBAAgC,KAAK,EAC7B,EAAE,CACV,IAAA,uCAAsB,EAAC,CAAC,KAAY,EAAE,EAAE;IACtC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;IAC7B,MAAM,YAAY,GAAG,oBAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACzD,MAAM,WAAW,GACf,oBAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,qBAAqB,CAAC;IAC/D,MAAM,SAAS,GAAG,UAAU,GAAG,aAAa,CAAC;IAE7C,MAAM,EAAE,QAAQ,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,GACtD,yBAAyB,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC;IAC5D,OAAO;QACL,QAAQ,EAAE,IAAA,oBAAG,EAAA;QACX,QAAQ;;aAEH,WAAW;cACV,aAAa;UACjB,YAAY,KAAK,QAAQ;wBACX,iBAAiB;UAC/B,iBAAiB;;;;;2BAKA,QAAQ;;UAEzB,YAAY,YAAY,WAAW;oCACT,SAAS;;KAExC;QACC,SAAS,EAAE;YACT,CAAC,WAAW,CAAC,EAAE;gBACb,EAAE,EAAE,KAAK,EAAE;gBACX,CAAC,YAAY,CAAC,EAAE,mBAAmB,CACjC,KAAK,EACL,GAAG,CAAC,QAAQ,CAAC,CAAC,cAAc,aAAa,EAAE,CAAC,CAAC,CAC9C;aACF;YACD,YAAY,EAAE;gBACZ,CAAC,GAAG,YAAY,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE;oBACnC,MAAM,EAAE,KAAK,KAAc,IAAI,EAAb,IAAI,UAAK,IAAI,EAAzB,SAAkB,CAAO,CAAC;oBAChC,uCACK,IAAI,KACP,QAAQ,EAAE,KAAK,EACf,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,uCAAuC;4BAChE,CAAC,CAAC,KAAK;4BACP,CAAC,CAAC,oBAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,KAAK,CAAC,IACnD;gBACJ,CAAC;aACF;SACF;KACqB,CAAC;AAC3B,CAAC,CAAC,CAAC;AAvDQ,QAAA,0BAA0B,8BAuDlC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axinom/mosaic-graphql-common",
-  "version": "0.7.0",
+  "version": "0.8.0-rc.1",
   "description": "Common GraphQL and PostGraphile related functionality.",
   "author": "Axinom",
   "license": "PROPRIETARY",
@@ -57,5 +57,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e583a1076964626d1d0b1f9fb507d1defc307102"
+  "gitHead": "e103b626f8fa440654a67d2ff9b47d1c6316167d"
 }

package/src/plugins/subscriptions-plugin-factory.ts

@@ -1,5 +1,9 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { QueryBuilder, SQL } from 'graphile-build-pg';
+import {
+  PgIntrospectionResultsByKind,
+  QueryBuilder,
+  SQL,
+} from 'graphile-build-pg';
 import {
   ExtensionDefinition,
   gql,
@@ -65,6 +69,52 @@ function getId(): AugmentedGraphQLFieldResolver<
   return async (event: ITgGraphQLSubscriptionPayload) => event.subject;
 }
 
+/**
+ * Produces parts of the type definitions with the objective to not break
+ * existing GraphQL subscription implementations if only the libraries were
+ * updated, but database triggers were not.
+ */
+const getEventTypeDefComponents = (
+  build: Build,
+  mainTableName: string,
+  typeName: string,
+): {
+  enumType: string;
+  deprecationReason: string;
+  eventEnumProperty: string;
+} => {
+  // Tag that is put on a table involved in a subscription by an `ax_define.define_subscription_triggers` call.
+  const tag = `subscription_events_${mainTableName}`;
+  const introspection: PgIntrospectionResultsByKind =
+    build.pgIntrospectionResultsByKind;
+  const enumValues = introspection.class
+    .filter((cls) => cls.tags[tag])
+    .flatMap((cls) => (cls.tags[tag] as string).split(','))
+    .join('\n');
+
+  const typeNameSuffix = 'SubscriptionEventKey';
+  let enumType = `enum ${typeName}${typeNameSuffix} { ${enumValues} }`;
+  let deprecationReason = `@deprecated(reason: "Use 'eventKey' instead.")`;
+  let eventEnumProperty = `eventKey: ${typeName}${typeNameSuffix}`;
+
+  // TODO: Drop this and `event` property when it is time to drop backward
+  // compatibility support for subscription event property.
+  if (enumValues === '') {
+    enumType = '';
+    deprecationReason = `@deprecated(reason: "Update the subscription triggers to add a strongly-typed 'eventKey' property to be used instead.")`;
+    eventEnumProperty = '';
+    // eslint-disable-next-line no-console
+    console.warn(
+      `Deprecation Warning: The "event" property on all subscription payloads is deprecated. 
+      Please re-initialize the subscription database triggers with the updated "ax_define" functions. 
+      The last parameter of "ax_define.define_subscription_triggers" shall now be screaming snake-case string (e.g. MOVIE_TAG instead of MovieTag).`,
+      { context: SubscriptionsPluginFactory.name },
+    );
+  }
+
+  return { enumType, deprecationReason, eventEnumProperty };
+};
+
 /**
  * Factory function to create a makeExtendSchemaPlugin that adds a subscription endpoint for specific entity.
  * @param mainTableName name of the table in the database without schema
@@ -82,12 +132,18 @@ export const SubscriptionsPluginFactory = (
     const payloadName =
       inflection.camelize(typeName, false) + 'SubscriptionPayload';
     const topicName = 'graphql:' + mainTableName;
+
+    const { enumType, deprecationReason, eventEnumProperty } =
+      getEventTypeDefComponents(build, mainTableName, typeName);
     return {
       typeDefs: gql`
+      ${enumType}
+
       type ${payloadName} {
         id: ${gqlIdDataType}! # Populated by our resolver below 
         ${variableName}: ${typeName} # Populated by our resolver below
-        event: String # Part of the NOTIFY payload
+        event: String ${deprecationReason} # Part of the NOTIFY payload
+        ${eventEnumProperty} # Part of the NOTIFY payload
       }
 
       extend type Subscription {
@@ -107,7 +163,16 @@ export const SubscriptionsPluginFactory = (
           ),
         },
         Subscription: {
-          [`${variableName}Mutated`]: (event) => event,
+          [`${variableName}Mutated`]: (data) => {
+            const { event, ...rest } = data;
+            return {
+              ...rest,
+              eventKey: event,
+              event: /[a-z]/.test(event) // if event value has lowercase letters
+                ? event
+                : inflection.camelize(event.toLowerCase(), false),
+            };
+          },
         },
       },
     } as ExtensionDefinition;