graphile 5.0.0-rc.2 → 5.0.0-rc.3

package/CHANGELOG.md

@@ -1,5 +1,64 @@
 # graphile
 
+## 5.0.0-rc.3
+
+### Patch Changes
+
+- [#2852](https://github.com/graphile/crystal/pull/2852)
+  [`65c9eb4`](https://github.com/graphile/crystal/commit/65c9eb4630013bcdb8364f8fb0dcbdec31f602f3)
+  Thanks [@benjie](https://github.com/benjie)! - Add
+  `graphile config options [scope]` command to limit options to a specific
+  scope.
+
+- [#2873](https://github.com/graphile/crystal/pull/2873)
+  [`0772086`](https://github.com/graphile/crystal/commit/0772086411a55d56b4e345cff1eef133eee31b36)
+  Thanks [@benjie](https://github.com/benjie)! - Update TypeScript configuration
+  to support Node 22 minimum
+
+- [#2862](https://github.com/graphile/crystal/pull/2862)
+  [`8503db6`](https://github.com/graphile/crystal/commit/8503db64831037c72249a3cc525b20ff91304a89)
+  Thanks [@benjie](https://github.com/benjie)! - Change `graphile` CLI to be
+  FLOSS under MIT license (previously sponsors only... but sponsorship still
+  encouraged!)
+
+- [#2888](https://github.com/graphile/crystal/pull/2888)
+  [`1a56db2`](https://github.com/graphile/crystal/commit/1a56db2f53bc455a3d3ba6555a2cd777b27b271c)
+  Thanks [@benjaie](https://github.com/benjaie)! - Node v22+ is required for
+  this module.
+
+- [#2855](https://github.com/graphile/crystal/pull/2855)
+  [`1682bed`](https://github.com/graphile/crystal/commit/1682bedd8d47e266ba9751bfaf77f09960b85c60)
+  Thanks [@benjie](https://github.com/benjie)! - Ability to detect TSDoc tags
+  and output appropriately
+
+- [#2859](https://github.com/graphile/crystal/pull/2859)
+  [`53e0af2`](https://github.com/graphile/crystal/commit/53e0af2bda2aad9abe430e00b52a37ea5f3e81c3)
+  Thanks [@benjie](https://github.com/benjie)! - Inflection debugging now
+  outputs much more detail about inflectors, including which plugins
+  added/overrode the inflector.
+
+- [#2859](https://github.com/graphile/crystal/pull/2859)
+  [`65d9556`](https://github.com/graphile/crystal/commit/65d9556cf18c54a7cd9c291aa10aa9806adb3c7a)
+  Thanks [@benjie](https://github.com/benjie)! - Add tracing to inflectors
+
+- Updated dependencies
+  [[`c2ae685`](https://github.com/graphile/crystal/commit/c2ae685a5ce001f79356c4a994613b16cdb01475),
+  [`1e45a3d`](https://github.com/graphile/crystal/commit/1e45a3d6495cfea45bfdde95af889a453b82def3),
+  [`0772086`](https://github.com/graphile/crystal/commit/0772086411a55d56b4e345cff1eef133eee31b36),
+  [`a60ed2a`](https://github.com/graphile/crystal/commit/a60ed2acc7abbdfce727eaef48f6ca0349c24635),
+  [`1606298`](https://github.com/graphile/crystal/commit/1606298cdac2938e02675d0e7e5e134364ac7bcf),
+  [`a565503`](https://github.com/graphile/crystal/commit/a5655035dfee7000c1d37e4791354d7a2ba35792),
+  [`d9ccc82`](https://github.com/graphile/crystal/commit/d9ccc82a30ca6167f480e5c8bc15d17df51c0d1c),
+  [`1a56db2`](https://github.com/graphile/crystal/commit/1a56db2f53bc455a3d3ba6555a2cd777b27b271c),
+  [`2e770df`](https://github.com/graphile/crystal/commit/2e770df354db58d39aead55c3aeca8ee2fb41833),
+  [`456d387`](https://github.com/graphile/crystal/commit/456d387887bb6fb9a880d2c3cd8cc6ece8391cf0),
+  [`4ca27c1`](https://github.com/graphile/crystal/commit/4ca27c1f543359d5a7dc53fae35fc35caddb4076),
+  [`a258427`](https://github.com/graphile/crystal/commit/a2584278e78535dc3c611c5257c332e515c280bc),
+  [`65d9556`](https://github.com/graphile/crystal/commit/65d9556cf18c54a7cd9c291aa10aa9806adb3c7a)]:
+  - postgraphile@5.0.0-rc.4
+  - graphile-build@5.0.0-rc.3
+  - graphile-config@1.0.0-rc.3
+
 ## 5.0.0-rc.2
 
 ### Patch Changes

package/LICENSE.md

@@ -1,80 +1,20 @@
-# Sponsors-only license
+# The MIT License (MIT)
 
-Copyright © `2023` Graphile Ltd. All rights reserved.
+Copyright © `2025` Benjie Gillam
 
-## Definitions
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-- "Software": the software program named `graphile` and
-  [available via npm](http://npmjs.com/package/graphile).
-- "Sponsor": an individual, company, or other legal entity that is sponsoring
-  Graphile Ltd via [GitHub Sponsors](https://github.com/sponsors/benjie),
-  [Patreon](https://patreon.com/benjie), or any method agreed with Graphile Ltd.
-- "Sponsorship": the period for which either or both You and Your Organization
-  are a Sponsor. If You or Your Organization makes a payment which does not
-  recur automatically, the Sponsorship is deemed to be the period of 30 days
-  from the date of that payment.
-- "You": the individual using the Software.
-- "Your Organization": the company or other legal entity on behalf of which You
-  are using the Software (if applicable).
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-## If you are not a Sponsor
-
-If You are not a Sponsor and Your Organization is not a Sponsor, the first time
-You use the Software, Graphile Ltd grants You a revokable, non-exclusive,
-non-transferable, non-sublicensable, license to run the Software for 30 calendar
-days. Graphile Ltd may revoke this license at any time, for any (or no) reason,
-with no requirement to give you advance notice.
-
-You can use the Software on as many machines as You want, for Your own use.
-
-Your license terminates automatically at the end of those 30 calendar days.
-
-If you have previously used the Software, You do not get another free trial
-period or an extended free trial period by downloading it again, or using it on
-a different machine. You get one free trial, ever.
-
-To use the Software after the termination of the free trial, Your or Your
-Organization must be a Sponsor.
-
-## If You or Your Organization is a Sponsor
-
-If either or both You or Your Organization is a Sponsor, Graphile Ltd grants You
-a revokable, non-exclusive, non-transferable, non-sublicensable, license to run
-the Software for the duration of the Sponsorship. Graphile Ltd may revoke this
-license at any time, for any (or no) reason, with no requirement to give you
-advance notice.
-
-You can use the Software on as many machines as You want, for Your own use.
-
-Your license terminates automatically at the end of the Sponsorship.
-
-Unless Graphile Ltd informs you in writing (including email, response to an
-online support ticket, and other similar electronic mechanisms) that it is not
-willing to grant you a new license, to obtain a new license, You, or Your
-Organization, must become a Sponsor again.
-
-## Indemnity and no warranty
-
-You indemnify and hold Graphile Ltd and its directors, employees, parents,
-subsidiaries and partners (if any) harmless from any and all claims, charges,
-costs, damages, demands, fines, judgements, liabilities, losses, or penalties of
-any nature, arising out of or in connection with:
-
-- Your use of the Software;
-- Your non-compliance with the terms of the licence, or use of the Software
-  without a licence;
-- Your violation of any rights of a third party; and
-- Your violation of any law or regulation.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-## Law and jurisdiction
-
-This agreement is governed by English law. The courts of England and Wales have
-exclusive jurisdiction in respect of any claims arising out of or in connection
-with it, including non-contractual claims.

package/README.md

@@ -10,51 +10,90 @@ projects, helping you to create, debug, update, interact with and maintain them.
 
 At the moment, it doesn't contain much, but it should grow over time.
 
-## Sponsors-only, source available
-
-**TL;DR**: _30 day free trial, then become a sponsor to continue using_.
-
-Unlike the vast majority of our other packages, **this package is not open
-source software**. Instead it is licensed software, only to be used by sponsors.
-
-At Graphile, we can only work on open source as much as we do thanks to the
-support of our sponsors. Sadly, many corporations decline to fund the open
-source software that underpins the success of their businesses. This lack of
-funding can lead to maintainer burnout and ultimately the discontinuation of
-projects, leaving these short-sighted companies to spend large amounts on
-maintenance, security, and/or rewrites.
-
-<figure>
-<img
-  src="https://imgs.xkcd.com/comics/dependency.png"
-  alt="An XKCD cartoon showing how all modern digital infrastructure relies on a project some random person in Nebraska has been thanklessly maintaining since 2003."
-  />
-<figcaption>
-<p><em>Mandatory XKCD #2347 - Dependency.</em></p>
-</figcaption>
-</figure>
-
-Fortunately smart engineers tend to recognize that OSS projects need financial
-support to both be sustainable and to keep advancing. This sponsors-only package
-serves two purposes. First and foremost, it is a thank you to our sponsors who
-have helped us to get this far. Secondly, it acts as a carrot that
-forward-thinking engineers can use to convince their corporations sponsorship is
-necessary.
-
-_We hope that once a company is sponsoring one project, sponsoring others should
-be much easier; as such, this project is **only licensed for sponsors** - we do
-not sell licenses to it separately._
-
-We offer non-sponsors a 30 day trial of this software, after that you must
-become a sponsor to keep using it. We recommend a sponsorship of at least $25/mo
-per engineer, however you may sponsor us at any amount that the platforms allow.
-One-time sponsorships are equivalent to 30 calendar days of sponsorship.
-
-## `graphile config print`
+## `graphile config`
+
+Config debugging commands
+
+### `graphile config print`
 
 Prints out the configuration from your `graphile.config.mjs` (or similar) file
 in an easy to read/digest form.
 
-## `graphile config options`
+### `graphile config options`
+
+Outputs markdown detailing the full list of options that you may specify in your
+config file, suitable for inclusion in your repository's documentation folder.
+Output is honed specifically to your set of plugins and presets.
+
+## `graphile inflection`
+
+Inflection debugging commands
+
+### `graphile inflection list`
+
+Outputs markdown detailing the full list of inflectors that have been defined
+(and may be overridden via a plugin), suitable for inclusion in your
+repository's documentation folder. Output is honed specifically to your set of
+plugins and presets.
+
+## `graphile behavior`
+
+Behavior debugging commands. (WARNING: This hasn't been updated since behavior
+defaults were reworked, so is now super verbose and a little confusing.)
+
+### `graphile behavior debug`
+
+Lists the `entityType`s available to debug (will vary depending on your
+plugins); example:
+
+```
+$ graphile behavior debug
+No entity type was specified; please pick one of the supported entity types:
+- pgCodec
+- pgCodecAttribute
+- pgCodecRef
+- pgCodecRelation
+- pgRefDefinition
+- pgResource
+- pgResourceUnique
+```
+
+(See
+[@dataplan/pg registry](https://grafast.org/grafast/step-library/dataplan-pg/registry/)
+for details of the example above.)
+
+### `graphile behavior debug <entityType>`
+
+Lists the entity identifiers for that specific entity type; e.g.
+
+```
+$ graphile behavior debug pgResource
+No entity identifier was specified; please pick one of the supported entities for entity type 'pgResource':
+- fn
+- person
+- post
+```
+
+### `graphile behavior debug <entityType> <entityIdentifier>`
+
+Outputs the behavior string for the given entity, along with sources that caused
+it to be derived in that way - indicating which behaviors came from which
+plugins.
+
+The output for each plugin includes styled text:
+
+- green text is behavior strings added by this plugin - this may be either at
+  the start or end of the string
+- grey text is inherited from previous behavior string
+- strike through text (green or grey) indicates a behavior fragment that has
+  been overridden by a later value in the string
+
+The `__ApplyBehaviors_*__`-style entry is a workaround that shows the
+"multiplication" of the previous behavior with the default behavior. It's a
+hack/workaround until we have a better way of presenting this concept.
+
+### `graphile behavior debug <entityType> <entityIdentifier> <filterString>`
 
-Indicates the full list of options that you may specify in your config file.
+As above, but pass a filter string (a behavior fragment) and any behaviors
+related to that will be highlit so you can see what came to manipulate that
+particular setting.

package/dist/commands/config/cli.js

@@ -7,7 +7,7 @@ const optionsCmd = tslib_1.__importStar(require("./options/cli.js"));
 const printCmd = tslib_1.__importStar(require("./print/cli.js"));
 function options(yargs) {
     return yargs
-        .command("options", "Output the options your config may contain", optionsCmd.options, optionsCmd.run)
+        .command(optionsCmd.command, optionsCmd.description, optionsCmd.options, optionsCmd.run)
         .command("print", "Prints your resolved configuration", printCmd.options, printCmd.run)
         .demandCommand();
 }

package/dist/commands/config/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../src/commands/config/cli.ts"],"names":[],"mappings":";;AAKA,0BAeC;AAED,kBAGC;;AAvBD,qEAA+C;AAC/C,iEAA2C;AAE3C,SAAgB,OAAO,CAAC,KAAW;IACjC,OAAO,KAAK;SACT,OAAO,CACN,SAAS,EACT,4CAA4C,EAC5C,UAAU,CAAC,OAAO,EAClB,UAAU,CAAC,GAAG,CACf;SACA,OAAO,CACN,OAAO,EACP,oCAAoC,EACpC,QAAQ,CAAC,OAAO,EAChB,QAAQ,CAAC,GAAG,CACb;SACA,aAAa,EAAE,CAAC;AACrB,CAAC;AAED,SAAgB,GAAG,CAAC,KAAsC;IACxD,oDAAoD;IACpD,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;AACzC,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../src/commands/config/cli.ts"],"names":[],"mappings":";;AAKA,0BAeC;AAED,kBAGC;;AAvBD,qEAA+C;AAC/C,iEAA2C;AAE3C,SAAgB,OAAO,CAAC,KAAW;IACjC,OAAO,KAAK;SACT,OAAO,CACN,UAAU,CAAC,OAAO,EAClB,UAAU,CAAC,WAAW,EACtB,UAAU,CAAC,OAAO,EAClB,UAAU,CAAC,GAAG,CACf;SACA,OAAO,CACN,OAAO,EACP,oCAAoC,EACpC,QAAQ,CAAC,OAAO,EAChB,QAAQ,CAAC,GAAG,CACb;SACA,aAAa,EAAE,CAAC;AACrB,CAAC;AAED,SAAgB,GAAG,CAAC,KAAsC;IACxD,oDAAoD;IACpD,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;AACzC,CAAC"}

package/dist/commands/config/options/cli.d.ts

@@ -1,6 +1,10 @@
 import type { ArgsFromOptions, Argv } from "graphile-config/cli";
+export declare const command = "options [scope]";
+export declare const description = "Output the options your config may contain";
 export declare function options(yargs: Argv): Argv<{
     config: string | undefined;
+} & {
+    scope: string | undefined;
 }>;
 export declare function run(args: ArgsFromOptions<typeof options>): void;
 //# sourceMappingURL=cli.d.ts.map

package/dist/commands/config/options/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../../../src/commands/config/options/cli.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAIjE,wBAAgB,OAAO,CAAC,KAAK,EAAE,IAAI;;GAYlC;AACD,wBAAgB,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,OAAO,OAAO,CAAC,QAGxD"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../../../src/commands/config/options/cli.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAIjE,eAAO,MAAM,OAAO,oBAAoB,CAAC;AAEzC,eAAO,MAAM,WAAW,+CAA+C,CAAC;AAExE,wBAAgB,OAAO,CAAC,KAAK,EAAE,IAAI;;;;GAsBlC;AACD,wBAAgB,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,OAAO,OAAO,CAAC,QAGxD"}

package/dist/commands/config/options/cli.js

@@ -1,20 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.description = exports.command = void 0;
 exports.options = options;
 exports.run = run;
 const main_js_1 = require("./main.js");
+exports.command = "options [scope]";
+exports.description = "Output the options your config may contain";
 function options(yargs) {
     return yargs
-        .example("$0 -C graphile.config.ts", "Read and parse graphile.config.ts, and determine the options available for presets therein")
+        .example("$0", "Read graphile.config.ts and determine the configuration options available")
+        .example("$0 grafserv", "As above, but only output configuration for the grafserv scope")
+        .example("$0 -C myconf.ts", "Use a custom configuration path")
         .option("config", {
         alias: "C",
         type: "string",
         description: "The path to the config file",
         normalize: true,
+    })
+        .positional("scope", {
+        description: "Only include the specified scope",
+        demandOption: false,
+        type: "string",
     });
 }
 function run(args) {
-    const text = (0, main_js_1.main)({ filename: args.config });
+    const text = (0, main_js_1.main)({ filename: args.config, scope: args.scope });
     console.log(text);
 }
 //# sourceMappingURL=cli.js.map

package/dist/commands/config/options/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../../src/commands/config/options/cli.ts"],"names":[],"mappings":";;AAIA,0BAYC;AACD,kBAGC;AAlBD,uCAAiC;AAEjC,SAAgB,OAAO,CAAC,KAAW;IACjC,OAAO,KAAK;SACT,OAAO,CACN,0BAA0B,EAC1B,4FAA4F,CAC7F;SACA,MAAM,CAAC,QAAQ,EAAE;QAChB,KAAK,EAAE,GAAG;QACV,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,6BAA6B;QAC1C,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;AACP,CAAC;AACD,SAAgB,GAAG,CAAC,IAAqC;IACvD,MAAM,IAAI,GAAG,IAAA,cAAI,EAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7C,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../../src/commands/config/options/cli.ts"],"names":[],"mappings":";;;AAQA,0BAsBC;AACD,kBAGC;AAhCD,uCAAiC;AAEpB,QAAA,OAAO,GAAG,iBAAiB,CAAC;AAE5B,QAAA,WAAW,GAAG,4CAA4C,CAAC;AAExE,SAAgB,OAAO,CAAC,KAAW;IACjC,OAAO,KAAK;SACT,OAAO,CACN,IAAI,EACJ,2EAA2E,CAC5E;SACA,OAAO,CACN,aAAa,EACb,gEAAgE,CACjE;SACA,OAAO,CAAC,iBAAiB,EAAE,iCAAiC,CAAC;SAC7D,MAAM,CAAC,QAAQ,EAAE;QAChB,KAAK,EAAE,GAAG;QACV,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,6BAA6B;QAC1C,SAAS,EAAE,IAAI;KAChB,CAAC;SACD,UAAU,CAAC,OAAO,EAAE;QACnB,WAAW,EAAE,kCAAkC;QAC/C,YAAY,EAAE,KAAK;QACnB,IAAI,EAAE,QAAQ;KACf,CAAC,CAAC;AACP,CAAC;AACD,SAAgB,GAAG,CAAC,IAAqC;IACvD,MAAM,IAAI,GAAG,IAAA,cAAI,EAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IAChE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC"}

package/dist/commands/config/options/main.d.ts

@@ -1,4 +1,5 @@
 export declare function main(options: {
     filename?: string;
+    scope?: string;
 }): string;
 //# sourceMappingURL=main.d.ts.map

package/dist/commands/config/options/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../../src/commands/config/options/main.ts"],"names":[],"mappings":"AASA,wBAAgB,IAAI,CAAC,OAAO,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,UA4OlD"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../../src/commands/config/options/main.ts"],"names":[],"mappings":"AAiBA,wBAAgB,IAAI,CAAC,OAAO,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,UA4VlE"}