@okam/directus-block 1.2.0 → 1.2.2

package/src/components/BlockSerializer/interface.ts

@@ -1,51 +0,0 @@
-import { type TypedDocumentNode } from '@graphql-typed-document-node/core'
-import type { Nullable, TDefaultComponent } from '@okam/stack-ui'
-import type { Variables } from 'graphql-request'
-import type { FunctionComponent } from 'react'
-import type {
-  TCommonBlockFragment,
-  TAdditionalProps,
-  TBlockQuery,
-  TBlockVariables,
-  TBlockDocument,
-} from '../../types/block'
-
-export interface TBlock<
-  BlockFragment extends TCommonBlockFragment = TCommonBlockFragment,
-  BlockVariables extends Variables = Variables,
-> {
-  collection?: Nullable<string>
-  item?: Nullable<BlockFragment>
-  variables?: TBlockVariables<BlockVariables>
-  document?: TypedDocumentNode<TBlockQuery<BlockFragment>, BlockVariables>
-}
-
-export type TBlockSerializerProps<
-  BlockFragment extends TCommonBlockFragment = TCommonBlockFragment,
-  BlockVariables extends Variables = TBlockVariables,
-  AdditionalProps extends TAdditionalProps = TAdditionalProps,
-> = TBlock<BlockFragment, BlockVariables> &
-  TDefaultComponent & {
-    config?: TBlockSerializerConfig
-    defaultVariant?: string
-    additionalProps?: AdditionalProps
-  }
-
-export type TBlockFunctionComponent<BlockFragment extends TCommonBlockFragment = TCommonBlockFragment> =
-  FunctionComponent<TBlockSerializerProps<BlockFragment>>
-
-export type TBlockSerializerConfigComponent<BlockFragment extends TCommonBlockFragment = TCommonBlockFragment> = {
-  [blockKey: string]: {
-    default: TBlockFunctionComponent<BlockFragment>
-    document?: TBlockDocument<BlockFragment>
-    defaultVariant?: string
-    getVariant?: (props: TBlockSerializerProps<BlockFragment>) => Nullable<string>
-    variants?: {
-      [blockVariant: string]: TBlockFunctionComponent<BlockFragment>
-    }
-  }
-}
-
-export interface TBlockSerializerConfig {
-  components: TBlockSerializerConfigComponent
-}

package/src/generated/fragment-masking.ts

@@ -1,66 +0,0 @@
-/* eslint-disable */
-import { ResultOf, DocumentTypeDecoration, TypedDocumentNode } from '@graphql-typed-document-node/core';
-import { FragmentDefinitionNode } from 'graphql'
-import { Incremental } from './graphql';
-
-export type FragmentType<TDocumentType extends DocumentTypeDecoration<any, any>> = TDocumentType extends DocumentTypeDecoration<
-  infer TType,
-  any
->
-  ? [TType] extends [{ ' $fragmentName'?: infer TKey }]
-    ? TKey extends string
-      ? { ' $fragmentRefs'?: { [key in TKey]: TType } }
-      : never
-    : never
-  : never;
-
-// return non-nullable if `fragmentType` is non-nullable
-export function useFragment<TType>(
-  _documentNode: DocumentTypeDecoration<TType, any>,
-  fragmentType: FragmentType<DocumentTypeDecoration<TType, any>>
-): TType;
-// return nullable if `fragmentType` is nullable
-export function useFragment<TType>(
-  _documentNode: DocumentTypeDecoration<TType, any>,
-  fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | null | undefined
-): TType | null | undefined;
-// return array of non-nullable if `fragmentType` is array of non-nullable
-export function useFragment<TType>(
-  _documentNode: DocumentTypeDecoration<TType, any>,
-  fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
-): ReadonlyArray<TType>;
-// return array of nullable if `fragmentType` is array of nullable
-export function useFragment<TType>(
-  _documentNode: DocumentTypeDecoration<TType, any>,
-  fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
-): ReadonlyArray<TType> | null | undefined;
-export function useFragment<TType>(
-  _documentNode: DocumentTypeDecoration<TType, any>,
-  fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
-): TType | ReadonlyArray<TType> | null | undefined {
-  return fragmentType as any;
-}
-
-export function makeFragmentData<
-  F extends DocumentTypeDecoration<any, any>,
-  FT extends ResultOf<F>
->(data: FT, _fragment: F): FragmentType<F> {
-  return data as FragmentType<F>;
-}
-export function isFragmentReady<TQuery, TFrag>(
-  queryNode: DocumentTypeDecoration<TQuery, any>,
-  fragmentNode: TypedDocumentNode<TFrag>,
-  data: FragmentType<TypedDocumentNode<Incremental<TFrag>, any>> | null | undefined
-): data is FragmentType<typeof fragmentNode> {
-  const deferredFields = (queryNode as { __meta__?: { deferredFields: Record<string, (keyof TFrag)[]> } }).__meta__
-    ?.deferredFields;
-
-  if (!deferredFields) return true;
-
-  const fragDef = (fragmentNode as any).definitions[0] as FragmentDefinitionNode | undefined;
-  const fragName = fragDef?.name?.value;
-
-  const fields = (fragName && deferredFields[fragName]) || [];
-  //@ts-ignore
-  return fields.length > 0 && fields.every((field) => data && field in data);
-}

