json-fs-query 0.1.0 → 1.0.0

package/src/data/utilities/useJoinClause.test.js

@@ -1,94 +0,0 @@
-import { useJoinClause } from './useJoinClause'
-import { testHelpers } from 'js-build-tools/testHelpers'
-import { copyDatabase } from '../../../test-data/copyDatabase'
-
-const databasePath = 'use-join-clause-database/'
-const gulpConfig = testHelpers.gulpConfig
-gulpConfig.set('databasePath', databasePath)
-testHelpers.setDefaults(databasePath)
-
-beforeEach(
-  () => testHelpers.beforeEach()
-    .then(() => copyDatabase(databasePath))
-)
-
-afterEach(testHelpers.afterEach)
-
-describe('useJoinClause', () => {
-  test('it will find the joins', async () => {
-    const result = await useJoinClause({
-      propertyA: 'workouts.exercise_id',
-      comparator: '=',
-      propertyB: 'exercises._id'
-    })
-    expect(result).toEqual({
-      workouts: [
-        {
-          _id: 1,
-          exercise_id: 1,
-          weight_effort: '115lbs',
-          reps: 10,
-          sets: 3,
-          note: '',
-          order: 0,
-          date: '2024-06-02'
-        },
-        {
-          _id: 4,
-          exercise_id: 1,
-          weight_effort: '120lbs',
-          reps: 10,
-          sets: 3,
-          note: '',
-          order: 0,
-          date: '2024-06-05'
-        },
-        {
-          _id: 2,
-          exercise_id: 2,
-          weight_effort: '155lbs',
-          reps: 10,
-          sets: 3,
-          note: '',
-          order: 1,
-          date: '2024-06-02'
-        },
-        {
-          _id: 5,
-          exercise_id: 2,
-          weight_effort: '160lbs',
-          reps: 10,
-          sets: 3,
-          note: '',
-          order: 1,
-          date: '2024-06-05'
-        },
-        {
-          _id: 3,
-          exercise_id: 3,
-          weight_effort: '155lbs',
-          reps: 10,
-          sets: 3,
-          note: '',
-          order: 2,
-          date: '2024-06-02'
-        },
-        {
-          _id: 6,
-          exercise_id: 3,
-          weight_effort: '160lbs',
-          reps: 10,
-          sets: 3,
-          note: '',
-          order: 2,
-          date: '2024-06-05'
-        }
-      ],
-      exercises: [
-        { _id: 1, name: 'Bench Press', description: '' },
-        { _id: 2, name: 'Deadlift', description: '' },
-        { _id: 3, name: 'Squat', description: '' }
-      ]
-    })
-  })
-})

package/src/data/utilities/useJoinClause.ts

@@ -1,44 +0,0 @@
-import { readEntity } from '../queries/readEntity'
-import { where } from '../queries/where'
-import { splitEntityProperty } from './parsers/splitEntityProperty'
-import siFunciona from 'si-funciona'
-
-export const useJoinClause = async (
-  { propertyA = null, comparator = '=', propertyB = null } = {},
-  dataSets = {},
-  filterJoins = {}
-) => {
-  const { entity: entityA, property: propA } = splitEntityProperty(propertyA)
-  const { entity: entityB, property: propB } = splitEntityProperty(propertyB)
-
-  if (!dataSets.hasOwnProperty(entityA)) {
-    dataSets = await readEntity(entityA, dataSets)
-  }
-  if (!dataSets.hasOwnProperty(entityB)) {
-    dataSets = await readEntity(entityB, dataSets)
-  }
-
-  if (!filterJoins.hasOwnProperty(entityA)) {
-    filterJoins[entityA] = siFunciona.cloneObject(dataSets[entityA])
-  }
-  if (!filterJoins.hasOwnProperty(entityB)) {
-    filterJoins[entityB] = siFunciona.cloneObject(dataSets[entityB])
-  }
-
-  filterJoins[entityA] = filterJoins[entityB].reduce(
-    (dataA, dataB) => siFunciona.mergeArrays(
-      dataA,
-      where(filterJoins[entityA], { property: propA, comparator: comparator, value: dataB[propB] })
-    ),
-    []
-  )
-
-  filterJoins[entityB] = filterJoins[entityA].reduce(
-    (dataB, dataA) => siFunciona.mergeArrays(
-      dataB,
-      where(filterJoins[entityB], { property: propB, comparator: comparator, value: dataA[propA] })
-    ),
-    []
-  )
-  return filterJoins
-}

package/src/global.d.ts

@@ -1 +0,0 @@
-declare function require (id: string): any

package/src/index.test.js

