@jeromefitz/notion 6.1.0 → 6.2.0-canary.1

package/src/schema/index.ts

@@ -0,0 +1,386 @@
+type Blog = Record<string, BlogPost>;
+
+type BlogPost = Default;
+type DatabaseInfo = Partial<
+  Record<
+    DatabaseType,
+    {
+      active: boolean;
+      database_id: string;
+      dataTypes: DataTypes[];
+      // @todo(next-notion) move to `isChild`
+      hasChild: null | string;
+      infoType: any;
+      isChild: null | string;
+      isChildInfoType: any | null;
+      name: string;
+      page_id__seo: string;
+      routeMeta: boolean;
+      routeType: string;
+      skipStaticPaths: boolean;
+      slug: string;
+      ttl: number;
+    }
+  >
+>;
+
+type Databases = Record<DatabaseType, DatabaseType>;
+
+type DatabaseType =
+  | "BLOG"
+  | "BOOKS"
+  | "EPISODES"
+  | "EVENTS"
+  | "PAGES"
+  | "PEOPLE"
+  | "PODCASTS"
+  | "SEO"
+  | "SHOWS"
+  | "VENUES";
+
+type DataTypes = "LISTING" | "LISTING_BY_DATE" | "SLUG" | "SLUG_BY_ROUTE";
+
+type DataTypesObject = Record<DataTypes, DataTypes>;
+interface Default {
+  // authors: any
+  dateCreated?: any;
+  dateEdited?: any;
+  datePublished: any;
+  isIndexed: any;
+  isPublished: any;
+  seoDescription: any;
+  seoImage: any;
+  seoImageDescription: any;
+  seoKeywords: any;
+  slug: any;
+  title: any;
+}
+type Direction = "ascending" | "descending";
+
+interface Episode extends Default {
+  dateRecorded: any;
+  duration: any;
+  episode: any;
+  mp3: any;
+  relationEpisodes__People_Guest: any;
+  relationEpisodes__People_Sound_Engineer: any;
+  relationEpisodes__People_Thanks: any;
+  relationEpisodes__Podcasts: any;
+  relationEpisodes__Venues: any;
+  // rollupEpisodes__People_Thanks: any
+  rollupEpisodes__Podcasts: any;
+  // rollupEpisodes__People_Guest: any
+  // rollupEpisodes__People_Sound_Engineer: any
+  rollupEpisodes__PodcastsSlugs: any;
+  season: any;
+  // rollupEpisodes__Venues: any
+  socialApple: any;
+  socialSpotify: any;
+  type: any;
+}
+
+type Episodes = Record<string, Episode>;
+
+interface Event extends Default {
+  dateEvent: any;
+  relationEvents__People_Guest: any;
+  relationEvents__People_Guest_Music: any;
+  relationEvents__People_Host: any;
+  relationEvents__Shows: any;
+  relationEvents__Shows_Lineup: any;
+  relationEvents__Venues: any;
+  rollupEvents__People_Cast: any;
+  rollupEvents__People_Guest: any;
+  rollupEvents__People_Guest_Music: any;
+  rollupEvents__People_Host: any;
+  rollupEvents__Shows: any;
+  rollupEvents__Shows_Lineup: any;
+  rollupEvents__Venues: any;
+  rollupLineup: any;
+  rollupTags: any;
+  rollupTagsSecondary: any;
+  socialFacebook: any;
+  socialWebsite: any;
+  ticketUrl: any;
+}
+
+type Events = Record<string, Event>;
+
+interface NotionAnnotations {
+  bold: boolean;
+  code: boolean;
+  color: string;
+  italic: boolean;
+  strikethrough: boolean;
+  underline: boolean;
+}
+interface NotionBlock {
+  created_time: string;
+  has_children: string;
+  //
+  heading_1?: NotionText[];
+  heading_2?: NotionText[];
+  heading_3?: NotionText[];
+  heading_4?: NotionText[];
+  heading_5?: NotionText[];
+  heading_6?: NotionText[];
+  id: string;
+  image?: NotionImage;
+  last_edited_time: string;
+  object: string;
+  paragraph?: NotionText[];
+  type: string;
+}
+
+interface NotionImage {
+  caption?: NotionText;
+  external?: NotionUrl;
+  file?: NotionUrl;
+  type: string;
+}
+interface NotionText {
+  annotations: NotionAnnotations;
+  href: null | string;
+  plain_text: string;
+  text: NotionTextContent;
+  type: string;
+}
+interface NotionTextContent {
+  content: string;
+  link: null | string;
+}
+interface NotionUrl {
+  url: string;
+}
+
+type Page = Default;
+type Pages = Record<string, Page>;
+type People = Record<string, Person>;
+interface Person extends Default {
+  email: any;
+  nameFirst: any;
+  nameLast: any;
+  namePreferred: any;
+  relationPeople__Episodes_Guest: any;
+  relationPeople__Episodes_Sound_Engineer: any;
+  relationPeople__Episodes_Thanks: any;
+  relationPeople__Events_Guest: any;
+  relationPeople__Events_Guest_Music: any;
+  relationPeople__Events_Host: any;
+  relationPeople__Podcasts_Host: any;
+  relationPeople__Podcasts_Sound_Engineer: any;
+  relationPeople__Shows_Cast: any;
+  relationPeople__Shows_Cast_Past: any;
+  relationPeople__Shows_Director: any;
+  relationPeople__Shows_Director_Musical: any;
+  relationPeople__Shows_Director_Technical: any;
+  relationPeople__Shows_Producer: any;
+  relationPeople__Shows_Thanks: any;
+  relationPeople__Shows_Writer: any;
+}
+interface Podcast extends Default {
+  categories: any;
+  explicit: any;
+  podcastAuthor: any;
+  podcastAuthorEmail: any;
+  relationPodcasts__Episodes: any;
+  relationPodcasts__People_Host: any;
+  relationPodcasts__People_Sound_Engineer: any;
+  rollupPodcasts__Episodes: any;
+  rollupPodcasts__EpisodesSlugs: any;
+  socialApple: any;
+  socialSpotify: any;
+  type: any;
+}
+type Podcasts = Record<string, Podcast>;
+
+interface Property {
+  format?:
+    | "baht"
+    | "canadian_dollar"
+    | "chilean_peso"
+    | "colombian_peso"
+    | "danish_krone"
+    | "dirham"
+    | "dollar"
+    | "euro"
+    | "forint"
+    | "franc"
+    | "hong_kong_dollar"
+    | "koruna"
+    | "krona"
+    | "leu"
+    | "lira"
+    | "mexican_peso"
+    | "new_taiwan_dollar"
+    | "new_zealand_dollar"
+    | "norwegian_krone"
+    | "number"
+    | "number_with_commas"
+    | "percent"
+    | "philippine_peso"
+    | "pound"
+    | "rand"
+    | "real"
+    | "ringgit"
+    | "riyal"
+    | "ruble"
+    | "rupee"
+    | "rupiah"
+    | "shekel"
+    | "won"
+    | "yen"
+    | "yuan"
+    | "zloty";
+  init: boolean;
+  key: string;
+  notion: string;
+  relation?: Relation;
+  rollup?: Rollup;
+  type:
+    | "checkbox"
+    | "created_by"
+    | "created_time"
+    | "date"
+    | "email"
+    | "files"
+    | "formula"
+    | "last_edited_by"
+    | "last_edited_time"
+    | "multi_select"
+    | "number"
+    | "people"
+    | "phone_number"
+    | "relation"
+    | "rich_text"
+    | "rollup"
+    | "select"
+    | "title"
+    | "url";
+}
+interface Relation {
+  database_id: string;
+  synced_property_id?: string;
+  synced_property_name: string;
+}
+interface Rollup {
+  function?: RollupFunction;
+  relation_property_id?: string;
+  relation_property_name?: string;
+  rollup_property_id?: string;
+  rollup_property_name?: string;
+}
+type RollupFunction =
+  | "average"
+  | "count_all"
+  | "count_empty"
+  | "count_not_empty"
+  | "count_unique_values"
+  | "count_values"
+  | "max"
+  | "median"
+  | "min"
+  | "percent_empty"
+  | "percent_not_empty"
+  | "range"
+  | "show_original"
+  | "sum";
+
+type Seo = Record<string, SeoPost>;
+type SeoPost = Default;
+
+interface Show extends Default {
+  relationShows__Events: any;
+  relationShows__Events_Lineup: any;
+  relationShows__People_Cast: any;
+  relationShows__People_Cast_Past: any;
+  relationShows__People_Crew: any;
+  relationShows__People_Director: any;
+  relationShows__People_Director_Musical: any;
+  relationShows__People_Director_Technical: any;
+  relationShows__People_Producer: any;
+  relationShows__People_Thanks: any;
+  relationShows__People_Writer: any;
+  relationShows__Tags: any;
+  rollupShows__People_Cast: any;
+  rollupShows__People_Cast_Past: any;
+  rollupShows__People_Cast_Slug: any;
+  rollupShows__People_Crew: any;
+  rollupShows__People_Director: any;
+  rollupShows__People_Director_Musical: any;
+  rollupShows__People_Director_Technical: any;
+  rollupShows__People_Music: any;
+  rollupShows__People_Producer: any;
+  rollupShows__People_Thanks: any;
+  rollupShows__People_Writer: any;
+  rollupShows__Tags: any;
+  socialFacebook: string;
+  socialInstagram: string;
+  socialTwitter: string;
+  socialWebsite: string;
+}
+
+type Shows = Record<string, Show>;
+
+interface SortItem {
+  direction: Direction;
+  property: string;
+}
+
+interface SortMock {
+  filter?: any[];
+  sorts: SortItem[];
+}
+
+interface Venue extends Default {
+  addressCity: any;
+  addressLatitude: any;
+  addressLongitude: any;
+  addressNeighborhood: any;
+  addressState: any;
+  addressStreet: any;
+  addressZipCode: any;
+  phoneNumber: any;
+  relationVenues__Episodes: any;
+  relationVenues__Events: any;
+  socialFacebook: any;
+  socialInstagram: any;
+  socialTwitter: any;
+  socialWebsite: any;
+}
+
+type Venues = Record<string, Venue>;
+
+export type {
+  Blog,
+  BlogPost,
+  DatabaseInfo,
+  Databases,
+  DatabaseType,
+  DataTypes,
+  DataTypesObject,
+  Direction,
+  Episode,
+  Episodes,
+  Event,
+  Events,
+  NotionBlock,
+  NotionText,
+  Page,
+  Pages,
+  People,
+  Person,
+  Podcast,
+  Podcasts,
+  Property,
+  Rollup,
+  RollupFunction,
+  Seo,
+  SeoPost,
+  Show,
+  Shows,
+  SortItem,
+  SortMock,
+  Venue,
+  Venues,
+};

