@notifiles/sdk 1.0.0

package/src/template/consolidate/path.js

@@ -0,0 +1,18 @@
+import perform from './lib/perform.js'
+import getEntries from '../../lib/entries/getAtPath.js'
+
+export default async ({
+  path,
+  settings
+}) => {
+  let entries = await getEntries({
+    path,
+  })
+
+  for (var i in entries) {
+    const entry = entries[i]
+    await perform({ entry, settings })
+  }
+
+  return true
+}

package/src/template/consolidate/path.test.js

@@ -0,0 +1,14 @@
+describe.skip('consolidate', () => {
+  test('consolidate', async () => {
+    const fsPath = (await import('path')).default
+    let path = fsPath.resolve(process.env.TEST_MOCK_FOLDER)
+    const operation = (await import('./path.js')).default
+
+    const result = await operation({
+      settings: {
+      },
+      path,
+    })
+    expect(result).toBeTruthy()
+  })
+})

package/src/template/format/entry.js

@@ -0,0 +1,57 @@
+
+export default async ({
+  entry,
+  settings = {},
+}) => {
+  const { email, path, i18n = {} } = entry
+  let _i18n = i18n
+  if (!_i18n[settings.defaultLocale]) {
+    _i18n[settings.defaultLocale] = {}
+  }
+
+  const keys = Object.keys(_i18n)
+  const versions = keys.map(language => {
+    const code = language
+    return {
+      ...entry,
+      language: {
+        code,
+        data: _i18n[language]
+      },
+      code,
+      buildPaths: {
+        email: {
+          container: `${path}/.build/email/${code}`,
+          body: `${path}/.build/email/${code}/body.html`,
+          bodyFileName: `${entry.slug}/email/${code}/body.html`,
+          text: `${path}/.build/email/${code}/text.txt`,
+          textFileName: `${entry.slug}/email/${code}/text.txt`,
+          subject: `${path}/.build/email/${code}/subject.txt`,
+          subjectFileName: `${entry.slug}/email/${code}/subject.txt`,
+          assetsContainer: `${entry.slug}/email/${code}/assets`,
+          attachmentsContainer: `${entry.slug}/email/${code}/attachments`,
+          manifestFileNameBuilt: `${path}/.build/email/${code}/manifest.json`,
+          manifestFileName: `${entry.slug}/email/${code}/manifest.json`,
+        },
+        textMessage: {
+          container: `${path}/.build/textmessage/${code}`,
+          text: `${path}/.build/textmessage/${code}/textmessage.txt`,
+          textFileName: `${entry.slug}/textmessage/${code}/textmessage.txt`,
+          assetsContainer: `${entry.slug}/textmessage/${code}/assets`,
+          manifestFileNameBuilt: `${path}/.build/textmessage/${code}/manifest.json`,
+          manifestFileName: `${entry.slug}/textmessage/${code}/manifest.json`,
+        },
+        manifestFileNameBuilt: `${path}/.build/manifest.json`,
+        manifestFileName: `${entry.slug}/manifest.json`,
+        activityPath: `${path}/.activity.json`,
+      }
+    }
+  })
+
+  return {
+    entry: {
+      ...entry,
+      versions
+    }
+  }
+}

package/src/template/format/index.js

@@ -0,0 +1,2 @@
+export { default as processEntry } from './entry.js'
+export { default as processPath } from './path.js'

package/src/template/format/path.js

@@ -0,0 +1,18 @@
+import perform from './lib/perform/email.js'
+import getEntries from '../../lib/entries/getAtPath.js'
+
+export default async ({
+  path,
+  settings
+}) => {
+  let entries = await getEntries({
+    path,
+  })
+
+  for (var i in entries) {
+    const entry = entries[i]
+    await perform({ entry, settings })
+  }
+
+  return true
+}

package/src/template/format/path.test.js

@@ -0,0 +1,29 @@
+
+test.skip('build posts', async () => {
+  const fsPath = (await import('path')).default
+  let path = fsPath.resolve(process.env.TEST_MOCK_FOLDER)
+  const operation = (await import('./path.js')).default
+
+  const result = await operation({
+    settings: {
+      platforms: [{
+        id: 'medium',
+        auth: {
+          token: process.env.TEST_MEDIUM_TOKEN,
+        }
+      }],
+      storage: {
+        type: "cdn",
+        auth: {
+          key: '',
+          secret: '',
+          bucketName: ''
+        }
+      }
+    },
+    path,
+  })
+  expect(result).toBeTruthy()
+})
+
+