package/src/generated/graphql.ts

@@ -1,31 +0,0 @@
-/* eslint-disable prettier/prettier */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/naming-convention */
-import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core'
-
-export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
-export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }
-
-export type Scalars = {
-  ID: { input: string; output: string; }
-  String: { input: string; output: string; }
-  Boolean: { input: boolean; output: boolean; }
-  Int: { input: number; output: number; }
-  Float: { input: number; output: number; }
-  /** ISO8601 Date values */
-  Date: { input: any; output: any; }
-  /** BigInt value */
-  GraphQLBigInt: { input: any; output: any; }
-  /** A Float or a String */
-  GraphQLStringOrFloat: { input: any; output: any; }
-  /** Hashed string values */
-  Hash: { input: any; output: any; }
-  /** The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf). */
-  JSON: { input: any; output: any; }
-};
-
-export type BlockSettingsFragment = { __typename?: 'block_settings'; tokens?: any | null; variant?: string | null } & {
-  ' $fragmentName'?: 'BlockSettingsFragment'
-}
-
-export const BlockSettingsFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"BlockSettings"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"block_settings"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"tokens"}},{"kind":"Field","name":{"kind":"Name","value":"variant"}}]}}]} as unknown as DocumentNode<BlockSettingsFragment, unknown>;

package/src/index.ts

@@ -1,30 +0,0 @@
-// Components
-export { default as BlockDispatcher } from './components/BlockDispatcher'
-export { default as BlockSerializer } from './components/BlockSerializer'
-
-// Types
-export type { TBlockDispatcherProps } from './components/BlockDispatcher/interface'
-export type {
-  TBlockSerializerConfig,
-  TBlockSerializerProps,
-  TBlock,
-  TBlockSerializerConfigComponent,
-} from './components/BlockSerializer/interface'
-export type {
-  TAdditionalProps,
-  TCommonBlockFragment,
-  TBlockQuery,
-  TBlockDocument,
-  TBlockVariables,
-} from './types/block'
-
-// Blocks
-export { default as BlockWysiwyg } from './blocks/BlockWysiwyg'
-
-// Utils
-export { default as getBlockProps } from './utils/get-block-props'
-export { default as mergeConfigs } from './utils/merge-configs'
-
-// Configs
-export { default as blockWysiwygConfig } from './blocks/BlockWysiwyg/config'
-export { default as baseConfig } from './components/BlockDispatcher/config'

package/src/types/block.ts

@@ -1,40 +0,0 @@
-/* eslint-disable @typescript-eslint/naming-convention */
-import type { DocumentTypeDecoration, TypedDocumentNode } from '@graphql-typed-document-node/core'
-import type { Nullable } from '@okam/stack-ui'
-import type { Variables } from 'graphql-request'
-import type { FragmentType } from '../generated/fragment-masking'
-import type { BlockSettingsFragment } from '../generated/graphql'
-
-export type TAdditionalProps = { [key: string]: unknown }
-
-type BlockSettings = FragmentType<DocumentTypeDecoration<BlockSettingsFragment, unknown>>
-
-export type TCommonBlockFragment = {
-  id?: Nullable<string>
-  settings?: Nullable<BlockSettings>
-} & Record<string, unknown>
-
-export type TBlockQuery<BlockFragment extends TCommonBlockFragment> = {
-  __typename?: 'Query'
-} & {
-  [blockKey: string]:
-    | {
-        ' $fragmentRefs'?:
-          | {
-              [blockFragmentKey: string]: BlockFragment
-            }
-          | null
-          | undefined
-      }
-    | null
-    | undefined
-}
-
-export type TBlockVariables<BlockVariables extends Variables = Variables> = {
-  id: string
-} & BlockVariables
-
-export type TBlockDocument<
-  BlockFragment extends TCommonBlockFragment,
-  BlockVariables extends Variables = Variables,
-> = TypedDocumentNode<TBlockQuery<BlockFragment>, TBlockVariables<BlockVariables>>

package/src/utils/get-block-props.ts