package/src/utils/add-time/index.ts

@@ -0,0 +1,16 @@
+import { addDays as _addDays, addMonths as _addMonths, addYears as _addYears } from "date-fns";
+
+const addTime = (date, type) => {
+  switch (type) {
+    case "day":
+      // @hack the TimeZone to UTC is ... not great.
+      return _addDays(date, 2).toISOString();
+    case "month":
+      return _addMonths(date, 1).toISOString();
+    case "year":
+      return _addYears(date, 1).toISOString();
+  }
+  return _addDays(date, -1).toISOString();
+};
+
+export default addTime;

package/src/utils/data-normalized/index.ts

@@ -0,0 +1,49 @@
+import { map as _map } from "lodash-es";
+
+import { LOOKUP, PROPERTIES_LOOKUP } from "../../constants/index";
+import { getTypes } from "../../utils/index";
+
+/**
+ * @todo(notion)
+ *
+ * Refactor to remove `config` as a parameter, or move this to `queries`
+ */
+// oxlint-disable-next-line complexity
+const dataNormalized = ({ config, data, pageId, pathVariables }) => {
+  const { NOTION } = config;
+  const DATA_NORMALIZED = {};
+  if (!data?.properties) return DATA_NORMALIZED;
+  const { properties } = data;
+
+  // @hack(notion) not great
+  let routeType = "";
+  if (pathVariables) {
+    const { meta, routeType: _routeType } = pathVariables;
+    routeType =
+      _routeType === NOTION?.PODCASTS?.routeType && meta.length > 1
+        ? NOTION?.EPISODES?.routeType
+        : _routeType;
+  }
+
+  const items = routeType ? LOOKUP[routeType.toUpperCase()] : PROPERTIES_LOOKUP;
+
+  _map(items, (item) => {
+    let dataToNormalize: any;
+
+    const dataFromNotion = properties[item.notion];
+    /**
+     * @note(notion)
+     * ensure key populates in api
+     * only populate w/ data if exists in notion
+     */
+    DATA_NORMALIZED[item.key] = null;
+    if (dataFromNotion) {
+      dataToNormalize = getTypes[item.type](dataFromNotion, pageId);
+      DATA_NORMALIZED[item.key] = dataToNormalize ? dataToNormalize : null;
+    }
+  });
+
+  return DATA_NORMALIZED;
+};
+
+export default dataNormalized;

