@kaspernj/api-maker 1.0.2011 → 1.0.2013

package/__tests__/model-prop-type.test.js

@@ -1,113 +0,0 @@
-import ModelPropType from "../src/model-prop-type.mjs"
-import Task from "./support/task.mjs"
-import User from "./support/user.mjs"
-
-describe("ModelPropType", () => {
-  describe("ofModel", () => {
-    it("validates model class successfully", () => {
-      const user = new User({})
-      const validator = ModelPropType.ofModel(User).isRequired
-      const validation = validator({user}, "user")
-
-      expect(validation).toBeUndefined()
-    })
-
-    it("validates model class unsuccessfully", () => {
-      const task = new Task()
-      const validator = ModelPropType.ofModel(User).isRequired
-      const validation = validator({user: task}, "user")
-
-      expect(validation).toEqual(new Error("Expected user to be of type User but it wasn't: Task"))
-    })
-  })
-
-  describe("withLoadedAbilities", () => {
-    it("validates required attributes successfully", () => {
-      const user = new User({a: {id: 5}, b: {destroy: false, edit: true}})
-      const validator = ModelPropType.ofModel(User).withLoadedAbilities(["destroy", "edit"]).isRequired
-      const validation = validator({user}, "user")
-
-      expect(validation).toBeUndefined()
-    })
-
-    it("validates required attributes unsuccessfully", () => {
-      const user = new User({a: {id: 5}, b: {edit: true}})
-      const validator = ModelPropType.ofModel(User).withLoadedAbilities(["destroy", "edit"]).isRequired
-      const validation = validator({user}, "user")
-
-      expect(validation).toEqual(new Error("The ability destroy was required to be loaded in user of the User type but it wasn't"))
-    })
-  })
-
-  describe("withLoadedAssociation", () => {
-    it("validates association is loaded overall successfully", () => {
-      const task = new Task()
-      const user = new User({r: {tasks: [task]}})
-
-      const validator = ModelPropType
-        .ofModel(User)
-        .withLoadedAssociation("tasks")
-        .previous()
-        .isRequired
-
-      const validation = validator({user}, "user")
-
-      expect(validation).toBeUndefined()
-    })
-
-    it("validates association is loaded overall unsuccessfully", () => {
-      const user = new User({r: {}})
-
-      const validator = ModelPropType
-        .ofModel(User)
-        .withLoadedAssociation("tasks")
-        .previous()
-        .isRequired
-
-      const validation = validator({user}, "user")
-
-      expect(validation).toEqual(new Error("The association tasks was required to be loaded in user of the User type but it wasn't"))
-    })
-
-    it("validates attributes on nested associations", () => {
-      const task = new Task({a: {id: 4, name: "Test task"}})
-      const user = new User({r: {tasks: [task]}})
-
-      const validator = ModelPropType.ofModel(User)
-        .withLoadedAssociation("tasks")
-          .withLoadedAttributes(["id", "name", "updatedAt"])
-          .previous()
-        .isRequired
-
-      const validation = validator({user}, "user")
-
-      expect(validation).toEqual(new Error("The attribute updatedAt was required to be loaded in user.tasks of the Task type but it wasn't"))
-    })
-  })
-
-  describe("withLoadedAttributes", () => {
-    it("validates required attributes successfully", () => {
-      const user = new User({a: {id: 5, name: "Donald Duck"}})
-      const validator = ModelPropType.ofModel(User).withLoadedAttributes(["id", "name"]).isRequired
-      const validation = validator({user}, "user")
-
-      expect(validation).toBeUndefined()
-    })
-
-    it("validates required attributes unsuccessfully", () => {
-      const user = new User({a: {id: 5}})
-      const validator = ModelPropType.ofModel(User).withLoadedAttributes(["id", "name"]).isRequired
-      const validation = validator({user}, "user")
-
-      expect(validation).toEqual(new Error("The attribute name was required to be loaded in user of the User type but it wasn't"))
-    })
-
-    it("ignores if the model is a new record", () => {
-      const user = new User({isNewRecord: true})
-      const validator = ModelPropType.ofModel(User).withLoadedAttributes(["id", "name"]).isRequired
-      const validation = validator({user}, "user")
-
-      expect(validation).toBeUndefined()
-    })
-  })
-})

package/__tests__/params.test.js

