@financial-times/cp-content-pipeline-client 0.2.0

package/.toolkitrc.yml

@@ -0,0 +1,27 @@
+plugins:
+  - '@dotcom-tool-kit/npm'
+  - '../../tool-kit/graphql-code-generator'
+  - '../../tool-kit/placeholder-hook'
+
+hooks:
+  build:local:
+    - GraphQLCodegen
+  run:local:
+    - GraphQLCodegenWatch
+  test:local:
+    - GraphQLCodegenTest
+  test:staged:
+    - GraphQLCodegenTest
+  test:ci:
+    - GraphQLCodegenTest
+  publish:tag:
+    - NpmPublish
+
+options:
+  '../../tool-kit/graphql-code-generator':
+    watchFiles: '../schema/lib/**/*.js'
+  '../../tool-kit/placeholder-hook':
+    hooks:
+      - test:staged
+      - test:ci
+      - publish:tag

package/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+## [0.2.0](https://github.com/Financial-Times/cp-content-pipeline/compare/cp-content-pipeline-client-v0.1.0...cp-content-pipeline-client-v0.2.0) (2022-09-27)
+
+
+### ⚠ BREAKING CHANGES
+
+* rename "inline" image to "standard"
+
+### Features
+
+* add a datasource for getting vanity URLs ([cb638a5](https://github.com/Financial-Times/cp-content-pipeline/commit/cb638a5b48bc7726008189376a27d245a7b642d0))
+* add byline and authors to article query ([43eddc3](https://github.com/Financial-Times/cp-content-pipeline/commit/43eddc3ddd970e49702ff32d8fbaa8095f28e641))
+* add client package with typescript types generated from schema ([c00f07f](https://github.com/Financial-Times/cp-content-pipeline/commit/c00f07f9d9d10f74cdd834ad59efe189f151ede2))
+* add data-image-type attribute to image ([88200bb](https://github.com/Financial-Times/cp-content-pipeline/commit/88200bb366374a6e926124af68564b9a60581508))
+* Add isColumn resolver to Content ([0a2af1a](https://github.com/Financial-Times/cp-content-pipeline/commit/0a2af1ae80d103e2d6d0c5a01338c8488b866e10))
+* Add isEditorsChoice resolver to Content ([813e07b](https://github.com/Financial-Times/cp-content-pipeline/commit/813e07b2a70e0d642768d481e4fb38929da4caa2))
+* Add isExclusive resolver to Content ([cef9675](https://github.com/Financial-Times/cp-content-pipeline/commit/cef9675c5c6d5f98c94c722f855671610ab69916))
+* Add isPodcast resolver to Content ([d76eb78](https://github.com/Financial-Times/cp-content-pipeline/commit/d76eb78909accdec6aa8c654524d1ef89d4eaa56))
+* Add isScoop resolver to Content ([0441fba](https://github.com/Financial-Times/cp-content-pipeline/commit/0441fba34374c69422a2d4a4fed82cd43d68c4e1))
+* add PictureInline variant ([7d3f721](https://github.com/Financial-Times/cp-content-pipeline/commit/7d3f721fec6c9a79a21d076a5517955a15b7089d))
+* allow different image widths and breakpoints ([1210b62](https://github.com/Financial-Times/cp-content-pipeline/commit/1210b62e9f778ee09a9ecd1998bffbefb4234c2d))
+* create byline component and add it to topper ([56d6ed1](https://github.com/Financial-Times/cp-content-pipeline/commit/56d6ed1af1dd31e2f51e95b5e538578d5802a726))
+* generate a typed sdk ([66886db](https://github.com/Financial-Times/cp-content-pipeline/commit/66886db3fdc370336faa45c96d01e824d92a3569))
+* make useVanities a required option ([51eb538](https://github.com/Financial-Times/cp-content-pipeline/commit/51eb53835a767de1917e5375500ca1d7eb326f09))
+* provide all possible resolutions for image sources ([4d9d586](https://github.com/Financial-Times/cp-content-pipeline/commit/4d9d586ec4578bbd9d8d12e5333ad1f5f9f4e1ff))
+* remove PictureResponsiveMobile, and rename PictureSingle ([b25b289](https://github.com/Financial-Times/cp-content-pipeline/commit/b25b289368c424c267ab65c9494a65cb437cf99b))
+* render Layout components ([a134e30](https://github.com/Financial-Times/cp-content-pipeline/commit/a134e301f6eaddd6eb665489b76dfd36097a8903))
+* reserve image width/height to prevent layout shift ([59d2d31](https://github.com/Financial-Times/cp-content-pipeline/commit/59d2d314625f47b73f422ac1a71d7c3afe7fbe6f))
+
+
+### Bug Fixes
+
+* fix media query output when between widths ([7e1f8c6](https://github.com/Financial-Times/cp-content-pipeline/commit/7e1f8c6ea7d96207656920a7054695255d4a4b38))
+* use system-code header in client package ([fbf9c77](https://github.com/Financial-Times/cp-content-pipeline/commit/fbf9c778d6a06ec486d52c9f6d14af3668537272))
+
+
+### Code Refactoring
+
+* rename "inline" image to "standard" ([ca530b9](https://github.com/Financial-Times/cp-content-pipeline/commit/ca530b99f745e2a4f6a07249529601f0acdddd52))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @financial-times/cp-content-pipeline-schema bumped from ^0.0.0 to ^0.2.0

package/README.md

@@ -0,0 +1,25 @@
+# Content Pipeline GraphQL Client
+
+Provides a JS client for querying the GraphQL API, with a pre-defined query for a complete article, along with type definitions to use in components.
+
+## Getting Started
+
+Run `npm install` then `npm start` from [the monorepo project root](../../README.md#commands).
+
+The project has its own playground ui at the url it's running on.
+
+## Using the Client
+
+```js
+import initContentPipelineClient from '@financial-times/cp-content-pipeline-client'
+
+const client = initContentPipelineClient({
+  baseUrl: 'http://localhost:3001',
+  systemCode: 'cp-content-pipeline',
+})
+
+const { content: articleData } = await client.Article({
+  uuid: request.params.uuid,
+  useVanities: true,
+})
+```

package/codegen.yml

@@ -0,0 +1,15 @@
+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