@@ -1,52 +0,0 @@
-import { query, create, drop, describe as describeRecord } from './index'
-import { testHelpers } from 'js-build-tools/testHelpers'
-
-const databasePath = 'public-api-database/'
-const gulpConfig = testHelpers.gulpConfig
-gulpConfig.set('databasePath', databasePath)
-testHelpers.setDefaults(databasePath)
-
-beforeEach(testHelpers.beforeEach)
-
-afterEach(testHelpers.afterEach)
-
-describe('the public package entry point', () => {
-  test('create, insert, read, update, delete, and drop all work through the exported functions', async () => {
-    const definition = [
-      { name: '_id', type: 'string', optional: false, autoGenerate: true },
-      { name: 'note', type: 'string', optional: true, autoGenerate: false }
-    ]
-    const keys = [
-      { type: 'primary', fields: ['_id'], lookup: 'pk__id.json' }
-    ]
-
-    await create('foo', definition, keys)
-
-    const inserted = await query("insert foo values note = 'hello'")
-    expect(inserted[0]).toHaveLength(1)
-
-    const read = await query('read foo')
-    expect(read[0]).toHaveLength(1)
-    expect(read[0][0].note).toBe('hello')
-
-    const updated = await query("update foo set note = 'updated' where note = 'hello'")
-    expect(updated[0][0].note).toBe('updated')
-
-    const deleted = await query("delete foo where note = 'updated'")
-    expect(deleted[0]).toHaveLength(1)
-
-    const afterDelete = await query('read foo')
-    expect(afterDelete[0]).toEqual([])
-
-    await drop('foo')
-  })
-
-  test('describe reports a record\'s field definition', async () => {
-    const definition = [
-      { name: '_id', type: 'string', optional: false, autoGenerate: true }
-    ]
-    await create('bar', definition, [])
-    const result = await describeRecord('bar')
-    expect(result).toEqual(definition)
-  })
-})

package/src/index.ts

@@ -1,17 +0,0 @@
-export { query } from './data/queries/query'
-export { create, drop, describe } from './data/introspect'
-export {
-  fieldProperties,
-  fieldDefinition,
-  fieldName,
-  keyProperties,
-  keyDefinition,
-  indexType,
-  indexLocation,
-  referenceProperties,
-  reference,
-  recordProperties,
-  recordDefinition,
-  recordPath,
-  entityPath
-} from './data/introspect'

package/test-data/__RECORDS.json

@@ -1,32 +0,0 @@
-{
-  "path": "",
-  "definition": [
-    {
-      "name": "path",
-      "type": "string",
-      "optional": false
-    },
-    {
-      "name": "definition",
-      "type": "object",
-      "optional": false
-    },
-    {
-      "name": "keys",
-      "type": "array",
-      "optional": false
-    },
-    {
-      "name": "entries",
-      "type": "array",
-      "optional": false
-    }
-  ],
-  "keys":  [],
-  "entries": [
-    "exercise_muscle.json",
-    "exercises.json",
-    "muscles.json",
-    "workouts.json"
-  ]
-}

package/test-data/__indexes/exercise_muscle/fk_exercise_id.json

@@ -1,14 +0,0 @@
-[
-  {
-    "value": 1,
-    "record": ["bench_press_pectorals.json"]
-  },
-  {
-    "value": 2,
-    "record": ["deadlift_hamstrings.json"]
-  },
-  {
-    "value": 3,
-    "record": ["squat_quadriceps.json"]
-  }
-]

package/test-data/__indexes/exercise_muscle/fk_muscle_id.json

@@ -1,14 +0,0 @@
-[
-  {
-    "value": 8,
-    "record": ["deadlift_hamstrings.json"]
-  },
-  {
-    "value": 11,
-    "record": ["bench_press_pectorals.json"]
-  },
-  {
-    "value": 12,
-    "record": ["squat_quadriceps.json"]
-  }
-]

package/test-data/__indexes/exercise_muscle/pk__id.json

@@ -1,14 +0,0 @@
-[
-  {
-    "value": 1,
-    "record": ["bench_press_pectorals.json"]
-  },
-  {
-    "value": 2,
-    "record": ["deadlift_hamstrings.json"]
-  },
-  {
-    "value": 3,
-    "record": ["squat_quadriceps.json"]
-  }
-]

package/test-data/__indexes/exercises/pk__id.json

@@ -1,14 +0,0 @@
-[
-  {
-    "value": 1,
-    "record": ["bench_press.json"]
-  },
-  {
-    "value": 2,
-    "record": ["deadlift.json"]
-  },
-  {
-    "value": 3,
-    "record": ["squat.json"]
-  }
-]

package/test-data/__indexes/muscles/pk__id.json