@@ -1,40 +0,0 @@
-import Params from "../src/params.mjs"
-
-describe("Params", () => {
-  describe("change", () => {
-    it("changes the params", () => {
-      delete global.location
-
-      global.location = {
-        search: "?q[name_cont]=kasper"
-      }
-
-      const result = Params.change({q: {s: "name asc"}})
-
-      expect(result).toEqual({
-        q: {
-          name_cont: "kasper",
-          s: "name asc"
-        }
-      })
-    })
-  })
-
-  describe("parse", () => {
-    it("parses the current path", () => {
-      delete global.location
-
-      global.location = {
-        search: "?q[name_cont]=kasper"
-      }
-
-      const result = Params.parse()
-
-      expect(result).toEqual({
-        q: {
-          name_cont: "kasper"
-        }
-      })
-    })
-  })
-})

package/__tests__/routes-native.test.js

@@ -1,103 +0,0 @@
-import RoutesNative from "../src/routes-native.mjs"
-const testRoutes = () => ({
-  routes: [
-    {"name": "blank", "path": "/blank", "component": "blank"},
-
-    {"name": "root", "path": "", "component": "dashboard"},
-
-    {"name": "new_drink", "path": "/drinks/new", "component": "drinks/edit"},
-    {"name": "edit_drink", "path": "/drinks/:id/edit", "component": "drinks/edit"},
-    {"name": "drink", "path": "/drinks/:id", "component": "drinks/show"},
-    {"name": "drinks", "path": "/drinks", "component": "drinks/index"}
-  ]
-})
-const testTranslations = () => ({
-  locales: {
-    da: {
-      routes: {
-        drink: "drink",
-        edit: "rediger"
-      }
-    },
-    en: {
-      routes: {
-        drink: "drink",
-        edit: "edit"
-      }
-    }
-  }
-})
-
-const routesNative = ({args, currentLocale}) => {
-  const test = new RoutesNative({
-    getLocale: () => currentLocale
-  })
-
-  test.loadRouteTranslations(testTranslations())
-  test.loadRouteDefinitions(testRoutes(), args)
-
-  return test
-}
-
-describe("RoutesNative", () => {
-  it("translates routes from the current locale", () => {
-    const test = routesNative({args: {localized: true}, currentLocale: "da"})
-    const daRoute = test.editDrinkPath(5)
-
-    expect(daRoute).toEqual("/da/drinks/5/rediger")
-  })
-
-  it("translates routes from the locale-param", () => {
-    const test = routesNative({args: {localized: true}, currentLocale: "en"})
-    const daRoute = test.editDrinkPath(5, {locale: "da"})
-
-    expect(daRoute).toEqual("/da/drinks/5/rediger")
-  })
-
-  it("defaults to the locale given by the getLocale callback", () => {
-    const test = routesNative({args: {localized: true}, currentLocale: "en"})
-    const daRoute = test.editDrinkPath(5)
-
-    expect(daRoute).toEqual("/en/drinks/5/edit")
-  })
-
-  it("uses the rest of the params as a query string", () => {
-    const test = routesNative({args: {localized: true}, currentLocale: "en"})
-    const daRoute = test.editDrinkPath(5, {drink: {name: "Pina Colada"}, locale: "da"})
-
-    expect(daRoute).toEqual("/da/drinks/5/rediger?drink%5Bname%5D=Pina%20Colada")
-  })
-
-  it("translates a route without localization", () => {
-    const test = routesNative({currentLocale: "en"})
-    const daRoute = test.editDrinkPath(5, {drink: {name: "Pina Colada"}})
-
-    expect(daRoute).toEqual("/drinks/5/edit?drink%5Bname%5D=Pina%20Colada")
-  })
-
-  it("generates urls", () => {
-    if (!globalThis.location) globalThis.location = {} // eslint-disable-line jest/no-if
-
-    globalThis.location.host = "localhost"
-    globalThis.location.protocol = "http:"
-
-    const test = routesNative({args: {localized: true}, currentLocale: "en"})
-    const daRoute = test.editDrinkUrl(5, {drink: {name: "Pina Colada"}, locale: "da"})
-
-    expect(daRoute).toEqual("http://localhost/da/drinks/5/rediger?drink%5Bname%5D=Pina%20Colada")
-  })
-
-  it("generates urls with custom options", () => {
-    const test = routesNative({args: {localized: true}, currentLocale: "en"})
-    const daRoute = test.editDrinkUrl(5, {drink: {name: "Pina Colada"}, locale: "da", host: "google.com", port: 123, protocol: "https"})
-
-    expect(daRoute).toEqual("https://google.com:123/da/drinks/5/rediger?drink%5Bname%5D=Pina%20Colada")
-  })
-
-  it("generates urls without locales", () => {
-    const test = routesNative({currentLocale: "en"})
-    const daRoute = test.editDrinkUrl(5, {drink: {name: "Pina Colada"}, locale: "da", host: "google.com", port: 123, protocol: "https"})
-
-    expect(daRoute).toEqual("https://google.com:123/drinks/5/edit?drink%5Bname%5D=Pina%20Colada")
-  })
-})

