@rvoh/dream 1.13.0 → 2.0.0-alpha.1

package/README.md

@@ -1,6 +1,6 @@
-Dream is a typescript-driven, esm-first ORM built on top of [kysely](http://kysely.dev). It is built to operate within the [Psychic web framework](https://psychic-docs.netlify.app), but can be brought into other projects and used without the encapsulating framework (though this is theoretical, and we do not encourage it at this time). It is actively being developed to support production-grade applications in use within the [RVOHealth organization](https://www.rvohealth.com), who has kindly sponsored the continued development of this ORM, as well as the Psychic web framework as a whole.
+Dream is a typescript-driven, esm-first ORM built on top of [kysely](http://kysely.dev). It is built to operate within the [Psychic web framework](https://psychicframework.com/docs/intro), but can be brought into other projects and used without the encapsulating framework (though this is theoretical, and we do not encourage it at this time). It is actively being developed to support production-grade applications in use within the [RVOHealth organization](https://www.rvohealth.com), who has kindly sponsored the continued development of this ORM, as well as the Psychic web framework as a whole.
 
-Documentation: [https://psychic-docs.netlify.app](https://psychic-docs.netlify.app)
+Documentation: [https://psychicframework.com/docs/intro](https://psychicframework.com/docs/intro)
 Psychic web framework github: [https://github.com/rvohealth/psychic](https://github.com/rvohealth/psychic)
 
 ## Features
@@ -205,77 +205,6 @@ describe('Dream#pluck', () => {
 })
 ```
 
-### CLI
-
-```bash
-yarn build
-# builds source code using the typescript compiler, sending it into the dist folder
-
-yarn spec
-# runs core development specs (same as yarn dream spec --core)
-
-SQL_LOGGING=1 yarn spec
-# runs core development specs, printing SQL queries
-
-yarn console
-# opens console, providing access to the internal test-app/app/models folder (same as yarn dream console --core)
-
-yarn dream
-# opens a small node cli program, which right now only provides commands for generating dreams and migrations,
-# but which will likely eventually encompass all of the above commands
-
-yarn dream db:migrate --core
-# runs migrations for core development. Use this if you are working on the dream ORM source code.
-
-yarn dream db:migrate
-# runs migrations for an app that is consuming the dream ORM. This is meant to be run from another repo,
-# e.g. within a different app's package.json:
-#
-#  "scripts": {
-#     "db:migrate": "yarn --cwd=node_modules/dream db:migrate"
-# }
-
-yarn dream sync:schema
-# syncs db schema from an app that is consuming the dream ORM. This is necessary, because in order to provide
-# deep integration with kysely, we must actually introspect the schema of your app and provide it
-# as part of the dream orm source code build. It essentially scans your database, examines all tables, outputs interfaces that kysely can consume, puts them into a file, and exports all the interfaces within that file.
-
-# the sync command is already run as part of the migration sequence, so there should be no need to
-# run it manually. Simply run migrations to have the syncing done for you.
-
-# A copy of this is output to your app (though don't bother manually modifying it, since it is blown away each
-# time you run migrations). It is then copied over to the node_modules/dream/src/sync folder, so that importing
-# the dream orm can provide that integration for you.
-
-# This is meant to be run from another repo,
-# e.g. within a different app's package.json:
-#
-#  "scripts": {
-#     "sync:schema": "yarn --cwd=node_modules/dream sync:schema"
-# }
-
-yarn dream sync:schema --core
-# runs the same sync script mentioned above, but for core development. You would run this if you were trying to
-# sync for the test-app, which is used to seed the local tests and provide models for use within the console.
-# Similar to above, a local copy of schema is kept within test-app/types/dream.ts, which is updated each time you
-# run yarn core:db:migrate.
-
-yarn dream sync:associations
-# runs a script which analyzes your models, building a mapping of the associations into typescript interfaces
-# which will assist in providing enforced type completion mechanisms at the code composition level. This must be
-# this is used by the underlying `load` method, as well as `preload` and `joins` methods within the query
-# building layer. This is all copied to the file specified in the `.dream.yml#associations_path`. This is also automatically done whenever you run migrations, run specs, or open a console
-
-yarn dream sync:associations --core
-# same as above, but copies the associations.ts file to test-app/db/associations.ts
-
-yarn dream db:drop --core
-# drops the db for either the core app or a consuming app (which is why there is no "core:db:drop" variant)
-
-yarn dream db:create --core
-# creates the db for either the core app or a consuming app (which is why there is no "core:db:create" variant)
-```
-
 ### Similarity matching
 
 Dream provides a similarity searching library out of the box which allows you to implement fuzzy-searching in your app. To use it, first write a migration.
@@ -345,32 +274,6 @@ const pets = await user
   .all()
 ```
 
-#### Hidden gotchas
-
-- STI descendants of the same root model that define the same association must define that association identically if they are used in joins, preload, or load. For example, the following will not work properly:
-
-```ts
-@STI(A)
-class B extends A {
-  @deco.HasMany('X')
-  public xx: X[]
-}
-
-@STI(A)
-class C extends A {
-  @deco.HasMany('X', { and: { something: true } })
-  public xx: X[]
-}
-
-class Z extends Dream {
-  @deco.HasMany('A')
-  public aa: A[]
-}
-
-// this will not work as expected because the HasMany('X') are defined differently
-await z.load({ aa: 'xx' }).execute()
-```
-
 ## Questions?
 
 - **Ask them on [Stack Overflow](https://stackoverflow.com)**, using the `[dream]` tag.