package/src/utils/data-normalized-results/index.ts

@@ -0,0 +1,29 @@
+import { sortObject } from "@jeromefitz/utils";
+import { map as _map, omit as _omit } from "lodash-es";
+
+import { dataNormalized } from "../../utils/index";
+
+/**
+ * @todo(notion)
+ *
+ * Refactor after `dataNormalized` to remove `config` as a parameter,
+ *  or move this to `queries`
+ */
+const dataNormalizedResults = ({ config, results, routeType }) => {
+  const normalizedResults: any[] = [];
+  _map(results, (result) => {
+    const normalizedResult = _omit(result, "properties");
+    normalizedResult.properties = sortObject(
+      dataNormalized({
+        config,
+        data: result,
+        pageId: result?.id,
+        pathVariables: routeType,
+      }),
+    );
+    normalizedResults.push(normalizedResult);
+  });
+  return normalizedResults;
+};
+
+export default dataNormalizedResults;

package/src/utils/get-data-type/index.ts

@@ -0,0 +1,62 @@
+import { DATA_TYPES } from "../../constants/index";
+
+/**
+ * @info dataType
+ *       pathVariables via `../../queries/pathVariables`
+ *
+ * 1 = (isPage) DATA_TYPES.SLUG
+ * ex) /about
+ *     /colophon
+ *     /contact
+ *     => routeType = pages
+ *     @note no ability for second tier at the moment for non-db
+ *           otherwise these would have to be `/pages/about`
+ *
+ * 2 = (isIndex && !hasMeta) DATA_TYPES.LISTING
+ * ex) /blog
+ *     /events
+ *     /podcasts
+ *     => routeType = routeType
+ *        @note
+ *          - events should only be "upcoming events"
+ *          - blog should be all-time (handled by pagination)
+ *
+ * 3 = (isIndex && hasMeta) DATA_TYPES.LISTING_BY_DATE
+ * ex) /blog/yyyy
+ *     /blog/yyyy/mm
+ *     /blog/yyyy/mm/dd
+ *     /events/yyyy
+ *     /events/yyyy/mm
+ *     /events/yyyy/mm/dd
+ *     => routeType = routeType
+ *        @note These are each `index` pages for certain routeTypes
+ *
+ * 4 = (hasMeta) DATA_TYPES.SLUG_BY_ROUTE
+ * ex) /blog/yyyy/mm/dd/[slug]
+ *       => parentRouteType = blog
+ *       => routeType = blog
+ *          @note determine [yyyy-mm-dd] from data via slug
+ *     /events/yyyy/mm/dd/[slug],
+ *       => parentRouteType = events
+ *       => routeType = events
+ *          @note determine [yyyy-mm-dd] from data via slug
+ *     /podcasts/[podcasts-slug]/[slug]
+ *       => parentRouteType = podcasts
+ *       => routeType = episodes
+ *          @note determine [podcasts-slug] from data via slug
+ *
+ * 5 = (else) DATA_TYPES.SLUG
+ * ex) /shows/[slug]
+ *     /events/yyyy/mm/dd/[slug]
+ *     /podcasts/[slug]
+ *
+ */
+const getDataType = ({ hasMeta, isIndex, isPage }) => {
+  if (isPage) return DATA_TYPES.SLUG;
+  if (isIndex && !hasMeta) return DATA_TYPES.LISTING;
+  if (isIndex && hasMeta) return DATA_TYPES.LISTING_BY_DATE;
+  if (hasMeta) return DATA_TYPES.SLUG_BY_ROUTE;
+  return DATA_TYPES.SLUG;
+};
+
+export default getDataType;