package/__tests__/routes.test.js

@@ -1,46 +0,0 @@
-import Routes from "../src/routes.mjs"
-const testRoutes = {
-  routes: [
-    {"name": "blank", "path": "/blank", "component": "blank"},
-
-    {"name": "root", "path": "", "component": "dashboard"},
-
-    {"name": "new_drink", "path": "/drinks/new", "component": "drinks/edit"},
-    {"name": "edit_drink", "path": "/drinks/:id/edit", "component": "drinks/edit"},
-    {"name": "drink", "path": "/drinks/:id", "component": "drinks/show"},
-    {"name": "drinks", "path": "/drinks", "component": "drinks/index"}
-  ]
-}
-const fakeJsRoutes = {
-  blankPath: () => "/blank",
-  blankUrl: () => "https://localhost/blank",
-  newDrinkPath: () => "/drinks/new",
-  newDrinkUrl: () => "/drinks/new",
-  editDrinkPath: (drinkId) => `/drinks/${drinkId}/edit`,
-  editDrinkUrl: (drinkId) => `https://localhost/drinks/${drinkId}/edit`,
-  drinkPath: (drinkId) => `/druiks/${drinkId}`,
-  drinkUrl: (drinkId) => `https://localhost/drinks/${drinkId}`,
-  drinksPath: () => "/drinks",
-  drinksUrl: () => "https://localhost/drinks",
-  rootPath: () => "/root",
-  rootUrl: () => "https://localhost"
-}
-
-const routes = new Routes({
-  jsRoutes: fakeJsRoutes,
-  routeDefinitions: testRoutes
-})
-
-describe("Routes", () => {
-  it("generates paths", () => {
-    const daRoute = routes.editDrinkPath(5)
-
-    expect(daRoute).toEqual("/drinks/5/edit")
-  })
-
-  it("generates urls", () => {
-    const daRoute = routes.editDrinkUrl(5)
-
-    expect(daRoute).toEqual("https://localhost/drinks/5/edit")
-  })
-})

package/__tests__/serializer.test.js

@@ -1,30 +0,0 @@
-import Serializer from "../src/serializer.mjs"
-import User from "./support/user.mjs"
-
-describe("Serializer", () => {
-  test("it serializes model classes", () => {
-    const testObject = {
-      userModel: User
-    }
-    const serialized = Serializer.serialize(testObject)
-
-    expect(serialized).toEqual({userModel: {api_maker_type: "resource", name: "User"}})
-  })
-
-  test("it serializes dates", () => {
-    // Mock time zone offset
-    var getTimezoneOffset = Date.prototype.getTimezoneOffset
-
-    Date.prototype.getTimezoneOffset = function () {
-      return -120
-    }
-
-    const date = new Date(1985, 5, 17, 10, 30, 5)
-    const serialized = Serializer.serialize(date)
-
-    // Restore time zone offset
-    Date.prototype.getTimezoneOffset = getTimezoneOffset
-
-    expect(serialized).toEqual({api_maker_type: "datetime", value: "1985-6-17 10:30:5+0200"})
-  })
-})

package/__tests__/support/task.js

@@ -1,27 +0,0 @@
-export default class Task {
-  static modelClassData () {
-    return {
-      attributes: [],
-      name: "Task"
-    }
-  }
-
-  static modelName () {
-    return "Task"
-  }
-
-  constructor ({a, b, isNewRecord = false, r} = {}) {
-    this.abilities = b
-    this._isNewRecord = isNewRecord
-    this.modelData = a
-    this.relationshipsCache = r
-  }
-
-  isNewRecord () {
-    return this._isNewRecord
-  }
-
-  isPersisted () {
-    return !this._isNewRecord
-  }
-}

package/__tests__/support/user.js

@@ -1,32 +0,0 @@
-import BaseModel from "../../src/base-model.mjs"
-
-export default class User extends BaseModel {
-  static modelClassData () {
-    return {
-      attributes: [],
-      name: "User",
-      primaryKey: "id"
-    }
-  }
-
-  static modelName () {
-    return "User"
-  }
-
-  constructor ({a, b, isNewRecord = false, r}) {
-    super({a})
-
-    this.abilities = b
-    this._isNewRecord = isNewRecord
-    this.modelData = a
-    this.relationshipsCache = r
-  }
-
-  isNewRecord () {
-    return this._isNewRecord
-  }
-
-  isPersisted () {
-    return !this._isNewRecord
-  }
-}

