@financial-times/cp-content-pipeline-client 0.6.1 → 0.6.3

package/CHANGELOG.md

@@ -126,6 +126,30 @@
   * devDependencies
     * @financial-times/cp-content-pipeline-schema bumped from ^0.7.0 to ^0.7.1
 
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @financial-times/cp-content-pipeline-schema bumped from ^0.7.2 to ^0.7.3
+
+## [0.6.2](https://github.com/Financial-Times/cp-content-pipeline/compare/cp-content-pipeline-client-v0.6.1...cp-content-pipeline-client-v0.6.2) (2023-03-16)
+
+
+### Features
+
+* add a way of asserting our fragments are compatible with content-tree ([86ddeab](https://github.com/Financial-Times/cp-content-pipeline/commit/86ddeab8ad66c96ff2e6e700cae82236171858b4))
+* add more content-tree/fragment type assertions ([412441b](https://github.com/Financial-Times/cp-content-pipeline/commit/412441b6270e8aa4eca4809e90a4140892db0e67))
+* generate types for scalars ([0ce155e](https://github.com/Financial-Times/cp-content-pipeline/commit/0ce155e64ce9691dde2b123963d5159d89f5b18d))
+* include id property in image responses ([de16578](https://github.com/Financial-Times/cp-content-pipeline/commit/de165784f7a26a3173f9e9b5a95b89e21c1e30ef))
+* remove unused alt field from image fragment (it's on the imageset) ([9c6d58f](https://github.com/Financial-Times/cp-content-pipeline/commit/9c6d58f9a90b307cb96c7a21551d6227d92aaafb))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @financial-times/cp-content-pipeline-schema bumped from ^0.7.1 to ^0.7.2
+
 ## [0.6.0](https://github.com/Financial-Times/cp-content-pipeline/compare/cp-content-pipeline-client-v0.5.11...cp-content-pipeline-client-v0.6.0) (2023-03-14)
 
 

package/README.md

@@ -16,8 +16,8 @@ The project has its own playground ui at the url it's running on.
 import initContentPipelineClient from '@financial-times/cp-content-pipeline-client'
 
 const client = initContentPipelineClient({
-  baseUrl: 'http://localhost:3001',
-  systemCode: 'cp-content-pipeline',
+  baseUrl: 'http://localhost:3001', // for testing purposes only
+  systemCode: 'cp-content-pipeline', // your consuming app's Biz Ops system code
   timeout: 2000 // default = 1 minute
 })
 
@@ -27,6 +27,14 @@ const { content: articleData } = await client.Article({
 })
 ```
 
+### URLs and versioning
+
+The client requests versions of the API based on the version of the schema it has installed as a dependency. For example, a client that depends on `@financial-times/cp-content-pipeline-schema` 0.7.x will send requests to `https://www.ft.com/__content/v0.7`.
+
+When we release a new major version of the schema, we'll release a new major version of the client alongside it, so consuming apps can install the new version of the client to get the breaking schema changes, and consumers still depending on the old client version will get the old schema.
+
+The `baseUrl` option overrides this logic, and forces all requests to go to that URL, without the version suffix. This means if you're overriding `baseUrl`, you're opting out of having the client handle versioning for you. For this reason, **`baseUrl` should only be used for testing purposes**, e.g. to force the client to send requests to a locally-running API.
+
 ## How this package is produced
 
 The published `cp-content-pipeline-client` package mainly consists of generated code which is the output of [@graphql-codegen](https://www.npmjs.com/package/@graphql-codegen/cli). 

package/codegen.js

@@ -0,0 +1,34 @@
+const { scalars } = require('@financial-times/cp-content-pipeline-schema')
+const mapValues = require('lodash.mapvalues')
+
+const config = {
+  schema: [
+    {
+      schema: {
+        loader: './loader.js',
+      },
+    },
+  ],
+  documents: 'queries/*.graphql',
+  generates: {
+    'src/generated/index.ts': {
+      plugins: [
+        'typescript',
+        'typescript-operations',
+        'typescript-graphql-request',
+      ],
+      config: {
+        // discourage transforming data in consumers by making properties readonly
+        immutableTypes: true,
+        // make types better-compatible with React, which doesn't like null
+        maybeValue: 'T',
+        // output types for custom scalars
+        scalars: mapValues(scalars, (scalar) => scalar.codegenType),
+        // don't ouptput __typename unless requested
+        skipTypename: true,
+      },
+    },
+  },
+}
+
+module.exports = config