@jeromefitz/notion 6.1.0 → 6.2.0-canary.1

package/src/index.ts

@@ -0,0 +1,151 @@
+import { Client as _Client } from "@notionhq/client";
+
+import { DATA_TYPES } from "./constants/index";
+import {
+  getBlocksByIdChildren,
+  getDatabasesByIdQuery,
+  getDeepFetchAllChildren,
+  getInfoType,
+  getNotionListing,
+  getNotionListingByDate,
+  getNotionSlug,
+  getNotionSlugByRoute,
+  getPagesById,
+  getPathVariables,
+  getQuery,
+} from "./queries/index";
+
+type ClientProps = {
+  custom: CustomProps;
+  dataTypes: DataTypesProps;
+};
+
+type CredentialProps = {
+  auth: string;
+  config: any;
+};
+
+type CustomProps = {
+  getBlocksByIdChildren: any;
+  getDatabasesByIdQuery: any;
+  getDeepFetchAllChildren: any;
+  getInfoType: any;
+  getPagesById: any;
+  getPathVariables: any;
+  getQuery: any;
+};
+
+type DataTypesProps = {
+  LISTING: any;
+  LISTING_BY_DATE: any;
+  SLUG: any;
+  SLUG_BY_ROUTE: any;
+};
+
+class Client extends _Client {
+  #config?: any;
+
+  // @todo(notion) throw error if `config` is not passed
+  public readonly custom = {
+    getBlocksByIdChildren: async (props) =>
+      await getBlocksByIdChildren({
+        ...props,
+        getBlocksChildrenList: this.blocks.children.list,
+      }),
+
+    getDatabasesByIdQuery: async (props) =>
+      await getDatabasesByIdQuery({
+        ...props,
+        getDatabasesQuery: this.databases.query,
+      }),
+
+    getDeepFetchAllChildren: async (props) =>
+      await getDeepFetchAllChildren({
+        ...props,
+        getBlocksChildrenList: this.blocks.children.list,
+      }),
+
+    getInfoType: (props) => {
+      return getInfoType({ ...props, config: this.#config });
+    },
+
+    getPagesById: async (props) =>
+      await getPagesById({ ...props, getPagesRetrieve: this.pages.retrieve }),
+
+    getPathVariables: (props) => getPathVariables({ ...props, config: this.#config }),
+
+    getQuery: async (props) =>
+      await getQuery({
+        ...props,
+        config: this.#config,
+        notionDatabasesQuery: this.databases.query,
+      }),
+  };
+
+  /**
+   * @info details at: ../../utils/getDataType
+   *
+   */
+  public readonly dataTypes = {
+    [DATA_TYPES.LISTING]: async (props: { pathVariables: any; routeType: any; slug?: any }) => {
+      // console.dir(`📦️ [@jeromefitz/notion] => ${DATA_TYPES.LISTING}`)
+      return await getNotionListing({
+        ...props,
+        config: this.#config,
+        getBlocksByIdChildren: this.custom.getBlocksByIdChildren,
+        getDatabasesByIdQuery: this.custom.getDatabasesByIdQuery,
+        getPagesById: this.custom.getPagesById,
+      });
+    },
+
+    [DATA_TYPES.LISTING_BY_DATE]: async (props: {
+      pathVariables: any;
+      routeType: any;
+      slug: any;
+    }) => {
+      // console.dir(`📦️ [@jeromefitz/notion] => ${DATA_TYPES.LISTING_BY_DATE}`)
+      return await getNotionListingByDate({
+        ...props,
+        config: this.#config,
+        getBlocksByIdChildren: this.custom.getBlocksByIdChildren,
+        getDatabasesByIdQuery: this.custom.getDatabasesByIdQuery,
+        getPagesById: this.custom.getPagesById,
+      });
+    },
+
+    [DATA_TYPES.SLUG]: async (props: { pathVariables: any; routeType: any; slug: any }) => {
+      // console.dir(`📦️ [@jeromefitz/notion] => ${DATA_TYPES.SLUG}`)
+      return await getNotionSlug({
+        ...props,
+        config: this.#config,
+        getBlocksByIdChildren: this.custom.getBlocksByIdChildren,
+        getDatabasesByIdQuery: this.custom.getDatabasesByIdQuery,
+        getDeepFetchAllChildren: this.custom.getDeepFetchAllChildren,
+      });
+    },
+
+    [DATA_TYPES.SLUG_BY_ROUTE]: async (props: {
+      pathVariables: any;
+      routeType: any;
+      slug: any;
+    }) => {
+      // console.dir(`📦️ [@jeromefitz/notion] => ${DATA_TYPES.SLUG_BY_ROUTE}`)
+      return await getNotionSlugByRoute({
+        ...props,
+        config: this.#config,
+        getBlocksByIdChildren: this.custom.getBlocksByIdChildren,
+        getDatabasesByIdQuery: this.custom.getDatabasesByIdQuery,
+        getQuery: this.custom.getQuery,
+      });
+    },
+  };
+
+  // public constructor(options?: ClientOptions) {
+  public constructor(options?: any) {
+    super(options);
+    this.#config = options?.config;
+  }
+}
+
+export type { ClientProps, CredentialProps };
+export { Client };

package/src/queries/get-blocks-by-id-children/index.ts

@@ -0,0 +1,12 @@
+import { avoidRateLimit, isUndefined } from "@jeromefitz/utils";
+
+// @todo(types)
+const getBlocksByIdChildren = async ({ block_id, getBlocksChildrenList }) => {
+  if (isUndefined(block_id)) return [];
+  await avoidRateLimit(0);
+  return await getBlocksChildrenList({
+    block_id,
+  });
+};
+
+export default getBlocksByIdChildren;

package/src/queries/get-databases-by-id-query/index.ts

@@ -0,0 +1,28 @@
+import { PROPERTIES } from "../../constants/index";
+import type { SortMock } from "../../schema/index";
+
+const sortDefault: SortMock = {
+  sorts: [
+    {
+      direction: "ascending",
+      property: PROPERTIES.slug.notion,
+    },
+  ],
+};
+
+// @todo(types)
+const getDatabasesByIdQuery = async ({
+  database_id,
+  filter = sortDefault?.filter,
+  getDatabasesQuery,
+  sorts = sortDefault?.sorts,
+}) => {
+  if (!database_id) return [];
+  return await getDatabasesQuery({
+    database_id,
+    filter,
+    sorts,
+  });
+};
+
+export default getDatabasesByIdQuery;

package/src/queries/get-deep-fetch-all-children/index.ts

@@ -0,0 +1,35 @@
+const getDeepFetchAllChildren = async ({
+  blocks,
+  getBlocksChildrenList,
+}): Promise<Array<any | any[]>> => {
+  if (blocks === null || blocks === undefined) return blocks;
+  const fetchChildrenMap = blocks
+    .filter((block: { has_children: any }) => block.has_children)
+    .map((parent_block: { id: string }) => {
+      const { id: block_id } = parent_block;
+      return {
+        parent_block,
+        promise: getBlocksChildrenList({
+          block_id,
+          page_size: 100,
+        }),
+      };
+    });
+
+  const results = await Promise.all<any>(fetchChildrenMap.map((value) => value.promise));
+
+  for (let i = 0; i < results.length; i++) {
+    const blocks = results[i].results;
+    await getDeepFetchAllChildren({
+      blocks,
+      getBlocksChildrenList,
+    });
+    if (fetchChildrenMap[i]) {
+      const parent: any = fetchChildrenMap[i].parent_block;
+      parent[parent.type].children = blocks;
+    }
+  }
+  return blocks;
+};
+
+export default getDeepFetchAllChildren;

package/src/queries/get-info-type/index.ts

@@ -0,0 +1,40 @@
+const getInfoType = ({ config, item, meta, routeType }) => {
+  const { NOTION } = config;
+
+  let date = "";
+  const slug = item.properties?.slug;
+
+  let as = "";
+  const href = `/[...catchAll]`;
+
+  switch (routeType) {
+    case NOTION.BLOG.routeType:
+    case NOTION.EVENTS.routeType:
+      date = item.properties[NOTION[routeType.toUpperCase()].infoType.key]?.start.slice(0, 10);
+      // oxlint-disable-next-line no-unsafe-optional-chaining
+      const [year, month, day] = date?.split("-");
+      as = `/${routeType}/${year}/${month}/${day}/${slug}`;
+      break;
+    case NOTION.EPISODES.routeType:
+      as = `/${meta?.join("/")}/${slug}`;
+      break;
+    // case NOTION.PODCASTS.routeType:
+    // case NOTION.PEOPLE.routeType:
+    // case NOTION.SHOWS.routeType:
+    // case NOTION.VENUES.routeType:
+    default:
+      as = `/${routeType}/${slug}`;
+      break;
+  }
+
+  as = as.replace("//", "/");
+
+  return {
+    as,
+    date,
+    href,
+    slug,
+  };
+};
+
+export default getInfoType;

package/src/queries/get-notion-listing/index.ts

@@ -0,0 +1,91 @@
+import { sortObject } from "@jeromefitz/utils";
+import { map as _map, omit as _omit } from "lodash-es";
+
+import { PROPERTIES } from "../../constants/index";
+import { dataNormalized } from "../../utils/index";
+
+const getNotionListing = async ({
+  config,
+  getBlocksByIdChildren,
+  getDatabasesByIdQuery,
+  getPagesById,
+  pathVariables,
+  routeType,
+}) => {
+  const { NOTION } = config;
+
+  let info: any = {};
+
+  const page_id = NOTION[routeType.toUpperCase()].page_id__seo;
+  const _info = await getPagesById({
+    page_id,
+  });
+  // @refactor(404)
+  if (!_info) {
+    return {};
+  }
+  if (_info?.object === "page") {
+    info = _omit(_info, "properties");
+    info.properties = sortObject(
+      dataNormalized({ config, data: _info, pageId: info.id, pathVariables }),
+    );
+  }
+
+  const property =
+    NOTION[routeType.toUpperCase()].infoType.notion ?? PROPERTIES.datePublished.notion;
+
+  /**
+   * @todo Can we make the date dynamic?
+   * This can be considered the date you want to go back in time to on build.
+   * Can be construed as the website creation date, too I guess.
+   *
+   * For those routeTypes that do not go off of datePublished,
+   *  we want to get their listing by the current date.
+   *
+   * ex) /events => Only want events that are in the future.
+   *
+   */
+  const timestamp =
+    property === PROPERTIES.datePublished.notion
+      ? new Date("2020-01-01").toISOString()
+      : new Date().toISOString();
+
+  const content = await getBlocksByIdChildren({ block_id: info.id });
+  const _items: any = await getDatabasesByIdQuery({
+    database_id: NOTION[routeType.toUpperCase()].database_id,
+    filter: {
+      and: [
+        {
+          date: {
+            on_or_after: timestamp,
+          },
+          property,
+        },
+      ],
+    },
+  });
+  const results: any[] = [];
+  _map(_items.results, (item) => {
+    let itemInit = item;
+    itemInit = _omit(itemInit, "properties");
+    itemInit.properties = sortObject(
+      dataNormalized({ config, data: item, pageId: item.id, pathVariables }),
+    );
+    results.push(itemInit);
+    // console.dir(`> last_edited_time`)
+    // console.dir(item.id)
+    // console.dir(item.last_edited_time)
+    // console.dir(`---`)
+  });
+  const items = _omit(_items, "results");
+  items.results = results;
+
+  /**
+   * @note(plaiceholder)
+   *
+   * Pass empty `images` object for SSR/API takeover
+   */
+  return { content, images: {}, info, items };
+};
+
+export default getNotionListing;

package/src/queries/get-notion-listing-by-date/index.ts

@@ -0,0 +1,190 @@
+import { sortObject } from "@jeromefitz/utils";
+import { map as _map, omit as _omit, size as _size } from "lodash-es";
+
+import { PROPERTIES, QUERIES } from "../../constants/index";
+import type { SortItem } from "../../schema/index";
+import { addTime, dataNormalized } from "../../utils/index";
+
+const getNotionListingByDate__getFilter = ({ config, pathVariables, routeType, slug }) => {
+  const { NOTION } = config;
+  const { meta } = pathVariables;
+  const [year, month, day] = meta;
+  const metaCount = _size(meta);
+  // @hack nothing to see here, haha
+  const dateTimestamp = new Date().toISOString();
+  const timestampQuery = new Date(
+    `${year ? year : dateTimestamp.slice(0, 4)}-${month ? month : "01"}-${day ? day : "01"}`,
+  );
+
+  /**
+   * @filter
+   * @note metaCount breakdown:
+   * 1 = yyyy
+   * 2 = yyyy/mm
+   * 3 = yyyy/mm/dd
+   * ? = yyyy/mm/dd/slug (SLUG_BY_ROUTE takes this over)
+   */
+  const property =
+    NOTION[routeType.toUpperCase()]?.infoType?.notion ?? PROPERTIES.datePublished.notion;
+
+  switch (metaCount) {
+    /**
+     * @note yyyy
+     */
+    case 1:
+      return {
+        and: [
+          {
+            date: {
+              on_or_after: addTime(timestampQuery, ""),
+            },
+            property,
+          },
+          {
+            date: {
+              before: addTime(timestampQuery, "year"),
+            },
+            property,
+          },
+        ],
+      };
+
+    /**
+     * @note yyyy/mm
+     */
+    case 2:
+      return {
+        and: [
+          {
+            date: {
+              on_or_after: addTime(timestampQuery, ""),
+            },
+            property,
+          },
+          {
+            date: {
+              before: addTime(timestampQuery, "month"),
+            },
+            property,
+          },
+        ],
+      };
+
+    /**
+     * @note yyyy/mm/dd
+     */
+    case 3:
+      return {
+        and: [
+          {
+            date: {
+              on_or_after: addTime(timestampQuery, ""),
+            },
+            property,
+          },
+          {
+            date: {
+              before: addTime(timestampQuery, "day"),
+            },
+            property,
+          },
+        ],
+      };
+
+    /**
+     * @note yyyy/mm/dd/slug
+     *
+     * Technically this is picked up by `getNotionSlugByRoute` SLUG_BY_ROUTE
+     */
+    default:
+      return {
+        and: [
+          {
+            date: {
+              on_or_after: addTime(timestampQuery, ""),
+            },
+            property,
+          },
+          {
+            date: {
+              before: addTime(timestampQuery, "day"),
+            },
+            property,
+          },
+          {
+            ...QUERIES.slug,
+            rich_text: { equals: slug },
+          },
+        ],
+      };
+  }
+};
+
+const getNotionListingByDate = async ({
+  config,
+  getBlocksByIdChildren,
+  getDatabasesByIdQuery,
+  getPagesById,
+  pathVariables,
+  routeType,
+  slug,
+}) => {
+  const { NOTION } = config;
+
+  let content: any = {},
+    info: any = {};
+
+  const page_id = NOTION[routeType.toUpperCase()].page_id__seo;
+  const _info = await getPagesById({
+    page_id,
+  });
+  if (_info.object === "page") {
+    info = _omit(_info, "properties");
+    info.properties = sortObject(
+      dataNormalized({ config, data: _info, pageId: _info.id, pathVariables }),
+    );
+  }
+
+  content = await getBlocksByIdChildren({ block_id: info.id });
+
+  const sorts: SortItem[] = [
+    {
+      direction: "descending",
+      property: PROPERTIES.datePublished.notion,
+    },
+  ];
+  const filter = getNotionListingByDate__getFilter({
+    config,
+    pathVariables,
+    routeType,
+    slug,
+  });
+
+  const database_id = NOTION[routeType.toUpperCase()].database_id;
+
+  const ___items: any = await getDatabasesByIdQuery({
+    database_id,
+    filter,
+    sorts,
+  });
+  const __items: any[] = [];
+  _map(___items.results, (i) => {
+    const item = _omit(i, "properties");
+    item.properties = sortObject(
+      dataNormalized({ config, data: i, pageId: item.id, pathVariables }),
+    );
+    !!item && __items.push(item);
+  });
+  const _items = _omit(___items, "results");
+  _items.results = __items;
+  const items = _omit(_items, "data");
+
+  /**
+   * @note(plaiceholder)
+   *
+   * Pass empty `images` object for SSR/API takeover
+   */
+  return { content, images: {}, info, items };
+};
+
+export default getNotionListingByDate;

package/src/queries/get-notion-slug/index.ts

@@ -0,0 +1,64 @@
+import { sortObject } from "@jeromefitz/utils";
+import { omit as _omit } from "lodash-es";
+
+import { QUERIES } from "../../constants/index";
+import { dataNormalized } from "../../utils/index";
+
+const getNotionSlug = async ({
+  config,
+  getBlocksByIdChildren,
+  getDatabasesByIdQuery,
+  getDeepFetchAllChildren,
+  pathVariables,
+  routeType,
+  slug,
+}) => {
+  const { NOTION } = config;
+
+  const DB_TYPE = routeType?.toUpperCase();
+  const isValid = Object.keys(NOTION).includes(DB_TYPE);
+
+  if (!isValid) return { content: {}, images: {}, info: {}, items: {} };
+
+  const __info: any = await getDatabasesByIdQuery({
+    database_id: NOTION[DB_TYPE].database_id,
+    filter: {
+      and: [
+        {
+          ...QUERIES.slug,
+          rich_text: { equals: slug },
+        },
+      ],
+    },
+  });
+
+  const _info = __info?.object === "list" && __info.results[0];
+  // @refactor(404)
+  if (!_info) {
+    return {};
+  }
+
+  const info = _omit(_info, "properties");
+  info.properties = sortObject(
+    dataNormalized({ config, data: _info, pageId: info.id, pathVariables }),
+  );
+
+  const _content = await getBlocksByIdChildren({ block_id: info.id });
+  const blocks = [...(await getDeepFetchAllChildren({ blocks: _content.results }))];
+  const content = blocks;
+
+  /**
+   * @question if this is reached, there are no `items`
+   */
+  // const items: any = {}
+  // items.results = _filter(items?.results, { properties: { isPublished: true } })
+
+  /**
+   * @note(plaiceholder)
+   *
+   * Pass empty `images` object for SSR/API takeover
+   */
+  return { content, images: {}, info, items: {} };
+};
+
+export default getNotionSlug;