[WIP] Next image service

examples-next/todo/keystone.ts

@@ -19,13 +19,75 @@ const { withAuth } = createAuth({
   },
 });
 
+export type ImageInTheDatabase = {
+  mode: 'local' | 'cloud';
+  // e.g 'c8cd1b99-8647-4b7e-a5d1-6693c79620a9'
+  id: string;
+  // source image extension
+  ext: string;
+  // blur hash
+  // blurhash: { hash: string; x: number; y: number };
+  // metadata about the source image
+  filesize: number;
+  width: number;
+  height: number;
+};
+
+/*
+type UpdateImageInput {
+  upload: Upload
+  set: GraphqlImageInputType
+  delete: boolean;
+}
+
+mutation updatePost {
+  image: UpdateImageInput
+}
+*/
+
+export type GraphqlImageInputType = {
+  field: {
+    mode: 'local' | 'cloud';
+    id: string;
+    width: number;
+    height: number;
+    // blurhash: { hash: string; x: number; y: number };
+    extension: string;
+    filesize: number;
+  };
+};
+export type GraphqlImageOutputType = {
+  field: {
+    mode: 'local' | 'cloud';
+    id: string;
+    // https://image.keystone.cloud/thinkmill/{id}.{ext}
+    // {keystone.config.publicPath}/{id}.{ext}
+    src: string;
+    width: number;
+    height: number;
+    // blurhash: { hash: string; x: number; y: number };
+    extension: string;
+    filesize: number;
+  };
+};
+
 export default withAuth(
   config({
     db: {
       adapter: 'prisma_postgresql',
       url: process.env.DATABASE_URL || 'postgres://keystone5:k3yst0n3@localhost:5432/todo-example',
     },
     lists,
+    images: {
+      /* could be 'cloud' */
+      upload: 'local',
+      local: {
+        /* where images get stored when uploaded */
+        uploadPath: './public/images',
+        /* the basePath for where image are served from */
+        publicPath: '/images',
+      },
+    },
     ui: {
       isAccessAllowed: ({ session }) => !!session,
     },

examples-next/todo/schema.ts

@@ -1,5 +1,5 @@
 import { createSchema, list } from '@keystone-next/keystone/schema';
-import { checkbox, password, relationship, text, timestamp } from '@keystone-next/fields';
+import { checkbox, image, password, relationship, text, timestamp } from '@keystone-next/fields';
 
 // this implementation for createdBy and updatedBy is currently wrong so they're disabled for now
 const trackingFields = {
@@ -69,6 +69,7 @@ export const lists = createSchema({
       name: text({ isRequired: true }),
       email: text(),
       password: password(),
+      profilePicture: image(),
       tasks: relationship({
         ref: 'Todo.assignedTo',
         many: true,

packages-next/fields/src/index.ts

@@ -3,6 +3,7 @@ export { relationship } from './types/relationship';
 export { text } from './types/text';
 export { password } from './types/password';
 export { timestamp } from './types/timestamp';
+export { image } from './types/image';
 export { integer } from './types/integer';
 export { float } from './types/float';
 export { decimal } from './types/decimal';

packages-next/fields/src/types/image/index.ts

@@ -0,0 +1,23 @@
+// @ts-ignore
+import { Text } from '@keystone-next/fields-legacy';
+import type { FieldType, BaseGeneratedListTypes } from '@keystone-next/types';
+import { resolveView } from '../../resolve-view';
+import type { FieldConfig } from '../../interfaces';
+
+export type ImageFieldConfig<
+  TGeneratedListTypes extends BaseGeneratedListTypes
+> = FieldConfig<TGeneratedListTypes> & {
+  isRequired?: boolean;
+  isIndexed?: boolean;
+};
+
+export const image = <TGeneratedListTypes extends BaseGeneratedListTypes>(
+  config: ImageFieldConfig<TGeneratedListTypes> = {}
+): FieldType<TGeneratedListTypes> => ({
+  type: Text,
+  config,
+  views: resolveView('image/views'),
+  getAdminMeta: () => ({
+    /* ?? */
+  }),
+});

packages-next/fields/src/types/image/tests/test-fixtures.ts

@@ -0,0 +1,43 @@
+import { AdapterName } from '@keystone-next/test-utils-legacy';
+import { text } from '..';
+
+export const name = 'Text';
+export const typeFunction = text;
+export const exampleValue = () => 'foo';
+export const exampleValue2 = () => 'bar';
+export const supportsUnique = true;
+export const fieldName = 'testField';
+
+export const getTestFields = () => ({ name: text(), testField: text() });
+
+export const initItems = () => {
+  return [
+    { name: 'a', testField: '' },
+    { name: 'b', testField: 'other' },
+    { name: 'c', testField: 'FOOBAR' },
+    { name: 'd', testField: 'fooBAR' },
+    { name: 'e', testField: 'foobar' },
+    { name: 'f', testField: null },
+    { name: 'g' },
+  ];
+};
+
+export const storedValues = () => [
+  { name: 'a', testField: '' },
+  { name: 'b', testField: 'other' },
+  { name: 'c', testField: 'FOOBAR' },
+  { name: 'd', testField: 'fooBAR' },
+  { name: 'e', testField: 'foobar' },
+  { name: 'f', testField: null },
+  { name: 'g', testField: null },
+];
+
+export const supportedFilters = (adapterName: AdapterName) => [
+  'null_equality',
+  'equality',
+  adapterName !== 'prisma_sqlite' && 'equality_case_insensitive',
+  'in_empty_null',
+  'in_value',
+  adapterName !== 'prisma_sqlite' && 'string',
+  adapterName !== 'prisma_sqlite' && 'string_case_insensitive',
+];

packages-next/fields/src/types/image/views/index.tsx

@@ -0,0 +1,58 @@
+/* @jsx jsx */
+
+import { CellContainer, CellLink } from '@keystone-next/admin-ui/components';
+import {
+  CardValueComponent,
+  CellComponent,
+  FieldController,
+  FieldControllerConfig,
+  FieldProps,
+} from '@keystone-next/types';
+import { jsx } from '@keystone-ui/core';
+import { FieldContainer, FieldLabel, TextInput } from '@keystone-ui/fields';
+
+export const Field = ({ field, value, onChange, autoFocus }: FieldProps<typeof controller>) => (
+  <FieldContainer>
+    <FieldLabel>{field.label}</FieldLabel>
+    {onChange ? (
+      <TextInput
+        autoFocus={autoFocus}
+        onChange={event => onChange(event.target.value)}
+        value={value}
+      />
+    ) : (
+      value
+    )}
+  </FieldContainer>
+);
+
+export const Cell: CellComponent = ({ item, field, linkTo }) => {
+  let value = item[field.path] + '';
+  return linkTo ? <CellLink {...linkTo}>{value}</CellLink> : <CellContainer>{value}</CellContainer>;
+};
+Cell.supportsLinkTo = true;
+
+export const CardValue: CardValueComponent = ({ item, field }) => {
+  return (
+    <FieldContainer>
+      <FieldLabel>{field.label}</FieldLabel>
+      {item[field.path]}
+    </FieldContainer>
+  );
+};
+
+type Config = FieldControllerConfig;
+
+export const controller = (config: Config): FieldController<string, string> => {
+  return {
+    path: config.path,
+    label: config.label,
+    graphqlSelection: config.path,
+    defaultValue: '',
+    deserialize: data => {
+      const value = data[config.path];
+      return typeof value === 'string' ? value : '';
+    },
+    serialize: value => ({ [config.path]: value }),
+  };
+};

packages-next/types/src/config/index.ts

@@ -24,9 +24,12 @@ import type { ListAccessControl, FieldAccessControl } from './access-control';
 import type { ListHooks } from './hooks';
 
 export type KeystoneConfig = {
+  // e.g 'thinkmill:243809dsjkfdls-r2y8osdfjsdf-23y8osf',
+  cloud?: string;
   lists: ListSchemaConfig;
   db: DatabaseConfig;
   ui?: AdminUIConfig;
+  images?: ImagesConfig;
   server?: ServerConfig;
   session?: () => SessionStrategy<any>;
   graphql?: GraphQLConfig;
@@ -106,6 +109,22 @@ export type AdminFileToWrite =
   | { mode: 'write'; src: string; outputPath: string }
   | { mode: 'copy'; inputPath: string; outputPath: string };
 
+// config.images
+
+export type ImagesConfig =
+  | {
+      upload: 'local';
+      local: {
+        /** The path local images are uploaded to */
+        uploadPath?: string;
+        /** The path local images will be served from, outside of keystone */
+        publicPath?: string;
+      };
+    }
+  | {
+      upload: 'cloud';
+    };
+
 // config.server
 
 export type ServerConfig = {