@@ -1,58 +0,0 @@
-[
-  {
-    "value": 1,
-    "record": ["abdominal.json"]
-  },
-  {
-    "value": 2,
-    "record": ["biceps.json"]
-  },
-  {
-    "value": 3,
-    "record": ["calves.json"]
-  },
-  {
-    "value": 4,
-    "record": ["deltoids.json"]
-  },
-  {
-    "value": 5,
-    "record": ["erector_spinae.json"]
-  },
-  {
-    "value": 6,
-    "record": ["forearms.json"]
-  },
-  {
-    "value": 7,
-    "record": ["gluteas_maximus.json"]
-  },
-  {
-    "value": 8,
-    "record": ["hamstrings.json"]
-  },
-  {
-    "value": 9,
-    "record": ["latissimus_dorsi.json"]
-  },
-  {
-    "value": 10,
-    "record": ["obliques.json"]
-  },
-  {
-    "value": 11,
-    "record": ["pectorals.json"]
-  },
-  {
-    "value": 12,
-    "record": ["quadriceps.json"]
-  },
-  {
-    "value": 13,
-    "record": ["trapezius.json"]
-  },
-  {
-    "value": 14,
-    "record": ["triceps.json"]
-  }
-]

package/test-data/__indexes/workouts/fk_exercise_id.json

@@ -1,23 +0,0 @@
-[
-  {
-    "value": 1,
-    "record": [
-      "2024-06-02-001.json",
-      "2024-06-05-001.json"
-    ]
-  },
-  {
-    "value": 2,
-    "record": [
-      "2024-06-02-002.json",
-      "2024-06-05-002.json"
-    ]
-  },
-  {
-    "value": 3,
-    "record": [
-      "2024-06-02-003.json",
-      "2024-06-05-003.json"
-    ]
-  }
-]

package/test-data/__indexes/workouts/index_date.json

@@ -1,18 +0,0 @@
-[
-  {
-    "value": "2024-06-02",
-    "record": [
-      "2024-06-02-001.json",
-      "2024-06-02-002.json",
-      "2024-06-02-003.json"
-    ]
-  },
-  {
-    "value": "2024-06-05",
-    "record": [
-      "2024-06-05-001.json",
-      "2024-06-05-002.json",
-      "2024-06-05-003.json"
-    ]
-  }
-]

package/test-data/__indexes/workouts/pk__id.json

@@ -1,26 +0,0 @@
-[
-  {
-    "value": 1,
-    "record": ["2024-06-02-001.json"]
-  },
-  {
-    "value": 2,
-    "record": ["2024-06-02-001.json"]
-  },
-  {
-    "value": 3,
-    "record": ["2024-06-02-001.json"]
-  },
-  {
-    "value": 4,
-    "record": ["2024-06-05-001.json"]
-  },
-  {
-    "value": 5,
-    "record": ["2024-06-05-001.json"]
-  },
-  {
-    "value": 6,
-    "record": ["2024-06-05-001.json"]
-  }
-]

package/test-data/copyDatabase.ts

@@ -1,64 +0,0 @@
-// @ts-ignore
-import fs from 'fs/promises'
-
-export const copyDatabase = async (destination: string = 'test-database'): Promise<Array<string>> => {
-  const makeDirs: string[] = [
-    '__indexes',
-    '__indexes/exercise_muscle',
-    '__indexes/exercises',
-    '__indexes/muscles',
-    '__indexes/workouts',
-    'exercise_muscle',
-    'exercises',
-    'muscles',
-    'workouts',
-  ]
-  for (let dir of makeDirs) {
-    await fs.mkdir(`${destination}/${dir}`)
-  }
-  const copyFiles: string[] = [
-    '__RECORDS.json',
-    'exercise_muscle.json',
-    'exercise_muscle/bench_press_pectorals.json',
-    'exercise_muscle/deadlift_hamstrings.json',
-    'exercise_muscle/squat_quadriceps.json',
-    '__indexes/exercise_muscle/fk_exercise_id.json',
-    '__indexes/exercise_muscle/fk_muscle_id.json',
-    '__indexes/exercise_muscle/pk__id.json',
-    'exercises.json',
-    'exercises/bench_press.json',
-    'exercises/deadlift.json',
-    'exercises/squat.json',
-    '__indexes/exercises/pk__id.json',
-    'muscles.json',
-    'muscles/abdominal.json',
-    'muscles/biceps.json',
-    'muscles/calves.json',
-    'muscles/deltoids.json',
-    'muscles/erector_spinae.json',
-    'muscles/forearms.json',
-    'muscles/gluteus_maximus.json',
-    'muscles/hamstrings.json',
-    'muscles/latissimus_dorsi.json',
-    'muscles/obliques.json',
-    'muscles/pectorals.json',
-    'muscles/quadriceps.json',
-    'muscles/trapezius.json',
-    'muscles/triceps.json',
-    '__indexes/muscles/pk__id.json',
-    'workouts.json',
-    'workouts/2024-06-02-001.json',
-    'workouts/2024-06-02-002.json',
-    'workouts/2024-06-02-003.json',
-    'workouts/2024-06-05-001.json',
-    'workouts/2024-06-05-002.json',
-    'workouts/2024-06-05-003.json',
-    '__indexes/workouts/fk_exercise_id.json',
-    '__indexes/workouts/index_date.json',
-    '__indexes/workouts/pk__id.json',
-  ]
-  for (let file of copyFiles) {
-    await fs.copyFile(`test-data/${file}`, `${destination}/${file}`)
-  }
-  return copyFiles
-}