package/src/template/index.js

@@ -0,0 +1,8 @@
+
+export * as build from './build/index.js'
+export * as cloudify from './cloudify/index.js'
+export * as consolidate from './consolidate/index.js'
+export * as contain from './consolidate/index.js'
+export * as sync from './sync/index.js'
+export * as update from './update/index.js'
+export { default as create } from './new/index.js'

package/src/template/lib/activity/createFileIfNeeded.js

@@ -0,0 +1,33 @@
+import fsPath from 'path'
+import fs from 'fs'
+import checkFileExists from '../../../lib/fs/checkFileExists.js'
+import importJSONAsync from '../../../lib/fs/importJSONAsync.js'
+
+export default async ({
+  path,
+  status = "draft",
+}) => {
+
+
+  try {
+
+    const filePath = fsPath.join(path, ".activity.json")
+
+    if ((await checkFileExists(filePath))) {
+      return
+    }
+
+    const defaultContent = await importJSONAsync('./defaultContent.json')
+    let content = {
+      ...defaultContent,
+      createdAt: (new Date()),
+      status,
+    }
+
+    await fs.promises.writeFile(filePath, JSON.stringify(content, null, 2))
+    return true
+  } catch (e) {
+    console.error(e)
+  }
+  return false
+}

package/src/template/lib/activity/defaultContent.json

@@ -0,0 +1,4 @@
+{
+  "createdAt": "",
+  "updatedAt": ""
+}

package/src/template/lib/activity/get.js

@@ -0,0 +1,20 @@
+import fsPath from 'path'
+import checkFileExists from '../../../lib/fs/checkFileExists.js'
+import importJSONAsync from '../../../lib/fs/importJSONAsync.js'
+
+export default async ({
+  path,
+}) => {
+  try {
+    const filePath = fsPath.join(path, ".activity.json")
+
+    if (!(await checkFileExists(filePath))) {
+      return null
+    }
+
+    return importJSONAsync(filePath)
+  } catch (e) {
+    console.error(e)
+  }
+  return null
+}

package/src/template/lib/activity/updateToFile.js

@@ -0,0 +1,33 @@
+import fsPath from 'path'
+import fs from 'fs'
+import checkFileExists from '../../../lib/fs/checkFileExists.js'
+import importJSONAsync from '../../../lib/fs/importJSONAsync.js'
+
+
+export default async ({
+  path,
+  content,
+}) => {
+
+
+  try {
+
+    const filePath = fsPath.join(path, ".activity.json")
+
+    if (!(await checkFileExists(filePath))) {
+      return
+    }
+
+    const defaultContent = await importJSONAsync('./defaultContent.json')
+    let _content = {
+      ...defaultContent,
+      ...content,
+    }
+
+    await fs.promises.writeFile(filePath, JSON.stringify(_content, null, 2))
+    return true
+  } catch (e) {
+    console.error(e)
+  }
+  return false
+}

package/src/template/lib/manifest/createFileIfNeeded.js

@@ -0,0 +1,41 @@
+import fsPath from 'path'
+import fs from 'fs'
+import checkFileExists from '../../../lib/fs/checkFileExists.js'
+import YAML from 'yaml'
+
+export default async ({
+  path,
+  data = {}
+}) => {
+
+
+  try {
+
+    const filePath = fsPath.join(path, "manifest.yaml")
+
+    if ((await checkFileExists(filePath))) {
+      return
+    }
+
+
+    let defaultManifest = YAML.parse(`
+      status: draft
+      skip: false
+      license: all-rights-reserved
+    `)
+
+    let manifest = {
+      ...defaultManifest,
+      createdAt: (new Date()),
+      ...data
+    }
+
+    manifest = YAML.stringify(manifest)
+
+    await fs.promises.writeFile(filePath, manifest)
+    return true
+  } catch (e) {
+    console.error(e)
+  }
+  return false
+}

package/src/template/lib/manifest/read.js