package/index.js

@@ -1 +0,0 @@
-export {}

package/jest.config.js

@@ -1,4 +0,0 @@
-export default {
-  testRegex: "__tests__/.*\.test\.(m|)js$", // eslint-disable-line no-useless-escape
-  transform: {}
-}

package/src/can-can-loader.jsx

@@ -1,54 +0,0 @@
-import ApiMakerEventEmitterListener from "./event-emitter-listener"
-import {digg, digs} from "diggerize"
-import CanCan from "./can-can.mjs"
-import PropTypes from "prop-types"
-import propTypesExact from "prop-types-exact"
-import React from "react"
-
-export default class ApiMakerCanCanLoader extends React.PureComponent {
-  static propTypes = propTypesExact({
-    abilities: PropTypes.array.isRequired,
-    component: PropTypes.object.isRequired
-  })
-
-  componentDidMount () {
-    this.loadAbilities()
-  }
-
-  async loadAbilities () {
-    const canCan = CanCan.current()
-    const {abilities} = digs(this.props, "abilities")
-
-    await canCan.loadAbilities(abilities)
-
-    this.updateComponent({canCan})
-  }
-
-  render () {
-    const canCan = CanCan.current()
-    const events = digg(canCan, "events")
-
-    return (
-      <ApiMakerEventEmitterListener
-        event="onResetAbilities"
-        events={events}
-        onCalled={this.onResetAbilities}
-      />
-    )
-  }
-
-  onResetAbilities = () => {
-    this.updateComponent({canCan: undefined})
-    this.loadAbilities()
-  }
-
-  updateComponent (updatedState) {
-    const {component} = digs(this.props, "component")
-
-    if (component.shape) {
-      component.shape.set(updatedState)
-    } else {
-      component.setState(updatedState)
-    }
-  }
-}

package/src/channels-consumer.mjs

@@ -1,3 +0,0 @@
-import {createConsumer} from "@rails/actioncable"
-
-export default createConsumer()

package/src/destroy-error.mjs

@@ -1,7 +0,0 @@
-import BaseError from "./base-error.mjs"
-
-class DestroyError extends BaseError {}
-
-DestroyError.apiMakerType = "DestroyError"
-
-export default DestroyError

package/src/devise.mjs

@@ -1,122 +0,0 @@
-import CanCan from "./can-can.mjs"
-import Deserializer from "./deserializer.mjs"
-import {digg} from "diggerize"
-import EventEmitter from "events"
-import inflection from "inflection"
-import modelClassRequire from "./model-class-require.mjs"
-import Services from "./services.mjs"
-
-export default class ApiMakerDevise {
-  static callSignOutEvent (args) {
-    ApiMakerDevise.events().emit("onDeviseSignOut", {args})
-  }
-
-  static current () {
-    if (!globalThis.currentApiMakerDevise)
-    globalThis.currentApiMakerDevise = new ApiMakerDevise()
-
-    return globalThis.currentApiMakerDevise
-  }
-
-  static events () {
-    if (!globalThis.apiMakerDeviseEvents) {
-      globalThis.apiMakerDeviseEvents = new EventEmitter()
-      globalThis.apiMakerDeviseEvents.setMaxListeners(1000)
-    }
-
-    return globalThis.apiMakerDeviseEvents
-  }
-
-  static addUserScope (scope) {
-    const currentMethodName = `current${inflection.camelize(scope)}`
-
-    ApiMakerDevise[currentMethodName] = function () {
-      return ApiMakerDevise.current().getCurrentScope(scope)
-    }
-
-    const isSignedInMethodName = `is${inflection.camelize(scope)}SignedIn`
-
-    ApiMakerDevise[isSignedInMethodName] = function () {
-      if (ApiMakerDevise.current().getCurrentScope(scope)) {
-        return true
-      }
-
-      return false
-    }
-  }
-
-  static async signIn (username, password, args = {}) {
-    if (!args.scope) args.scope = "user"
-
-    const postData = {username, password, args}
-    const response = await Services.current().sendRequest("Devise::SignIn", postData)
-
-    let model = response.model
-
-    if (Array.isArray(model)) model = model[0]
-
-    await CanCan.current().resetAbilities()
-
-    ApiMakerDevise.updateSession(model)
-    ApiMakerDevise.events().emit("onDeviseSignIn", Object.assign({username}, args))
-
-    return {model, response}
-  }
-
-  static updateSession (model) {
-    const scope = digg(model.modelClassData(), "name")
-    const camelizedScopeName = inflection.camelize(scope, true)
-
-    ApiMakerDevise.current().currents[camelizedScopeName] = model
-  }
-
-  static setSignedOut (args) {
-    ApiMakerDevise.current().currents[inflection.camelize(args.scope, true)] = null
-  }
-
-  static async signOut (args = {}) {
-    if (!args.scope)
-      args.scope = "user"
-
-    const response = await Services.current().sendRequest("Devise::SignOut", {args})
-
-    await CanCan.current().resetAbilities()
-
-    // Cannot use the class because they would both import each other
-    if (globalThis.apiMakerSessionStatusUpdater) {
-      globalThis.apiMakerSessionStatusUpdater.updateSessionStatus()
-    }
-
-    ApiMakerDevise.setSignedOut(args)
-    ApiMakerDevise.callSignOutEvent(args)
-
-    return response
-  }
-
-  constructor () {
-    this.currents = {}
-  }
-
-  getCurrentScope (scope) {
-    if (!(scope in this.currents))
-      this.currents[scope] = this.loadCurrentScope(scope)
-
-    return this.currents[scope]
-  }
-
-  loadCurrentScope (scope) {
-    const scopeData = globalThis.apiMakerDeviseCurrent[scope]
-
-    if (!scopeData) return null
-
-    const parsedScopeData = Deserializer.parse(scopeData)
-
-    // Might be a collection with preloaded relationships
-    if (Array.isArray(parsedScopeData)) return parsedScopeData[0]
-
-    const ModelClass = modelClassRequire(scope)
-    const modelInstance = new ModelClass({data: parsedScopeData})
-
-    return modelInstance
-  }
-}