package/test-data/exercise_muscle/bench_press_pectorals.json

@@ -1,6 +0,0 @@
-{
-  "_id": 1,
-  "exercise_id": 1,
-  "muscle_id": 11,
-  "muscle_rank": 100
-}

package/test-data/exercise_muscle/deadlift_hamstrings.json

@@ -1,6 +0,0 @@
-{
-  "_id": 2,
-  "exercise_id": 2,
-  "muscle_id": 8,
-  "muscle_rank": 100
-}

package/test-data/exercise_muscle/squat_quadriceps.json

@@ -1,6 +0,0 @@
-{
-  "_id": 3,
-  "exercise_id": 3,
-  "muscle_id": 12,
-  "muscle_rank": 100
-}

package/test-data/exercise_muscle.json

@@ -1,69 +0,0 @@
-{
-  "path": "exercise_muscle",
-  "definition": [
-    {
-      "name": "_id",
-      "type": "string",
-      "optional": false
-    },
-    {
-      "name": "exercise_id",
-      "type": "string",
-      "optional": false
-    },
-    {
-      "name": "muscle_id",
-      "type": "string",
-      "optional": false
-    },
-    {
-      "name": "muscle_rank",
-      "type": "int",
-      "optional": false
-    }
-  ],
-  "keys": [
-    {
-      "type": "primary",
-      "fields": [
-        "_id"
-      ],
-      "lookup": "pk__id.json"
-    },
-    {
-      "type": "foreign",
-      "fields": [
-        "exercise_id"
-      ],
-      "lookup": "fk_exercise_id.json",
-      "references": [
-        {
-          "fields": [
-            "exercises._id"
-          ],
-          "lookup": "exercises.json"
-        }
-      ]
-    },
-    {
-      "type": "foreign",
-      "fields": [
-        "muscle_id"
-      ],
-      "lookup": "fk_muscle_id.json",
-      "references": [
-        {
-          "fields": [
-            "muscles._id"
-          ],
-          "lookup": "muscles.json"
-        }
-      ]
-    }
-  ],
-  "entries": [
-    "bench_press_pectorals.json",
-    "deadlift_hamstrings.json",
-    "squat_quadriceps.json"
-  ]
-}

package/test-data/exercises/bench_press.json

@@ -1,5 +0,0 @@
-{
-  "_id": 1,
-  "name": "Bench Press",
-  "description": ""
-}

package/test-data/exercises/deadlift.json

@@ -1,5 +0,0 @@
-{
-  "_id": 2,
-  "name": "Deadlift",
-  "description": ""
-}

package/test-data/exercises/squat.json

@@ -1,5 +0,0 @@
-{
-  "_id": 3,
-  "name": "Squat",
-  "description": ""
-}

package/test-data/exercises.json

@@ -1,34 +0,0 @@
-{
-  "path": "exercises",
-  "definition": [
-    {
-      "name": "_id",
-      "type": "string",
-      "optional": false
-    },
-    {
-      "name": "name",
-      "type": "string",
-      "optional": false
-    },
-    {
-      "name": "description",
-      "type": "string",
-      "optional": true
-    }
-  ],
-  "keys": [
-    {
-      "type": "primary",
-      "fields": [
-        "_id"
-      ],
-      "lookup": "pk__id.json"
-    }
-  ],
-  "entries": [
-    "bench_press.json",
-    "deadlift.json",
-    "squat.json"
-  ]
-}

package/test-data/muscles/abdominal.json

@@ -1,6 +0,0 @@
-{
-  "_id": 1,
-  "name": "Abdominal",
-  "alias": "abs",
-  "image": "../img/abdominals.jpg"
-}

package/test-data/muscles/biceps.json

@@ -1,6 +0,0 @@
-{
-  "_id": 2,
-  "name": "Biceps",
-  "alias": "",
-  "image": ""
-}

package/test-data/muscles/calves.json

@@ -1,6 +0,0 @@
-{
-  "_id": 3,
-  "name": "Calves",
-  "alias": "",
-  "image": ""
-}

package/test-data/muscles/deltoids.json

@@ -1,6 +0,0 @@
-{
-  "_id": 4,
-  "name": "Deltoids",
-  "alias": "shoulders",
-  "image": ""
-}