@@ -0,0 +1,22 @@
+import fsPath from 'path'
+import checkFileExists from '../../../lib/fs/checkFileExists.js'
+import importYAMLAsync from '../../../lib/fs/importYAMLAsync.js'
+
+
+export default async ({
+  path,
+}) => {
+  try {
+    const filePath = fsPath.join(path, "manifest.yaml")
+
+    if (!(await checkFileExists(filePath))) {
+      return null
+    }
+
+    const content = await importYAMLAsync(manifestPath)
+    return content
+  } catch (e) {
+    console.error(e)
+  }
+  return null
+}

package/src/template/lib/manifest/update.js

@@ -0,0 +1,18 @@
+import updateToFile from './updateToFile.js'
+import YAML from 'yaml'
+
+export default async ({
+  path,
+  manifest,
+}) => {
+  try {
+    const content = YAML.stringify(manifest)
+    return updateToFile({
+      path,
+      content
+    })
+  } catch (e) {
+    console.error(e)
+  }
+  return false
+}

package/src/template/lib/manifest/updateToFile.js

@@ -0,0 +1,22 @@
+import fsPath from 'path'
+import fs from 'fs'
+import checkFileExists from '../../../lib/fs/checkFileExists.js'
+
+export default async ({
+  path,
+  content,
+}) => {
+
+  try {
+    const filePath = fsPath.join(path, "manifest.yaml")
+    if (!(await checkFileExists(filePath))) {
+      return
+    }
+
+    await fs.promises.writeFile(filePath, content)
+    return true
+  } catch (e) {
+    console.error(e)
+  }
+  return false
+}

package/src/template/new/index.js

@@ -0,0 +1,66 @@
+import fsPath from 'path'
+import fs from 'fs'
+import checkFileExists from '../../lib/fs/checkFileExists.js'
+import createStatusIfNeeded from '../lib/activity/createFileIfNeeded.js'
+import createManifestIfNeeded from '../lib/manifest/createFileIfNeeded.js'
+
+export default async ({
+  path,
+  title = "My new post",
+  platforms = [],
+  status = "draft",
+  canonicalUrl = "",
+  tags,
+  author = {
+    id: "",
+    name: ""
+  },
+  force = false
+}) => {
+  try {
+    const folderPath = fsPath.join(path, title)
+
+    if ((await checkFileExists(folderPath))) {
+      if (!force) {
+        return false
+      }
+      await fs.promises.rmdir(folderPath, { recursive: true })
+    }
+
+    await fs.promises.mkdir(folderPath)
+    await fs.promises.mkdir(`${folderPath}/.assets`)
+    // await fs.promises.mkdir(`${folderPath}/artefacts`)
+    await fs.promises.mkdir(`${folderPath}/.build`)
+
+
+    await createStatusIfNeeded({
+      path: folderPath
+    })
+
+    await createManifestIfNeeded({
+      path: folderPath,
+      data: {
+        name: title,
+        platforms,
+        canonicalUrl,
+        status,
+        author,
+        tags
+      }
+    })
+
+
+    const postPath = fsPath.join(folderPath, "post.md")
+    const post = `# ${title}`
+    await fs.promises.writeFile(postPath, post, 'utf8')
+
+    const excerptPath = fsPath.join(folderPath, "excerpt.md")
+    const excerpt = ``
+    await fs.promises.writeFile(excerptPath, excerpt, 'utf8')
+
+    return true
+  } catch (e) {
+    console.error(e)
+  }
+  return false
+}

package/src/template/new/index.test.js

@@ -0,0 +1,19 @@
+
+test.skip('creates a new post', async () => {
+  const fsPath = (await import('path')).default
+  let path = fsPath.resolve("__mock__/adoucoure/Development")
+  const operation = (await import('./new.js')).default
+
+  const result = await operation({
+    platforms: [{
+      id: 'medium',
+    }],
+    path,
+    title: "Sample test post",
+    force: true
+  })
+
+  expect(result).toBeTruthy()
+})
+
+

package/src/template/optimize/entry.js

@@ -0,0 +1,18 @@
+import performEmail from './lib/email.js'
+import performTextMessage from './lib/textMessage.js'
+
+export default async ({
+  entry,
+  settings,
+}) => {
+  return {
+    entry: {
+      ...entry,
+      versions: await Promise.all(entry.versions.map(async _entry => {
+        let res = await performEmail({ entry: _entry, settings, })
+        res = await performTextMessage({ entry: res.entry, settings, })
+        return res.entry
+      }))
+    }
+  }
+}