package/src/utils/get-title/index.ts

@@ -0,0 +1,21 @@
+import { last as _last } from "lodash-es";
+
+/**
+ * @note this should be in the website repo as it’s custom
+ * *cough* more custom than _waves vaguely all-around_ all of this
+ */
+const getTitle = (title: string) => {
+  const _title: string = _last(title.split("_")) ?? "";
+
+  // oxlint-disable-next-line no-extra-boolean-cast
+  if (!!_title) {
+    return _title
+      .replace("Past", "Cast Emeritus")
+      .replace("Musical", "Musical Director")
+      .replace("Technical", "Technical Director");
+  }
+
+  return _title;
+};
+
+export default getTitle;

package/src/utils/get-types/_unsupported.ts

@@ -0,0 +1,7 @@
+const _unsupported = (data: any) => {
+  console.dir(`@notion(_unsupported)`);
+  // console.dir(data)
+  return data;
+};
+
+export default _unsupported;

package/src/utils/get-types/checkbox.ts

@@ -0,0 +1,3 @@
+const checkbox = (data: any) => data.checkbox || false;
+
+export default checkbox;

package/src/utils/get-types/date.ts

@@ -0,0 +1,6 @@
+const date = (data: any) => {
+  const { type } = data;
+  return data[type];
+};
+
+export default date;