@@ -1,44 +0,0 @@
-'server-only'
-
-import { queryGql } from '@okam/directus-query'
-import type { Nullable } from '@okam/stack-ui'
-import type { Variables } from 'graphql-request'
-import type { TBlockDocument, TBlockQuery, TBlockVariables, TCommonBlockFragment } from '../types/block'
-
-type TGetBlockPropsParams<BlockFragment extends TCommonBlockFragment, BlockVariables extends Variables = Variables> = {
-  document?: TBlockDocument<BlockFragment, BlockVariables>
-  item?: Nullable<NonNullable<NonNullable<TBlockQuery<BlockFragment>[string]>[' $fragmentRefs']>[string]>
-  blockKey?: string
-  variables?: TBlockVariables<BlockVariables>
-}
-
-function isVariables<BlockVariables extends Variables>(
-  maybeVariables: Nullable<Variables>,
-): maybeVariables is BlockVariables {
-  return !!maybeVariables
-}
-
-/**
- * Returns the passed item if it is defined. Otherwise, queried its own block
- * @param params.blockKey Key of the queried field
- * @param params.item Item of the block. If null, the function will make a query
- * @returns The block data
- */
-export default async function getBlockProps<
-  BlockFragment extends TCommonBlockFragment,
-  BlockVariables extends Variables = Variables,
->(params: TGetBlockPropsParams<BlockFragment, BlockVariables>): Promise<BlockFragment | null | undefined> {
-  const { document, item, blockKey, variables } = params
-
-  if (item) return item
-
-  if (!document || !isVariables<BlockVariables>(variables)) return null
-
-  const queriedBlockProps = await queryGql(document, variables)
-
-  if (!queriedBlockProps || typeof queriedBlockProps !== 'object' || !blockKey) return null
-
-  const queriedBlockFragment = queriedBlockProps[blockKey]
-
-  return queriedBlockFragment as BlockFragment
-}

package/src/utils/index.ts

@@ -1,5 +0,0 @@
-import { useFragment } from '../generated/fragment-masking'
-
-export { default as getBlockProps } from './get-block-props'
-export { default as mergeConfigs } from './merge-configs'
-export { useFragment as getFragment }

package/src/utils/merge-configs.ts

@@ -1,21 +0,0 @@
-import type { Nullable } from '@okam/stack-ui'
-import type { TBlockSerializerConfig } from '../components/BlockSerializer/interface'
-
-/**
- * Merges multiple block dispatcher configs
- * @param baseConfig The base configuration. Other configurations will be prioritized over this one, which acts as a fallback
- * @param configs Array of block dispatcher serializers to merge. Later elements will always be prioritized over first elements
- * @returns Merged config
- */
-export default function mergeConfigs(
-  baseConfig: TBlockSerializerConfig,
-  ...configs: Nullable<TBlockSerializerConfig>[]
-): TBlockSerializerConfig {
-  const finalConfig = configs.reduce<TBlockSerializerConfig>((mergedConfig, config) => {
-    if (!config) return mergedConfig
-
-    return { components: { ...mergedConfig.components, ...config.components } }
-  }, baseConfig)
-
-  return finalConfig
-}

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "compilerOptions": {
-    "jsx": "react-jsx",
-    "allowJs": false,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "strict": true
-  },
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./.storybook/tsconfig.json"
-    }
-  ],
-  "extends": "../../../tsconfig.base.json"
-}

package/tsconfig.lib.json

@@ -1,25 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../../dist/out-tsc",
-    "types": ["node", "next"]
-  },
-  "paths": { "@workspace/*": ["dist/libs/*"] },
-  "files": [
-    "../../../node_modules/@nx/react/typings/cssmodule.d.ts",
-    "../../../node_modules/@nx/react/typings/image.d.ts"
-  ],
-  "exclude": [
-    "**/*.spec.ts",
-    "**/*.test.ts",
-    "**/*.spec.tsx",
-    "**/*.test.tsx",
-    "**/*.spec.js",
-    "**/*.test.js",
-    "**/*.spec.jsx",
-    "**/*.test.jsx",
-    "**/*.stories.ts",
-    "**/*.stories.js"
-  ],
-  "include": ["**/*.js", "**/*.jsx", "**/*.ts", "**/*.tsx"]
-}

package/vite.config.ts

@@ -1,51 +0,0 @@
-/* eslint-disable import/no-relative-packages */
-/// <reference types="vitest" />
-import * as path from 'path'
-import react from '@vitejs/plugin-react'
-import { defineConfig } from 'vite'
-import dts from 'vite-plugin-dts'
-import viteTsConfigPaths from 'vite-tsconfig-paths'
-import externalDeps from '../../../config/external-deps'
-
-export default defineConfig({
-  cacheDir: '../../../node_modules/.vite/directus-block',
-
-  plugins: [
-    dts({
-      entryRoot: 'src',
-      tsConfigFilePath: path.join(__dirname, 'tsconfig.lib.json'),
-      skipDiagnostics: true,
-    }),
-    react(),
-    viteTsConfigPaths({
-      root: '../../../',
-    }),
-  ],
-
-  // Uncomment this if you are using workers.
-  // worker: {
-  //  plugins: [
-  //    viteTsConfigPaths({
-  //      root: '../../../',
-  //    }),
-  //  ],
-  // },
-
-  // Configuration for building your library.
-  // See: https://vitejs.dev/guide/build.html#library-mode
-  build: {
-    lib: {
-      // Could also be a dictionary or array of multiple entry points.
-      entry: 'src/index.ts',
-      name: 'directus-block',
-      fileName: 'index',
-      // Change this to the formats you want to support.
-      // Don't forget to update your package.json as well.
-      formats: ['es', 'cjs'],
-    },
-    rollupOptions: {
-      // External packages that should not be bundled into your library.
-      external: externalDeps,
-    },
-  },
-})