package/src/template/optimize/index.js

@@ -0,0 +1,2 @@
+export { default as processEntry } from './entry.js'
+export { default as processPath } from './path.js'

package/src/template/optimize/lib/email.js

@@ -0,0 +1,58 @@
+import hastToHtml from '../../../lib/remark/hastToHtml.js'
+import treatImage from './image/index.js'
+
+export default async (props) => {
+  const { entry } = props
+  const { path, email: { hast } } = entry
+
+  let _hast = await perform({
+    child: hast,
+    path
+  })
+
+  let body = hastToHtml({ data: _hast })
+
+  return {
+    entry: {
+      ...entry,
+      email: {
+        ...entry.email,
+        hast: _hast,
+        body
+      }
+    }
+  }
+}
+
+const perform = async (props) => {
+  const { child, path } = props
+  let _child = { ...child }
+
+  if (child.properties && _child.properties.dataNotifilesDoNotOptimize) {
+    return child
+  }
+
+  switch (_child.tagName) {
+    case 'img': {
+      _child = await treatImage({
+        child: _child,
+        path
+      })
+    } break
+    default:
+      break
+  }
+
+  let _children = []
+  if (_child.children) {
+    _children = await Promise.all(_child.children.map(async child => perform({
+      ...props,
+      child
+    })))
+  }
+
+  return {
+    ..._child,
+    children: _children
+  }
+}

package/src/template/optimize/lib/image/index.js

@@ -0,0 +1,40 @@
+import fsPath from 'path'
+import isLocal from 'is-local'
+import isRelative from 'is-relative'
+import sharp from 'sharp'
+
+export default async ({ child,
+  path, }) => {
+  const { properties: {
+    src: url,
+  } } = child
+
+  if (!isLocal(url)) {
+    return child
+  }
+
+  const sourceUrl = isRelative(url) ? fsPath.resolve(path, url) : url
+  const extension = fsPath.parse(sourceUrl).ext
+  switch (extension) {
+    case '.svg': {
+      return child
+    }
+    default: break
+  }
+
+  const filename = `_${fsPath.parse(sourceUrl).name}.webp`
+  const destination = `${path}/.assets/${filename}`
+
+  await sharp(sourceUrl)
+    .webp({ quality: 90 })
+    .toFile(destination)
+
+  const newUrl = `.assets/${filename}`
+  return {
+    ...child,
+    properties: {
+      ...child.properties,
+      src: newUrl
+    }
+  }
+}

package/src/template/optimize/lib/textMessage.js

@@ -0,0 +1,8 @@
+
+export default async (props) => {
+  const { entry } = props
+
+  return {
+    entry
+  }
+}

package/src/template/optimize/path.js

@@ -0,0 +1,18 @@
+import perform from './lib/perform.js'
+import getEntries from '../../lib/entries/getAtPath.js'
+
+export default async ({
+  path,
+  settings
+}) => {
+  let entries = await getEntries({
+    path,
+  })
+
+  for (var i in entries) {
+    const entry = entries[i]
+    await perform({ entry, settings })
+  }
+
+  return true
+}

package/src/template/optimize/path.test.js

@@ -0,0 +1,16 @@
+
+test.skip('sync to medium platform', async () => {
+  const fsPath = (await import('path')).default
+  let path = fsPath.resolve(process.env.TEST_MOCK_FOLDER)
+  const operation = (await import('./path.js')).default
+
+  const result = await operation({
+    settings: {
+      assets: {
+        optimize: true
+      }
+    },
+    path,
+  })
+  expect(result).toBeTruthy()
+})

package/src/template/sync/entry.js

@@ -0,0 +1,18 @@
+import performEmail from './lib/email.js'
+import performTextMessage from './lib/textMessage.js'
+
+export default async ({
+  entry,
+  settings,
+}) => {
+  return {
+    entry: {
+      ...entry,
+      versions: await Promise.all(entry.versions.map(async _entry => {
+        let res = await performEmail({ entry: _entry, settings, })
+        res = await performTextMessage({ entry: res.entry, settings, })
+        return res.entry
+      }))
+    }
+  }
+}

package/src/template/sync/index.js

@@ -0,0 +1,2 @@
+export { default as processEntry } from './entry.js'
+export { default as processPath } from './path.js'