package/src/utils/get-types/email.ts

@@ -0,0 +1,3 @@
+const email = (data: any) => data.email || null;
+
+export default email;

package/src/utils/get-types/files.ts

@@ -0,0 +1,67 @@
+import { stringToUUID } from "@jeromefitz/utils";
+import Slugger from "github-slugger";
+import { size as _size } from "lodash-es";
+
+const notionImageHosted = `https://www.notion.so/image/{{FILENAME}}?table=block&id={{PAGE_ID}}&cache=v2&w1dth=600`;
+
+const getNotionHostedUrl = (url: boolean | number | string, pageId: string) =>
+  notionImageHosted
+    .replace("{{FILENAME}}", encodeURIComponent(url))
+    .replace("{{PAGE_ID}}", stringToUUID(pageId));
+
+const files = (data: any, pageId: string) => {
+  const slugger = new Slugger();
+  const _files = {};
+
+  if (_size(data.files) <= 0) return _files;
+  // oxlint-disable-next-line complexity
+  data.files.map((file: { external: { url: string }; file: { url: string }; type: string }) => {
+    if (file?.type === "file") {
+      const internalUrl = file?.file?.url.split("?")[0];
+      const internalSlug = slugger.slug(internalUrl);
+      /**
+       * @note(plaiceholder)
+       *
+       * Do not handle here.
+       */
+      // const { base64: internalBase64, img: internalImg } = await getPlaiceholder(
+      //   internalUrl
+      // )
+      _files[internalSlug] = {
+        type: file?.type,
+        url: getNotionHostedUrl(internalUrl, pageId),
+        // base64: internalBase64,
+        // img: internalImg,
+      };
+    }
+    if (file?.type === "external") {
+      const externalUrl = file?.external?.url.split("?")[0];
+      const externalSlug = slugger.slug(externalUrl);
+      /**
+       * @note(plaiceholder)
+       *
+       * Do not handle here.
+       */
+      // const { base64: externalBase64, img: externalImg } = await getPlaiceholder(
+      //   externalUrl
+      // )
+      _files[externalSlug] = {
+        type: file?.type,
+        url: externalUrl,
+        // base64: externalBase64,
+        // img: externalImg,
+      };
+    }
+    // if (file?.type === 'image') {
+    //   const externalUrl = file?.external?.url.split('?')[0]
+    //   const externalSlug = slugger.slug(externalUrl)
+    //   _files[externalSlug] = { type: file?.type, url: externalUrl }
+    // }
+
+    // return
+  });
+
+  return _files;
+};
+
+export default files;

package/src/utils/get-types/index.ts

@@ -0,0 +1,41 @@
+import _unsupported from "./_unsupported";
+import checkbox from "./checkbox";
+import date from "./date";
+import email from "./email";
+import files from "./files";
+// import images from './images'
+import multi_select from "./multi-select";
+import number from "./number";
+import people from "./people";
+import phone_number from "./phone-number";
+import relation from "./relation";
+import rich_text from "./rich-text";
+import rollup from "./rollup";
+import select from "./select";
+import title from "./title";
+import url from "./url";
+
+const getTypes = {
+  checkbox,
+  created_by: _unsupported,
+  created_time: date,
+  date,
+  email,
+  files,
+  formula: _unsupported,
+  image: files,
+  last_edited_by: _unsupported,
+  last_edited_time: date,
+  multi_select,
+  number,
+  people,
+  phone_number,
+  relation,
+  rich_text,
+  rollup,
+  select,
+  title,
+  url,
+};
+
+export default getTypes;