package/src/event-created.jsx

@@ -1,65 +0,0 @@
-import debounce from "debounce"
-import ModelEvents from "./model-events.mjs"
-import PropTypes from "prop-types"
-import propTypesExact from "prop-types-exact"
-import React from "react"
-
-export default class ApiMakerEventCreated extends React.PureComponent {
-  static defaultProps = {
-    active: true
-  }
-
-  static propTypes = propTypesExact({
-    active: PropTypes.bool.isRequired,
-    debounce: PropTypes.oneOfType([
-      PropTypes.bool,
-      PropTypes.number
-    ]),
-    modelClass: PropTypes.func.isRequired,
-    onCreated: PropTypes.func.isRequired
-  })
-
-  componentDidMount () {
-    this.connect()
-  }
-
-  componentWillUnmount () {
-    if (this.connectCreated) {
-      this.connectCreated.unsubscribe()
-    }
-  }
-
-  connect () {
-    this.connectCreated = ModelEvents.connectCreated(this.props.modelClass, (...args) => this.onCreated(...args))
-  }
-
-  debounce () {
-    if (!this.debounceInstance) {
-      const {onCreated} = digs(this.props, "onCreated")
-
-      if (typeof this.props.debounce == "number") {
-        this.debounceInstance = debounce(onCreated, this.props.debounce)
-      } else {
-        this.debounceInstance = debounce(onCreated)
-      }
-    }
-
-    return this.debounceInstance
-  }
-
-  onCreated (...args) {
-    if (!this.props.active) {
-      return
-    }
-
-    if (this.props.debounce) {
-      this.debounce()(...args)
-    } else {
-      this.props.onCreated(...args)
-    }
-  }
-
-  render () {
-    return null
-  }
-}

package/src/event-destroyed.jsx

@@ -1,29 +0,0 @@
-import ModelEvents from "./model-events.mjs"
-import PropTypes from "prop-types"
-import propTypesExact from "prop-types-exact"
-import React from "react"
-
-export default class ApiMakerEventDestroyed extends React.PureComponent {
-  static propTypes = propTypesExact({
-    model: PropTypes.object.isRequired,
-    onDestroyed: PropTypes.func.isRequired
-  })
-
-  componentDidMount () {
-    this.connect()
-  }
-
-  componentWillUnmount () {
-    if (this.connectDestroyed) {
-      this.connectDestroyed.unsubscribe()
-    }
-  }
-
-  connect () {
-    this.connectDestroyed = ModelEvents.connectDestroyed(this.props.model, this.props.onDestroyed)
-  }
-
-  render () {
-    return null
-  }
-}