feat(preview): adding standardized preview data cards (#697)

* feat(setup): setting up ability to run whole graph locally;

* feat(display): setting up the deriver logic for syndication

* feat(setup): setting up ability to run whole graph locally

* fix(parser): adding in collection data

* fix(image): ensuring the preview de-wraps image urls

* fix(preview): adding in preview metadata

* fix(admin): making admin use an older schema

* feat(display): adding in test structure to sync with kat

* fix(preview): adding in markdown txt

.github/workflows/parser-graphql-wrapper.yml

@@ -47,7 +47,7 @@ jobs:
     with:
       federated-graph-name: pocket-admin-api
       graph-name: parser
-      schema-file-path: servers/parser-graphql-wrapper/schema.graphql
+      schema-file-path: servers/parser-graphql-wrapper/schema-admin.graphql
       prod-graph-url: https://parser-graphql-wrapper.readitlater.com
       dev-graph-url: https://parser-graphql-wrapper.getpocket.dev
     secrets:

package.json

@@ -32,7 +32,7 @@
     "@pocket-tools/eslint-config": "workspace:*",
     "syncpack": "^12.4.0",
     "tsconfig": "workspace:*",
-    "turbo": "^2.0.14"
+    "turbo": "^2.1.0"
   },
   "packageManager": "[email protected]",
   "engines": {

packages/image-utils/.npmignore

@@ -0,0 +1,8 @@
+src
+.github
+.idea
+.prettier*
+.eslintrc.js
+.tsconfig.js
+*.spec.ts
+*.integration.ts

packages/image-utils/README.md

@@ -0,0 +1,3 @@
+# Image Utils
+
+We use this repository as a place to keep code we use across our backend services that implement anything to do with image urls

packages/image-utils/eslint.config.mjs

@@ -0,0 +1,3 @@
+import packages from '@pocket-tools/eslint-config/packages';
+import tseslint from 'typescript-eslint';
+export default tseslint.config(...packages);

packages/image-utils/jest.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['**/?(*.)+(jest|spec).[jt]s?(x)'],
+  testPathIgnorePatterns: ['/dist/'],
+  setupFilesAfterEnv: ['jest-extended/all'],
+};

packages/image-utils/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "@pocket-tools/image-utils",
+  "version": "0.0.0-development",
+  "description": "Utilities for working with image urls",
+  "keywords": [
+    "image"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Pocket/pocket-monorepo.git"
+  },
+  "license": "Apache-2.0",
+  "author": "",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "pnpm run build --watch",
+    "format": "eslint --fix",
+    "lint": "eslint --fix-dry-run",
+    "semantic-release": "semantic-release",
+    "test": "jest",
+    "test:watch": "pnpm run test -- --watch"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "extends": "semantic-release-monorepo",
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "parserOpts": {
+            "noteKeywords": [
+              "BREAKING CHANGE",
+              "BREAKING CHANGES",
+              "BREAKING"
+            ]
+          }
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "parserOpts": {
+            "noteKeywords": [
+              "BREAKING CHANGE",
+              "BREAKING CHANGES",
+              "BREAKING"
+            ]
+          },
+          "writerOpts": {
+            "commitsSort": [
+              "subject",
+              "scope"
+            ]
+          }
+        }
+      ],
+      "@semantic-release/npm",
+      "@semantic-release/github"
+    ]
+  },
+  "dependencies": {
+    "parse-url": "9.2.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "29.7.0",
+    "@pocket-tools/eslint-config": "workspace:*",
+    "@types/jest": "29.5.12",
+    "@types/node": "^20.16",
+    "jest": "29.7.0",
+    "jest-extended": "4.0.2",
+    "semantic-release": "24.1.0",
+    "semantic-release-monorepo": "8.0.2",
+    "ts-jest": "29.2.4",
+    "ts-node": "10.9.2",
+    "tsconfig": "workspace:*",
+    "tsup": "8.2.4",
+    "typescript": "5.5.4"
+  },
+  "peerDependencies": {}
+}

packages/image-utils/src/index.ts

@@ -0,0 +1 @@
+export * from './utils';

servers/image-api/src/pocketImageCache/utils.spec.ts → packages/image-utils/src/utils.spec.ts

@@ -1,4 +1,3 @@
-import { NotFoundError } from '@pocket-tools/apollo-utils';
 import { getOriginalUrlIfPocketImageCached } from './utils';
 
 describe('getOriginalUrlIfPocketImageCached', () => {
@@ -29,8 +28,6 @@ describe('getOriginalUrlIfPocketImageCached', () => {
     const url = 'https://pocket-image-cache.com/direct?resize=2000w';
     expect(() => {
       getOriginalUrlIfPocketImageCached(url);
-    }).toThrowError(
-      new NotFoundError('Pocket image cache url is missing a source url'),
-    );
+    }).toThrow(new Error('Source URL Missing'));
   });
 });

servers/image-api/src/pocketImageCache/utils.ts → packages/image-utils/src/utils.ts

@@ -1,4 +1,3 @@
-import { NotFoundError } from '@pocket-tools/apollo-utils';
 import parseUrl from 'parse-url';
 
 //Functions on this page taken from Web Client.
@@ -19,7 +18,7 @@ export const getOriginalUrlIfPocketImageCached = (url: string): string => {
   if (isEncoded) {
     const urlToUse = extractImageCacheUrl(url);
     if (!urlToUse) {
-      throw new NotFoundError('Pocket image cache url is missing a source url');
+      throw new Error('Source URL Missing');
     }
     return decodeURIComponent(urlToUse);
   }

packages/image-utils/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "tsconfig/library.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "exclude": ["node_modules", "dist"],
+  "include": ["src/**/*.ts", "src/config"]
+}