@warp-drive/legacy 5.8.0-alpha.30 → 5.8.0-alpha.34
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/declarations/adapter/error.d.ts +5 -5
- package/declarations/adapter/json-api.d.ts +2 -2
- package/declarations/compat/builders/find-all.d.ts +6 -6
- package/declarations/compat/builders/find-record.d.ts +8 -8
- package/declarations/compat/builders/query.d.ts +12 -12
- package/declarations/compat.d.ts +3 -3
- package/declarations/model/-private/references/belongs-to.d.ts +4 -4
- package/declarations/model/-private/references/has-many.d.ts +2 -2
- package/declarations/model/migration-support.d.ts +34 -18
- package/declarations/model.d.ts +2 -2
- package/declarations/serializer/-private/embedded-records-mixin.d.ts +1 -1
- package/declarations/serializer/json-api.d.ts +3 -3
- package/declarations/serializer/json.d.ts +1 -1
- package/declarations/serializer.d.ts +1 -1
- package/dist/adapter/error.js +7 -7
- package/dist/compat/builders.js +26 -26
- package/dist/compat/utils.js +0 -1
- package/dist/compat.js +3 -3
- package/dist/{errors-B9CDPh3R.js → errors-CIGPcDvd.js} +12 -12
- package/dist/{hooks-CQXyievu.js → hooks-QqRnX108.js} +1 -1
- package/dist/index.js +4 -4
- package/dist/{json-BHxlccxF.js → json-BNrV8EYG.js} +4 -4
- package/dist/model/-private.js +1 -1
- package/dist/model/migration-support.js +41 -24
- package/dist/{model-for-B0TSd9HU.js → model-for-CqXsIKws.js} +1 -1
- package/dist/model-fragments.js +2 -2
- package/dist/model.js +3 -3
- package/dist/{schema-provider-BnVr_CnJ.js → schema-provider-g5MfTj8n.js} +11 -11
- package/dist/serializer/json-api.js +7 -7
- package/dist/serializer/json.js +1 -1
- package/dist/serializer/rest.js +10 -10
- package/dist/serializer.js +1 -1
- package/dist/unpkg/dev/-private-B1pSSN52.js +1210 -0
- package/dist/unpkg/dev/adapter/-private.js +1 -0
- package/dist/unpkg/dev/adapter/error.js +336 -0
- package/dist/unpkg/dev/adapter/json-api.js +132 -0
- package/dist/unpkg/dev/adapter/rest.js +1257 -0
- package/dist/unpkg/dev/adapter.js +1253 -0
- package/dist/unpkg/dev/compat/-private.js +1 -0
- package/dist/unpkg/dev/compat/builders.js +273 -0
- package/dist/unpkg/dev/compat/extensions.js +243 -0
- package/dist/unpkg/dev/compat/utils.js +224 -0
- package/dist/unpkg/dev/compat.js +1020 -0
- package/dist/unpkg/dev/declarations/adapter/-private/build-url-mixin.d.ts +33 -0
- package/dist/unpkg/dev/declarations/adapter/-private/fastboot-interface.d.ts +8 -0
- package/dist/unpkg/dev/declarations/adapter/-private/utils/continue-on-reject.d.ts +1 -0
- package/dist/unpkg/dev/declarations/adapter/-private/utils/determine-body-promise.d.ts +4 -0
- package/dist/unpkg/dev/declarations/adapter/-private/utils/fetch.d.ts +8 -0
- package/dist/unpkg/dev/declarations/adapter/-private/utils/parse-response-headers.d.ts +1 -0
- package/dist/unpkg/dev/declarations/adapter/-private/utils/serialize-into-hash.d.ts +6 -0
- package/dist/unpkg/dev/declarations/adapter/-private/utils/serialize-query-params.d.ts +5 -0
- package/dist/unpkg/dev/declarations/adapter/-private.d.ts +5 -0
- package/dist/unpkg/dev/declarations/adapter/error.d.ts +215 -0
- package/dist/unpkg/dev/declarations/adapter/json-api.d.ts +231 -0
- package/dist/unpkg/dev/declarations/adapter/rest.d.ts +815 -0
- package/dist/unpkg/dev/declarations/adapter.d.ts +770 -0
- package/dist/unpkg/dev/declarations/compat/-private.d.ts +13 -0
- package/dist/unpkg/dev/declarations/compat/builders/find-all.d.ts +35 -0
- package/dist/unpkg/dev/declarations/compat/builders/find-record.d.ts +56 -0
- package/dist/unpkg/dev/declarations/compat/builders/query.d.ts +66 -0
- package/dist/unpkg/dev/declarations/compat/builders/save-record.d.ts +34 -0
- package/dist/unpkg/dev/declarations/compat/builders/utils.d.ts +3 -0
- package/dist/unpkg/dev/declarations/compat/builders.d.ts +14 -0
- package/dist/unpkg/dev/declarations/compat/extensions.d.ts +59 -0
- package/dist/unpkg/dev/declarations/compat/legacy-network-handler/fetch-manager.d.ts +55 -0
- package/dist/unpkg/dev/declarations/compat/legacy-network-handler/identifier-has-id.d.ts +2 -0
- package/dist/unpkg/dev/declarations/compat/legacy-network-handler/legacy-data-fetch.d.ts +11 -0
- package/dist/unpkg/dev/declarations/compat/legacy-network-handler/legacy-data-utils.d.ts +5 -0
- package/dist/unpkg/dev/declarations/compat/legacy-network-handler/legacy-network-handler.d.ts +2 -0
- package/dist/unpkg/dev/declarations/compat/legacy-network-handler/minimum-adapter-interface.d.ts +524 -0
- package/dist/unpkg/dev/declarations/compat/legacy-network-handler/minimum-serializer-interface.d.ts +213 -0
- package/dist/unpkg/dev/declarations/compat/legacy-network-handler/serializer-response.d.ts +6 -0
- package/dist/unpkg/dev/declarations/compat/legacy-network-handler/snapshot-record-array.d.ts +110 -0
- package/dist/unpkg/dev/declarations/compat/legacy-network-handler/snapshot.d.ts +255 -0
- package/dist/unpkg/dev/declarations/compat/utils.d.ts +137 -0
- package/dist/unpkg/dev/declarations/compat.d.ts +157 -0
- package/dist/unpkg/dev/declarations/index.d.ts +70 -0
- package/dist/unpkg/dev/declarations/model/-private/attr.d.ts +170 -0
- package/dist/unpkg/dev/declarations/model/-private/belongs-to.d.ts +174 -0
- package/dist/unpkg/dev/declarations/model/-private/debug/assert-polymorphic-type.d.ts +5 -0
- package/dist/unpkg/dev/declarations/model/-private/errors.d.ts +289 -0
- package/dist/unpkg/dev/declarations/model/-private/has-many.d.ts +162 -0
- package/dist/unpkg/dev/declarations/model/-private/hooks.d.ts +10 -0
- package/dist/unpkg/dev/declarations/model/-private/legacy-relationships-support.d.ts +47 -0
- package/dist/unpkg/dev/declarations/model/-private/model-for-mixin.d.ts +3 -0
- package/dist/unpkg/dev/declarations/model/-private/model-methods.d.ts +39 -0
- package/dist/unpkg/dev/declarations/model/-private/model.d.ts +1269 -0
- package/dist/unpkg/dev/declarations/model/-private/notify-changes.d.ts +4 -0
- package/dist/unpkg/dev/declarations/model/-private/promise-belongs-to.d.ts +40 -0
- package/dist/unpkg/dev/declarations/model/-private/promise-many-array.d.ts +124 -0
- package/dist/unpkg/dev/declarations/model/-private/record-state.d.ts +58 -0
- package/dist/unpkg/dev/declarations/model/-private/references/belongs-to.d.ts +498 -0
- package/dist/unpkg/dev/declarations/model/-private/references/has-many.d.ts +500 -0
- package/dist/unpkg/dev/declarations/model/-private/schema-provider.d.ts +56 -0
- package/dist/unpkg/dev/declarations/model/-private/type-utils.d.ts +57 -0
- package/dist/unpkg/dev/declarations/model/-private/util.d.ts +5 -0
- package/dist/unpkg/dev/declarations/model/-private.d.ts +8 -0
- package/dist/unpkg/dev/declarations/model/migration-support.d.ts +280 -0
- package/dist/unpkg/dev/declarations/model-fragments/extensions/fragment-array.d.ts +16 -0
- package/dist/unpkg/dev/declarations/model-fragments/extensions/fragment.d.ts +15 -0
- package/dist/unpkg/dev/declarations/model-fragments/hooks/model-for.d.ts +20 -0
- package/dist/unpkg/dev/declarations/model-fragments/index.d.ts +5 -0
- package/dist/unpkg/dev/declarations/model-fragments/instance-initializers/fragment-extensions.d.ts +9 -0
- package/dist/unpkg/dev/declarations/model-fragments/utilities/with-array-defaults.d.ts +15 -0
- package/dist/unpkg/dev/declarations/model-fragments/utilities/with-fragment-array-defaults.d.ts +20 -0
- package/dist/unpkg/dev/declarations/model-fragments/utilities/with-fragment-defaults.d.ts +19 -0
- package/dist/unpkg/dev/declarations/model-fragments/utilities/with-legacy.d.ts +3 -0
- package/dist/unpkg/dev/declarations/model-fragments.d.ts +9 -0
- package/dist/unpkg/dev/declarations/model.d.ts +49 -0
- package/dist/unpkg/dev/declarations/serializer/-private/embedded-records-mixin.d.ts +91 -0
- package/dist/unpkg/dev/declarations/serializer/-private/transforms/boolean.d.ts +47 -0
- package/dist/unpkg/dev/declarations/serializer/-private/transforms/date.d.ts +28 -0
- package/dist/unpkg/dev/declarations/serializer/-private/transforms/number.d.ts +29 -0
- package/dist/unpkg/dev/declarations/serializer/-private/transforms/string.d.ts +29 -0
- package/dist/unpkg/dev/declarations/serializer/-private/transforms/transform.d.ts +118 -0
- package/dist/unpkg/dev/declarations/serializer/-private/utils.d.ts +3 -0
- package/dist/unpkg/dev/declarations/serializer/json-api.d.ts +123 -0
- package/dist/unpkg/dev/declarations/serializer/json.d.ts +75 -0
- package/dist/unpkg/dev/declarations/serializer/rest.d.ts +51 -0
- package/dist/unpkg/dev/declarations/serializer/transform.d.ts +5 -0
- package/dist/unpkg/dev/declarations/serializer.d.ts +254 -0
- package/dist/unpkg/dev/declarations/store/-private.d.ts +223 -0
- package/dist/unpkg/dev/declarations/store.d.ts +3 -0
- package/dist/unpkg/dev/errors-CIGPcDvd.js +2595 -0
- package/dist/unpkg/dev/hooks-QqRnX108.js +74 -0
- package/dist/unpkg/dev/index.js +195 -0
- package/dist/unpkg/dev/json-BNrV8EYG.js +1272 -0
- package/dist/unpkg/dev/model/-private.js +1 -0
- package/dist/unpkg/dev/model/migration-support.js +579 -0
- package/dist/unpkg/dev/model-for-CqXsIKws.js +221 -0
- package/dist/unpkg/dev/model-fragments.js +76 -0
- package/dist/unpkg/dev/model.js +667 -0
- package/dist/unpkg/dev/runtime-BPCpkOf1-BKOwiRJp.js +65 -0
- package/dist/unpkg/dev/schema-provider-g5MfTj8n.js +2338 -0
- package/dist/unpkg/dev/serialize-into-hash-BnYvPex3.js +261 -0
- package/dist/unpkg/dev/serializer/json-api.js +527 -0
- package/dist/unpkg/dev/serializer/json.js +6 -0
- package/dist/unpkg/dev/serializer/rest.js +1243 -0
- package/dist/unpkg/dev/serializer/transform.js +278 -0
- package/dist/unpkg/dev/serializer.js +248 -0
- package/dist/unpkg/dev/store.js +636 -0
- package/dist/unpkg/dev/util-Dul6TZts.js +35 -0
- package/dist/unpkg/dev/utils-Cqw9eRj5.js +23 -0
- package/dist/unpkg/dev-deprecated/-private-B1pSSN52.js +1210 -0
- package/dist/unpkg/dev-deprecated/adapter/-private.js +1 -0
- package/dist/unpkg/dev-deprecated/adapter/error.js +336 -0
- package/dist/unpkg/dev-deprecated/adapter/json-api.js +132 -0
- package/dist/unpkg/dev-deprecated/adapter/rest.js +1257 -0
- package/dist/unpkg/dev-deprecated/adapter.js +1253 -0
- package/dist/unpkg/dev-deprecated/compat/-private.js +1 -0
- package/dist/unpkg/dev-deprecated/compat/builders.js +273 -0
- package/dist/unpkg/dev-deprecated/compat/extensions.js +243 -0
- package/dist/unpkg/dev-deprecated/compat/utils.js +224 -0
- package/dist/unpkg/dev-deprecated/compat.js +1020 -0
- package/dist/unpkg/dev-deprecated/declarations/adapter/-private/build-url-mixin.d.ts +33 -0
- package/dist/unpkg/dev-deprecated/declarations/adapter/-private/fastboot-interface.d.ts +8 -0
- package/dist/unpkg/dev-deprecated/declarations/adapter/-private/utils/continue-on-reject.d.ts +1 -0
- package/dist/unpkg/dev-deprecated/declarations/adapter/-private/utils/determine-body-promise.d.ts +4 -0
- package/dist/unpkg/dev-deprecated/declarations/adapter/-private/utils/fetch.d.ts +8 -0
- package/dist/unpkg/dev-deprecated/declarations/adapter/-private/utils/parse-response-headers.d.ts +1 -0
- package/dist/unpkg/dev-deprecated/declarations/adapter/-private/utils/serialize-into-hash.d.ts +6 -0
- package/dist/unpkg/dev-deprecated/declarations/adapter/-private/utils/serialize-query-params.d.ts +5 -0
- package/dist/unpkg/dev-deprecated/declarations/adapter/-private.d.ts +5 -0
- package/dist/unpkg/dev-deprecated/declarations/adapter/error.d.ts +215 -0
- package/dist/unpkg/dev-deprecated/declarations/adapter/json-api.d.ts +231 -0
- package/dist/unpkg/dev-deprecated/declarations/adapter/rest.d.ts +815 -0
- package/dist/unpkg/dev-deprecated/declarations/adapter.d.ts +770 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/-private.d.ts +13 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/builders/find-all.d.ts +35 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/builders/find-record.d.ts +56 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/builders/query.d.ts +66 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/builders/save-record.d.ts +34 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/builders/utils.d.ts +3 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/builders.d.ts +14 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/extensions.d.ts +59 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/legacy-network-handler/fetch-manager.d.ts +55 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/legacy-network-handler/identifier-has-id.d.ts +2 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/legacy-network-handler/legacy-data-fetch.d.ts +11 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/legacy-network-handler/legacy-data-utils.d.ts +5 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/legacy-network-handler/legacy-network-handler.d.ts +2 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/legacy-network-handler/minimum-adapter-interface.d.ts +524 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/legacy-network-handler/minimum-serializer-interface.d.ts +213 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/legacy-network-handler/serializer-response.d.ts +6 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/legacy-network-handler/snapshot-record-array.d.ts +110 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/legacy-network-handler/snapshot.d.ts +255 -0
- package/dist/unpkg/dev-deprecated/declarations/compat/utils.d.ts +137 -0
- package/dist/unpkg/dev-deprecated/declarations/compat.d.ts +157 -0
- package/dist/unpkg/dev-deprecated/declarations/index.d.ts +70 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/attr.d.ts +170 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/belongs-to.d.ts +174 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/debug/assert-polymorphic-type.d.ts +5 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/errors.d.ts +289 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/has-many.d.ts +162 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/hooks.d.ts +10 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/legacy-relationships-support.d.ts +47 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/model-for-mixin.d.ts +3 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/model-methods.d.ts +39 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/model.d.ts +1269 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/notify-changes.d.ts +4 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/promise-belongs-to.d.ts +40 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/promise-many-array.d.ts +124 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/record-state.d.ts +58 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/references/belongs-to.d.ts +498 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/references/has-many.d.ts +500 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/schema-provider.d.ts +56 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/type-utils.d.ts +57 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private/util.d.ts +5 -0
- package/dist/unpkg/dev-deprecated/declarations/model/-private.d.ts +8 -0
- package/dist/unpkg/dev-deprecated/declarations/model/migration-support.d.ts +280 -0
- package/dist/unpkg/dev-deprecated/declarations/model-fragments/extensions/fragment-array.d.ts +16 -0
- package/dist/unpkg/dev-deprecated/declarations/model-fragments/extensions/fragment.d.ts +15 -0
- package/dist/unpkg/dev-deprecated/declarations/model-fragments/hooks/model-for.d.ts +20 -0
- package/dist/unpkg/dev-deprecated/declarations/model-fragments/index.d.ts +5 -0
- package/dist/unpkg/dev-deprecated/declarations/model-fragments/instance-initializers/fragment-extensions.d.ts +9 -0
- package/dist/unpkg/dev-deprecated/declarations/model-fragments/utilities/with-array-defaults.d.ts +15 -0
- package/dist/unpkg/dev-deprecated/declarations/model-fragments/utilities/with-fragment-array-defaults.d.ts +20 -0
- package/dist/unpkg/dev-deprecated/declarations/model-fragments/utilities/with-fragment-defaults.d.ts +19 -0
- package/dist/unpkg/dev-deprecated/declarations/model-fragments/utilities/with-legacy.d.ts +3 -0
- package/dist/unpkg/dev-deprecated/declarations/model-fragments.d.ts +9 -0
- package/dist/unpkg/dev-deprecated/declarations/model.d.ts +49 -0
- package/dist/unpkg/dev-deprecated/declarations/serializer/-private/embedded-records-mixin.d.ts +91 -0
- package/dist/unpkg/dev-deprecated/declarations/serializer/-private/transforms/boolean.d.ts +47 -0
- package/dist/unpkg/dev-deprecated/declarations/serializer/-private/transforms/date.d.ts +28 -0
- package/dist/unpkg/dev-deprecated/declarations/serializer/-private/transforms/number.d.ts +29 -0
- package/dist/unpkg/dev-deprecated/declarations/serializer/-private/transforms/string.d.ts +29 -0
- package/dist/unpkg/dev-deprecated/declarations/serializer/-private/transforms/transform.d.ts +118 -0
- package/dist/unpkg/dev-deprecated/declarations/serializer/-private/utils.d.ts +3 -0
- package/dist/unpkg/dev-deprecated/declarations/serializer/json-api.d.ts +123 -0
- package/dist/unpkg/dev-deprecated/declarations/serializer/json.d.ts +75 -0
- package/dist/unpkg/dev-deprecated/declarations/serializer/rest.d.ts +51 -0
- package/dist/unpkg/dev-deprecated/declarations/serializer/transform.d.ts +5 -0
- package/dist/unpkg/dev-deprecated/declarations/serializer.d.ts +254 -0
- package/dist/unpkg/dev-deprecated/declarations/store/-private.d.ts +223 -0
- package/dist/unpkg/dev-deprecated/declarations/store.d.ts +3 -0
- package/dist/unpkg/dev-deprecated/errors-CIGPcDvd.js +2595 -0
- package/dist/unpkg/dev-deprecated/hooks-QqRnX108.js +74 -0
- package/dist/unpkg/dev-deprecated/index.js +195 -0
- package/dist/unpkg/dev-deprecated/json-BNrV8EYG.js +1272 -0
- package/dist/unpkg/dev-deprecated/model/-private.js +1 -0
- package/dist/unpkg/dev-deprecated/model/migration-support.js +579 -0
- package/dist/unpkg/dev-deprecated/model-for-CqXsIKws.js +221 -0
- package/dist/unpkg/dev-deprecated/model-fragments.js +76 -0
- package/dist/unpkg/dev-deprecated/model.js +667 -0
- package/dist/unpkg/dev-deprecated/runtime-BPCpkOf1-BKOwiRJp.js +65 -0
- package/dist/unpkg/dev-deprecated/schema-provider-g5MfTj8n.js +2338 -0
- package/dist/unpkg/dev-deprecated/serialize-into-hash-BnYvPex3.js +261 -0
- package/dist/unpkg/dev-deprecated/serializer/json-api.js +527 -0
- package/dist/unpkg/dev-deprecated/serializer/json.js +6 -0
- package/dist/unpkg/dev-deprecated/serializer/rest.js +1243 -0
- package/dist/unpkg/dev-deprecated/serializer/transform.js +278 -0
- package/dist/unpkg/dev-deprecated/serializer.js +248 -0
- package/dist/unpkg/dev-deprecated/store.js +636 -0
- package/dist/unpkg/dev-deprecated/util-Dul6TZts.js +35 -0
- package/dist/unpkg/dev-deprecated/utils-Cqw9eRj5.js +23 -0
- package/dist/unpkg/prod/-private-B1pSSN52.js +1210 -0
- package/dist/unpkg/prod/adapter/-private.js +1 -0
- package/dist/unpkg/prod/adapter/error.js +336 -0
- package/dist/unpkg/prod/adapter/json-api.js +132 -0
- package/dist/unpkg/prod/adapter/rest.js +1257 -0
- package/dist/unpkg/prod/adapter.js +1253 -0
- package/dist/unpkg/prod/compat/-private.js +1 -0
- package/dist/unpkg/prod/compat/builders.js +273 -0
- package/dist/unpkg/prod/compat/extensions.js +243 -0
- package/dist/unpkg/prod/compat/utils.js +224 -0
- package/dist/unpkg/prod/compat.js +1020 -0
- package/dist/unpkg/prod/declarations/adapter/-private/build-url-mixin.d.ts +33 -0
- package/dist/unpkg/prod/declarations/adapter/-private/fastboot-interface.d.ts +8 -0
- package/dist/unpkg/prod/declarations/adapter/-private/utils/continue-on-reject.d.ts +1 -0
- package/dist/unpkg/prod/declarations/adapter/-private/utils/determine-body-promise.d.ts +4 -0
- package/dist/unpkg/prod/declarations/adapter/-private/utils/fetch.d.ts +8 -0
- package/dist/unpkg/prod/declarations/adapter/-private/utils/parse-response-headers.d.ts +1 -0
- package/dist/unpkg/prod/declarations/adapter/-private/utils/serialize-into-hash.d.ts +6 -0
- package/dist/unpkg/prod/declarations/adapter/-private/utils/serialize-query-params.d.ts +5 -0
- package/dist/unpkg/prod/declarations/adapter/-private.d.ts +5 -0
- package/dist/unpkg/prod/declarations/adapter/error.d.ts +215 -0
- package/dist/unpkg/prod/declarations/adapter/json-api.d.ts +231 -0
- package/dist/unpkg/prod/declarations/adapter/rest.d.ts +815 -0
- package/dist/unpkg/prod/declarations/adapter.d.ts +770 -0
- package/dist/unpkg/prod/declarations/compat/-private.d.ts +13 -0
- package/dist/unpkg/prod/declarations/compat/builders/find-all.d.ts +35 -0
- package/dist/unpkg/prod/declarations/compat/builders/find-record.d.ts +56 -0
- package/dist/unpkg/prod/declarations/compat/builders/query.d.ts +66 -0
- package/dist/unpkg/prod/declarations/compat/builders/save-record.d.ts +34 -0
- package/dist/unpkg/prod/declarations/compat/builders/utils.d.ts +3 -0
- package/dist/unpkg/prod/declarations/compat/builders.d.ts +14 -0
- package/dist/unpkg/prod/declarations/compat/extensions.d.ts +59 -0
- package/dist/unpkg/prod/declarations/compat/legacy-network-handler/fetch-manager.d.ts +55 -0
- package/dist/unpkg/prod/declarations/compat/legacy-network-handler/identifier-has-id.d.ts +2 -0
- package/dist/unpkg/prod/declarations/compat/legacy-network-handler/legacy-data-fetch.d.ts +11 -0
- package/dist/unpkg/prod/declarations/compat/legacy-network-handler/legacy-data-utils.d.ts +5 -0
- package/dist/unpkg/prod/declarations/compat/legacy-network-handler/legacy-network-handler.d.ts +2 -0
- package/dist/unpkg/prod/declarations/compat/legacy-network-handler/minimum-adapter-interface.d.ts +524 -0
- package/dist/unpkg/prod/declarations/compat/legacy-network-handler/minimum-serializer-interface.d.ts +213 -0
- package/dist/unpkg/prod/declarations/compat/legacy-network-handler/serializer-response.d.ts +6 -0
- package/dist/unpkg/prod/declarations/compat/legacy-network-handler/snapshot-record-array.d.ts +110 -0
- package/dist/unpkg/prod/declarations/compat/legacy-network-handler/snapshot.d.ts +255 -0
- package/dist/unpkg/prod/declarations/compat/utils.d.ts +137 -0
- package/dist/unpkg/prod/declarations/compat.d.ts +157 -0
- package/dist/unpkg/prod/declarations/index.d.ts +70 -0
- package/dist/unpkg/prod/declarations/model/-private/attr.d.ts +170 -0
- package/dist/unpkg/prod/declarations/model/-private/belongs-to.d.ts +174 -0
- package/dist/unpkg/prod/declarations/model/-private/debug/assert-polymorphic-type.d.ts +5 -0
- package/dist/unpkg/prod/declarations/model/-private/errors.d.ts +289 -0
- package/dist/unpkg/prod/declarations/model/-private/has-many.d.ts +162 -0
- package/dist/unpkg/prod/declarations/model/-private/hooks.d.ts +10 -0
- package/dist/unpkg/prod/declarations/model/-private/legacy-relationships-support.d.ts +47 -0
- package/dist/unpkg/prod/declarations/model/-private/model-for-mixin.d.ts +3 -0
- package/dist/unpkg/prod/declarations/model/-private/model-methods.d.ts +39 -0
- package/dist/unpkg/prod/declarations/model/-private/model.d.ts +1269 -0
- package/dist/unpkg/prod/declarations/model/-private/notify-changes.d.ts +4 -0
- package/dist/unpkg/prod/declarations/model/-private/promise-belongs-to.d.ts +40 -0
- package/dist/unpkg/prod/declarations/model/-private/promise-many-array.d.ts +124 -0
- package/dist/unpkg/prod/declarations/model/-private/record-state.d.ts +58 -0
- package/dist/unpkg/prod/declarations/model/-private/references/belongs-to.d.ts +498 -0
- package/dist/unpkg/prod/declarations/model/-private/references/has-many.d.ts +500 -0
- package/dist/unpkg/prod/declarations/model/-private/schema-provider.d.ts +56 -0
- package/dist/unpkg/prod/declarations/model/-private/type-utils.d.ts +57 -0
- package/dist/unpkg/prod/declarations/model/-private/util.d.ts +5 -0
- package/dist/unpkg/prod/declarations/model/-private.d.ts +8 -0
- package/dist/unpkg/prod/declarations/model/migration-support.d.ts +280 -0
- package/dist/unpkg/prod/declarations/model-fragments/extensions/fragment-array.d.ts +16 -0
- package/dist/unpkg/prod/declarations/model-fragments/extensions/fragment.d.ts +15 -0
- package/dist/unpkg/prod/declarations/model-fragments/hooks/model-for.d.ts +20 -0
- package/dist/unpkg/prod/declarations/model-fragments/index.d.ts +5 -0
- package/dist/unpkg/prod/declarations/model-fragments/instance-initializers/fragment-extensions.d.ts +9 -0
- package/dist/unpkg/prod/declarations/model-fragments/utilities/with-array-defaults.d.ts +15 -0
- package/dist/unpkg/prod/declarations/model-fragments/utilities/with-fragment-array-defaults.d.ts +20 -0
- package/dist/unpkg/prod/declarations/model-fragments/utilities/with-fragment-defaults.d.ts +19 -0
- package/dist/unpkg/prod/declarations/model-fragments/utilities/with-legacy.d.ts +3 -0
- package/dist/unpkg/prod/declarations/model-fragments.d.ts +9 -0
- package/dist/unpkg/prod/declarations/model.d.ts +49 -0
- package/dist/unpkg/prod/declarations/serializer/-private/embedded-records-mixin.d.ts +91 -0
- package/dist/unpkg/prod/declarations/serializer/-private/transforms/boolean.d.ts +47 -0
- package/dist/unpkg/prod/declarations/serializer/-private/transforms/date.d.ts +28 -0
- package/dist/unpkg/prod/declarations/serializer/-private/transforms/number.d.ts +29 -0
- package/dist/unpkg/prod/declarations/serializer/-private/transforms/string.d.ts +29 -0
- package/dist/unpkg/prod/declarations/serializer/-private/transforms/transform.d.ts +118 -0
- package/dist/unpkg/prod/declarations/serializer/-private/utils.d.ts +3 -0
- package/dist/unpkg/prod/declarations/serializer/json-api.d.ts +123 -0
- package/dist/unpkg/prod/declarations/serializer/json.d.ts +75 -0
- package/dist/unpkg/prod/declarations/serializer/rest.d.ts +51 -0
- package/dist/unpkg/prod/declarations/serializer/transform.d.ts +5 -0
- package/dist/unpkg/prod/declarations/serializer.d.ts +254 -0
- package/dist/unpkg/prod/declarations/store/-private.d.ts +223 -0
- package/dist/unpkg/prod/declarations/store.d.ts +3 -0
- package/dist/unpkg/prod/errors-CIGPcDvd.js +2595 -0
- package/dist/unpkg/prod/hooks-QqRnX108.js +74 -0
- package/dist/unpkg/prod/index.js +195 -0
- package/dist/unpkg/prod/json-BNrV8EYG.js +1272 -0
- package/dist/unpkg/prod/model/-private.js +1 -0
- package/dist/unpkg/prod/model/migration-support.js +579 -0
- package/dist/unpkg/prod/model-for-CqXsIKws.js +221 -0
- package/dist/unpkg/prod/model-fragments.js +76 -0
- package/dist/unpkg/prod/model.js +667 -0
- package/dist/unpkg/prod/runtime-BPCpkOf1-BKOwiRJp.js +65 -0
- package/dist/unpkg/prod/schema-provider-g5MfTj8n.js +2338 -0
- package/dist/unpkg/prod/serialize-into-hash-BnYvPex3.js +261 -0
- package/dist/unpkg/prod/serializer/json-api.js +527 -0
- package/dist/unpkg/prod/serializer/json.js +6 -0
- package/dist/unpkg/prod/serializer/rest.js +1243 -0
- package/dist/unpkg/prod/serializer/transform.js +278 -0
- package/dist/unpkg/prod/serializer.js +248 -0
- package/dist/unpkg/prod/store.js +636 -0
- package/dist/unpkg/prod/util-Dul6TZts.js +35 -0
- package/dist/unpkg/prod/utils-Cqw9eRj5.js +23 -0
- package/dist/unpkg/prod-deprecated/-private-B1pSSN52.js +1210 -0
- package/dist/unpkg/prod-deprecated/adapter/-private.js +1 -0
- package/dist/unpkg/prod-deprecated/adapter/error.js +336 -0
- package/dist/unpkg/prod-deprecated/adapter/json-api.js +132 -0
- package/dist/unpkg/prod-deprecated/adapter/rest.js +1257 -0
- package/dist/unpkg/prod-deprecated/adapter.js +1253 -0
- package/dist/unpkg/prod-deprecated/compat/-private.js +1 -0
- package/dist/unpkg/prod-deprecated/compat/builders.js +273 -0
- package/dist/unpkg/prod-deprecated/compat/extensions.js +243 -0
- package/dist/unpkg/prod-deprecated/compat/utils.js +224 -0
- package/dist/unpkg/prod-deprecated/compat.js +1020 -0
- package/dist/unpkg/prod-deprecated/declarations/adapter/-private/build-url-mixin.d.ts +33 -0
- package/dist/unpkg/prod-deprecated/declarations/adapter/-private/fastboot-interface.d.ts +8 -0
- package/dist/unpkg/prod-deprecated/declarations/adapter/-private/utils/continue-on-reject.d.ts +1 -0
- package/dist/unpkg/prod-deprecated/declarations/adapter/-private/utils/determine-body-promise.d.ts +4 -0
- package/dist/unpkg/prod-deprecated/declarations/adapter/-private/utils/fetch.d.ts +8 -0
- package/dist/unpkg/prod-deprecated/declarations/adapter/-private/utils/parse-response-headers.d.ts +1 -0
- package/dist/unpkg/prod-deprecated/declarations/adapter/-private/utils/serialize-into-hash.d.ts +6 -0
- package/dist/unpkg/prod-deprecated/declarations/adapter/-private/utils/serialize-query-params.d.ts +5 -0
- package/dist/unpkg/prod-deprecated/declarations/adapter/-private.d.ts +5 -0
- package/dist/unpkg/prod-deprecated/declarations/adapter/error.d.ts +215 -0
- package/dist/unpkg/prod-deprecated/declarations/adapter/json-api.d.ts +231 -0
- package/dist/unpkg/prod-deprecated/declarations/adapter/rest.d.ts +815 -0
- package/dist/unpkg/prod-deprecated/declarations/adapter.d.ts +770 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/-private.d.ts +13 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/builders/find-all.d.ts +35 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/builders/find-record.d.ts +56 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/builders/query.d.ts +66 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/builders/save-record.d.ts +34 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/builders/utils.d.ts +3 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/builders.d.ts +14 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/extensions.d.ts +59 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/legacy-network-handler/fetch-manager.d.ts +55 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/legacy-network-handler/identifier-has-id.d.ts +2 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/legacy-network-handler/legacy-data-fetch.d.ts +11 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/legacy-network-handler/legacy-data-utils.d.ts +5 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/legacy-network-handler/legacy-network-handler.d.ts +2 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/legacy-network-handler/minimum-adapter-interface.d.ts +524 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/legacy-network-handler/minimum-serializer-interface.d.ts +213 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/legacy-network-handler/serializer-response.d.ts +6 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/legacy-network-handler/snapshot-record-array.d.ts +110 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/legacy-network-handler/snapshot.d.ts +255 -0
- package/dist/unpkg/prod-deprecated/declarations/compat/utils.d.ts +137 -0
- package/dist/unpkg/prod-deprecated/declarations/compat.d.ts +157 -0
- package/dist/unpkg/prod-deprecated/declarations/index.d.ts +70 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/attr.d.ts +170 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/belongs-to.d.ts +174 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/debug/assert-polymorphic-type.d.ts +5 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/errors.d.ts +289 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/has-many.d.ts +162 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/hooks.d.ts +10 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/legacy-relationships-support.d.ts +47 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/model-for-mixin.d.ts +3 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/model-methods.d.ts +39 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/model.d.ts +1269 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/notify-changes.d.ts +4 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/promise-belongs-to.d.ts +40 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/promise-many-array.d.ts +124 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/record-state.d.ts +58 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/references/belongs-to.d.ts +498 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/references/has-many.d.ts +500 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/schema-provider.d.ts +56 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/type-utils.d.ts +57 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private/util.d.ts +5 -0
- package/dist/unpkg/prod-deprecated/declarations/model/-private.d.ts +8 -0
- package/dist/unpkg/prod-deprecated/declarations/model/migration-support.d.ts +280 -0
- package/dist/unpkg/prod-deprecated/declarations/model-fragments/extensions/fragment-array.d.ts +16 -0
- package/dist/unpkg/prod-deprecated/declarations/model-fragments/extensions/fragment.d.ts +15 -0
- package/dist/unpkg/prod-deprecated/declarations/model-fragments/hooks/model-for.d.ts +20 -0
- package/dist/unpkg/prod-deprecated/declarations/model-fragments/index.d.ts +5 -0
- package/dist/unpkg/prod-deprecated/declarations/model-fragments/instance-initializers/fragment-extensions.d.ts +9 -0
- package/dist/unpkg/prod-deprecated/declarations/model-fragments/utilities/with-array-defaults.d.ts +15 -0
- package/dist/unpkg/prod-deprecated/declarations/model-fragments/utilities/with-fragment-array-defaults.d.ts +20 -0
- package/dist/unpkg/prod-deprecated/declarations/model-fragments/utilities/with-fragment-defaults.d.ts +19 -0
- package/dist/unpkg/prod-deprecated/declarations/model-fragments/utilities/with-legacy.d.ts +3 -0
- package/dist/unpkg/prod-deprecated/declarations/model-fragments.d.ts +9 -0
- package/dist/unpkg/prod-deprecated/declarations/model.d.ts +49 -0
- package/dist/unpkg/prod-deprecated/declarations/serializer/-private/embedded-records-mixin.d.ts +91 -0
- package/dist/unpkg/prod-deprecated/declarations/serializer/-private/transforms/boolean.d.ts +47 -0
- package/dist/unpkg/prod-deprecated/declarations/serializer/-private/transforms/date.d.ts +28 -0
- package/dist/unpkg/prod-deprecated/declarations/serializer/-private/transforms/number.d.ts +29 -0
- package/dist/unpkg/prod-deprecated/declarations/serializer/-private/transforms/string.d.ts +29 -0
- package/dist/unpkg/prod-deprecated/declarations/serializer/-private/transforms/transform.d.ts +118 -0
- package/dist/unpkg/prod-deprecated/declarations/serializer/-private/utils.d.ts +3 -0
- package/dist/unpkg/prod-deprecated/declarations/serializer/json-api.d.ts +123 -0
- package/dist/unpkg/prod-deprecated/declarations/serializer/json.d.ts +75 -0
- package/dist/unpkg/prod-deprecated/declarations/serializer/rest.d.ts +51 -0
- package/dist/unpkg/prod-deprecated/declarations/serializer/transform.d.ts +5 -0
- package/dist/unpkg/prod-deprecated/declarations/serializer.d.ts +254 -0
- package/dist/unpkg/prod-deprecated/declarations/store/-private.d.ts +223 -0
- package/dist/unpkg/prod-deprecated/declarations/store.d.ts +3 -0
- package/dist/unpkg/prod-deprecated/errors-CIGPcDvd.js +2595 -0
- package/dist/unpkg/prod-deprecated/hooks-QqRnX108.js +74 -0
- package/dist/unpkg/prod-deprecated/index.js +195 -0
- package/dist/unpkg/prod-deprecated/json-BNrV8EYG.js +1272 -0
- package/dist/unpkg/prod-deprecated/model/-private.js +1 -0
- package/dist/unpkg/prod-deprecated/model/migration-support.js +579 -0
- package/dist/unpkg/prod-deprecated/model-for-CqXsIKws.js +221 -0
- package/dist/unpkg/prod-deprecated/model-fragments.js +76 -0
- package/dist/unpkg/prod-deprecated/model.js +667 -0
- package/dist/unpkg/prod-deprecated/runtime-BPCpkOf1-BKOwiRJp.js +65 -0
- package/dist/unpkg/prod-deprecated/schema-provider-g5MfTj8n.js +2338 -0
- package/dist/unpkg/prod-deprecated/serialize-into-hash-BnYvPex3.js +261 -0
- package/dist/unpkg/prod-deprecated/serializer/json-api.js +527 -0
- package/dist/unpkg/prod-deprecated/serializer/json.js +6 -0
- package/dist/unpkg/prod-deprecated/serializer/rest.js +1243 -0
- package/dist/unpkg/prod-deprecated/serializer/transform.js +278 -0
- package/dist/unpkg/prod-deprecated/serializer.js +248 -0
- package/dist/unpkg/prod-deprecated/store.js +636 -0
- package/dist/unpkg/prod-deprecated/util-Dul6TZts.js +35 -0
- package/dist/unpkg/prod-deprecated/utils-Cqw9eRj5.js +23 -0
- package/package.json +30 -6
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
import type { TypeFromInstance } from "@warp-drive/core/types/record";
|
|
2
|
+
export type IsUnknown<T> = unknown extends T ? true : false;
|
|
3
|
+
export type RelationshipOptions<
|
|
4
|
+
T,
|
|
5
|
+
Async extends boolean
|
|
6
|
+
> = {
|
|
7
|
+
async: Async;
|
|
8
|
+
inverse: null | (IsUnknown<T> extends true ? string : keyof NoNull<T> & string);
|
|
9
|
+
polymorphic?: boolean;
|
|
10
|
+
as?: string;
|
|
11
|
+
linksMode?: true;
|
|
12
|
+
resetOnRemoteUpdate?: boolean;
|
|
13
|
+
};
|
|
14
|
+
export type NoNull<T> = Exclude<T, null>;
|
|
15
|
+
export type RelationshipDecorator<T> = <This>(target: This, key: string, desc?: PropertyDescriptor) => void;
|
|
16
|
+
/**
|
|
17
|
+
`belongsTo` is used to define One-To-One and One-To-Many, and One-To-None
|
|
18
|
+
relationships on a {@link Model}.
|
|
19
|
+
|
|
20
|
+
`belongsTo` takes a configuration hash as a second parameter, currently
|
|
21
|
+
supported options are:
|
|
22
|
+
|
|
23
|
+
- `async`: (*required*) A boolean value used to declare whether this is a sync (false) or async (true) relationship.
|
|
24
|
+
- `inverse`: (*required*) A string used to identify the inverse property on a related model, or `null`.
|
|
25
|
+
- `polymorphic`: (*optional*) A boolean value to mark the relationship as polymorphic
|
|
26
|
+
- `as`: (*optional*) A string used to declare the abstract type "this" record satisfies for polymorphism.
|
|
27
|
+
|
|
28
|
+
### Examples
|
|
29
|
+
|
|
30
|
+
To declare a **one-to-many** (or many-to-many) relationship, use
|
|
31
|
+
`belongsTo` in combination with `hasMany`:
|
|
32
|
+
|
|
33
|
+
```js
|
|
34
|
+
// app/models/comment.js
|
|
35
|
+
import { Model, belongsTo } from '@warp-drive/legacy/model';
|
|
36
|
+
|
|
37
|
+
export default class Comment extends Model {
|
|
38
|
+
@belongsTo('post', { async: false, inverse: 'comments' }) post;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
// app/models/post.js
|
|
42
|
+
import { Model, hasMany } from '@warp-drive/legacy/model';
|
|
43
|
+
|
|
44
|
+
export default class Post extends Model {
|
|
45
|
+
@hasMany('comment', { async: false, inverse: 'post' }) comments;
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
To declare a **one-to-one** relationship with managed inverses, use `belongsTo` for both sides:
|
|
50
|
+
|
|
51
|
+
```js
|
|
52
|
+
// app/models/author.js
|
|
53
|
+
import { Model, belongsTo } from '@warp-drive/legacy/model';
|
|
54
|
+
|
|
55
|
+
export default class Author extends Model {
|
|
56
|
+
@belongsTo('address', { async: true, inverse: 'owner' }) address;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
// app/models/address.js
|
|
60
|
+
import { Model, belongsTo } from '@warp-drive/legacy/model';
|
|
61
|
+
|
|
62
|
+
export default class Address extends Model {
|
|
63
|
+
@belongsTo('author', { async: true, inverse: 'address' }) owner;
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
To declare a **one-to-one** relationship without managed inverses, use `belongsTo` for both sides
|
|
68
|
+
with `null` as the inverse:
|
|
69
|
+
|
|
70
|
+
```js
|
|
71
|
+
// app/models/author.js
|
|
72
|
+
import { Model, belongsTo } from '@warp-drive/legacy/model';
|
|
73
|
+
|
|
74
|
+
export default class Author extends Model {
|
|
75
|
+
@belongsTo('address', { async: true, inverse: null }) address;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
// app/models/address.js
|
|
79
|
+
import { Model, belongsTo } from '@warp-drive/legacy/model';
|
|
80
|
+
|
|
81
|
+
export default class Address extends Model {
|
|
82
|
+
@belongsTo('author', { async: true, inverse: null }) owner;
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
To declare a one-to-none relationship between two models, use
|
|
87
|
+
`belongsTo` with inverse set to `null` on just one side::
|
|
88
|
+
|
|
89
|
+
```js
|
|
90
|
+
// app/models/person.js
|
|
91
|
+
import { Model, belongsTo } from '@warp-drive/legacy/model';
|
|
92
|
+
|
|
93
|
+
export default class Person extends Model {
|
|
94
|
+
@belongsTo('person', { async: false, inverse: null }) bestFriend;
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
#### Sync vs Async Relationships
|
|
99
|
+
|
|
100
|
+
WarpDrive fulfills relationships using resource data available in
|
|
101
|
+
the cache.
|
|
102
|
+
|
|
103
|
+
Sync relationships point directly to the known related resources.
|
|
104
|
+
|
|
105
|
+
When a relationship is declared as async, if any of the known related
|
|
106
|
+
resources have not been loaded, they will be fetched. The property
|
|
107
|
+
on the record when accessed provides a promise that resolves once
|
|
108
|
+
all resources are loaded.
|
|
109
|
+
|
|
110
|
+
Async relationships may take advantage of links. On access, if the related
|
|
111
|
+
link has not been loaded, or if any known resources are not available in
|
|
112
|
+
the cache, the fresh state will be fetched using the link.
|
|
113
|
+
|
|
114
|
+
In contrast to async relationship, accessing a sync relationship
|
|
115
|
+
will error on access when any of the known related resources have
|
|
116
|
+
not been loaded.
|
|
117
|
+
|
|
118
|
+
If you are using `links` with sync relationships, you have to use
|
|
119
|
+
the BelongsTo reference API to fetch or refresh related resources
|
|
120
|
+
that aren't loaded. For instance, for a `bestFriend` relationship:
|
|
121
|
+
|
|
122
|
+
```js
|
|
123
|
+
person.belongsTo('bestFriend').reload();
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
#### Polymorphic Relationships
|
|
127
|
+
|
|
128
|
+
To declare a polymorphic relationship, use `hasMany` with the `polymorphic`
|
|
129
|
+
option set to `true`:
|
|
130
|
+
|
|
131
|
+
```js
|
|
132
|
+
// app/models/comment.js
|
|
133
|
+
import { Model, belongsTo } from '@warp-drive/legacy/model';
|
|
134
|
+
|
|
135
|
+
export default class Comment extends Model {
|
|
136
|
+
@belongsTo('commentable', { async: false, inverse: 'comments', polymorphic: true }) parent;
|
|
137
|
+
}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
`'commentable'` here is referred to as the "abstract type" for the polymorphic
|
|
141
|
+
relationship.
|
|
142
|
+
|
|
143
|
+
Polymorphic relationships with `inverse: null` will accept any type of record as their content.
|
|
144
|
+
Polymorphic relationships with `inverse` set to a string will only accept records with a matching
|
|
145
|
+
inverse relationships declaring itself as satisfying the abstract type.
|
|
146
|
+
|
|
147
|
+
Below, 'as' is used to declare the that 'post' record satisfies the abstract type 'commentable'
|
|
148
|
+
for this relationship.
|
|
149
|
+
|
|
150
|
+
```js
|
|
151
|
+
// app/models/post.js
|
|
152
|
+
import { Model, hasMany } from '@warp-drive/legacy/model';
|
|
153
|
+
|
|
154
|
+
export default class Post extends Model {
|
|
155
|
+
@hasMany('comment', { async: false, inverse: 'parent', as: 'commentable' }) comments;
|
|
156
|
+
}
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
Note: every Model that declares an inverse to a polymorphic relationship must
|
|
160
|
+
declare itself exactly the same. This is because polymorphism is based on structural
|
|
161
|
+
traits.
|
|
162
|
+
|
|
163
|
+
Polymorphic to polymorphic relationships are supported. Both sides of the relationship
|
|
164
|
+
must be declared as polymorphic, and the `as` option must be used to declare the abstract
|
|
165
|
+
type each record satisfies on both sides.
|
|
166
|
+
|
|
167
|
+
@public
|
|
168
|
+
@param type the name of the related resource
|
|
169
|
+
@param options a hash of options
|
|
170
|
+
*/
|
|
171
|
+
export declare function belongsTo(): never;
|
|
172
|
+
export declare function belongsTo(type: string): never;
|
|
173
|
+
export declare function belongsTo<T>(type: TypeFromInstance<NoNull<T>>, options: RelationshipOptions<T, boolean>): RelationshipDecorator<T>;
|
|
174
|
+
export declare function belongsTo(type: string, options: RelationshipOptions<unknown, boolean>): RelationshipDecorator<unknown>;
|
package/dist/unpkg/dev-deprecated/declarations/model/-private/debug/assert-polymorphic-type.d.ts
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { Store } from "@warp-drive/core";
|
|
2
|
+
import type { UpgradedMeta } from "@warp-drive/core/graph/-private";
|
|
3
|
+
import type { ResourceKey } from "@warp-drive/core/types/identifier";
|
|
4
|
+
declare let assertPolymorphicType: (parentIdentifier: ResourceKey, parentDefinition: UpgradedMeta, addedIdentifier: ResourceKey, store: Store) => void;
|
|
5
|
+
export { assertPolymorphicType };
|
|
@@ -0,0 +1,289 @@
|
|
|
1
|
+
import { type NativeArray } from "@ember/array";
|
|
2
|
+
import ArrayProxy from "@ember/array/proxy";
|
|
3
|
+
import type RecordState from "./record-state.js";
|
|
4
|
+
type ValidationError = {
|
|
5
|
+
attribute: string;
|
|
6
|
+
message: string;
|
|
7
|
+
};
|
|
8
|
+
interface ArrayProxyWithCustomOverrides<T> extends Omit<ArrayProxy<T>, "clear" | "content"> {
|
|
9
|
+
content: NativeArray<T>;
|
|
10
|
+
clear(): void;
|
|
11
|
+
_has(name: string): boolean;
|
|
12
|
+
}
|
|
13
|
+
declare const ArrayProxyWithCustomOverrides: new <T>() => ArrayProxyWithCustomOverrides<T>;
|
|
14
|
+
/**
|
|
15
|
+
Holds validation errors for a given record, organized by attribute names.
|
|
16
|
+
|
|
17
|
+
This class is not directly instantiable.
|
|
18
|
+
|
|
19
|
+
Every `Model` has an `errors` property that is an instance of
|
|
20
|
+
`Errors`. This can be used to display validation error
|
|
21
|
+
messages returned from the server when a `record.save()` rejects.
|
|
22
|
+
|
|
23
|
+
For Example, if you had a `User` model that looked like this:
|
|
24
|
+
|
|
25
|
+
```js [app/models/user.js]
|
|
26
|
+
import { Model, attr } from '@warp-drive/legacy/model';
|
|
27
|
+
|
|
28
|
+
export default class UserModel extends Model {
|
|
29
|
+
@attr('string') username;
|
|
30
|
+
@attr('string') email;
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
And you attempted to save a record that did not validate on the backend:
|
|
34
|
+
|
|
35
|
+
```javascript
|
|
36
|
+
let user = store.createRecord('user', {
|
|
37
|
+
username: 'tomster',
|
|
38
|
+
email: 'invalidEmail'
|
|
39
|
+
});
|
|
40
|
+
user.save();
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Your backend would be expected to return an error response that described
|
|
44
|
+
the problem, so that error messages can be generated on the app.
|
|
45
|
+
|
|
46
|
+
API responses will be translated into instances of `Errors` differently,
|
|
47
|
+
depending on the specific combination of adapter and serializer used. You
|
|
48
|
+
may want to check the documentation or the source code of the libraries
|
|
49
|
+
that you are using, to know how they expect errors to be communicated.
|
|
50
|
+
|
|
51
|
+
Errors can be displayed to the user by accessing their property name
|
|
52
|
+
to get an array of all the error objects for that property. Each
|
|
53
|
+
error object is a JavaScript object with two keys:
|
|
54
|
+
|
|
55
|
+
- `message` A string containing the error message from the backend
|
|
56
|
+
- `attribute` The name of the property associated with this error message
|
|
57
|
+
|
|
58
|
+
```handlebars
|
|
59
|
+
<label>Username: <Input @value={{@model.username}} /> </label>
|
|
60
|
+
{{#each @model.errors.username as |error|}}
|
|
61
|
+
<div class="error">
|
|
62
|
+
{{error.message}}
|
|
63
|
+
</div>
|
|
64
|
+
{{/each}}
|
|
65
|
+
|
|
66
|
+
<label>Email: <Input @value={{@model.email}} /> </label>
|
|
67
|
+
{{#each @model.errors.email as |error|}}
|
|
68
|
+
<div class="error">
|
|
69
|
+
{{error.message}}
|
|
70
|
+
</div>
|
|
71
|
+
{{/each}}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
You can also access the special `messages` property on the error
|
|
75
|
+
object to get an array of all the error strings.
|
|
76
|
+
|
|
77
|
+
```handlebars
|
|
78
|
+
{{#each @model.errors.messages as |message|}}
|
|
79
|
+
<div class="error">
|
|
80
|
+
{{message}}
|
|
81
|
+
</div>
|
|
82
|
+
{{/each}}
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
@class Errors
|
|
86
|
+
@public
|
|
87
|
+
*/
|
|
88
|
+
export declare class Errors extends ArrayProxyWithCustomOverrides<ValidationError> {
|
|
89
|
+
__record: {
|
|
90
|
+
currentState: RecordState;
|
|
91
|
+
};
|
|
92
|
+
/**
|
|
93
|
+
@property errorsByAttributeName
|
|
94
|
+
@type {MapWithDefault}
|
|
95
|
+
@private
|
|
96
|
+
*/
|
|
97
|
+
get errorsByAttributeName(): Map<string, NativeArray<ValidationError>>;
|
|
98
|
+
/**
|
|
99
|
+
Returns errors for a given attribute
|
|
100
|
+
|
|
101
|
+
```javascript
|
|
102
|
+
let user = store.createRecord('user', {
|
|
103
|
+
username: 'tomster',
|
|
104
|
+
email: 'invalidEmail'
|
|
105
|
+
});
|
|
106
|
+
user.save().catch(function(){
|
|
107
|
+
user.errors.errorsFor('email'); // returns:
|
|
108
|
+
// [{attribute: "email", message: "Doesn't look like a valid email."}]
|
|
109
|
+
});
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
@public
|
|
113
|
+
@param {String} attribute
|
|
114
|
+
@return {Array}
|
|
115
|
+
*/
|
|
116
|
+
errorsFor(attribute: string): NativeArray<ValidationError>;
|
|
117
|
+
/**
|
|
118
|
+
An array containing all of the error messages for this
|
|
119
|
+
record. This is useful for displaying all errors to the user.
|
|
120
|
+
|
|
121
|
+
```handlebars
|
|
122
|
+
{{#each @model.errors.messages as |message|}}
|
|
123
|
+
<div class="error">
|
|
124
|
+
{{message}}
|
|
125
|
+
</div>
|
|
126
|
+
{{/each}}
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
@property messages
|
|
130
|
+
@public
|
|
131
|
+
@type {Array}
|
|
132
|
+
*/
|
|
133
|
+
messages: string[];
|
|
134
|
+
/**
|
|
135
|
+
@property content
|
|
136
|
+
@type {Array}
|
|
137
|
+
@private
|
|
138
|
+
*/
|
|
139
|
+
get content(): NativeArray<ValidationError>;
|
|
140
|
+
/**
|
|
141
|
+
@private
|
|
142
|
+
*/
|
|
143
|
+
unknownProperty(attribute: string): NativeArray<ValidationError> | undefined;
|
|
144
|
+
/**
|
|
145
|
+
Total number of errors.
|
|
146
|
+
|
|
147
|
+
@property length
|
|
148
|
+
@type {Number}
|
|
149
|
+
@public
|
|
150
|
+
@readonly
|
|
151
|
+
*/
|
|
152
|
+
/**
|
|
153
|
+
`true` if we have no errors.
|
|
154
|
+
|
|
155
|
+
@property isEmpty
|
|
156
|
+
@type {Boolean}
|
|
157
|
+
@public
|
|
158
|
+
@readonly
|
|
159
|
+
*/
|
|
160
|
+
isEmpty: boolean;
|
|
161
|
+
/**
|
|
162
|
+
Manually adds errors to the record. This will trigger the `becameInvalid` event/ lifecycle method on
|
|
163
|
+
the record and transition the record into an `invalid` state.
|
|
164
|
+
|
|
165
|
+
Example
|
|
166
|
+
```javascript
|
|
167
|
+
let errors = user.errors;
|
|
168
|
+
|
|
169
|
+
// add multiple errors
|
|
170
|
+
errors.add('password', [
|
|
171
|
+
'Must be at least 12 characters',
|
|
172
|
+
'Must contain at least one symbol',
|
|
173
|
+
'Cannot contain your name'
|
|
174
|
+
]);
|
|
175
|
+
|
|
176
|
+
errors.errorsFor('password');
|
|
177
|
+
// =>
|
|
178
|
+
// [
|
|
179
|
+
// { attribute: 'password', message: 'Must be at least 12 characters' },
|
|
180
|
+
// { attribute: 'password', message: 'Must contain at least one symbol' },
|
|
181
|
+
// { attribute: 'password', message: 'Cannot contain your name' },
|
|
182
|
+
// ]
|
|
183
|
+
|
|
184
|
+
// add a single error
|
|
185
|
+
errors.add('username', 'This field is required');
|
|
186
|
+
|
|
187
|
+
errors.errorsFor('username');
|
|
188
|
+
// =>
|
|
189
|
+
// [
|
|
190
|
+
// { attribute: 'username', message: 'This field is required' },
|
|
191
|
+
// ]
|
|
192
|
+
```
|
|
193
|
+
@public
|
|
194
|
+
@param {String} attribute - the property name of an attribute or relationship
|
|
195
|
+
@param {string[]|string} messages - an error message or array of error messages for the attribute
|
|
196
|
+
*/
|
|
197
|
+
add(attribute: string, messages: string[] | string): void;
|
|
198
|
+
/**
|
|
199
|
+
@private
|
|
200
|
+
*/
|
|
201
|
+
_findOrCreateMessages(attribute: string, messages: string | string[]): ValidationError[];
|
|
202
|
+
/**
|
|
203
|
+
Manually removes all errors for a given member from the record.
|
|
204
|
+
This will transition the record into a `valid` state, and
|
|
205
|
+
triggers the `becameValid` event and lifecycle method.
|
|
206
|
+
|
|
207
|
+
Example:
|
|
208
|
+
|
|
209
|
+
```javascript
|
|
210
|
+
let errors = user.errors;
|
|
211
|
+
errors.add('phone', ['error-1', 'error-2']);
|
|
212
|
+
|
|
213
|
+
errors.errorsFor('phone');
|
|
214
|
+
// =>
|
|
215
|
+
// [
|
|
216
|
+
// { attribute: 'phone', message: 'error-1' },
|
|
217
|
+
// { attribute: 'phone', message: 'error-2' },
|
|
218
|
+
// ]
|
|
219
|
+
|
|
220
|
+
errors.remove('phone');
|
|
221
|
+
|
|
222
|
+
errors.errorsFor('phone');
|
|
223
|
+
// => undefined
|
|
224
|
+
```
|
|
225
|
+
@public
|
|
226
|
+
@param {String} member - the property name of an attribute or relationship
|
|
227
|
+
*/
|
|
228
|
+
remove(attribute: string): void;
|
|
229
|
+
/**
|
|
230
|
+
Manually clears all errors for the record.
|
|
231
|
+
This will transition the record into a `valid` state, and
|
|
232
|
+
will trigger the `becameValid` event and lifecycle method.
|
|
233
|
+
|
|
234
|
+
Example:
|
|
235
|
+
|
|
236
|
+
```javascript
|
|
237
|
+
let errors = user.errors;
|
|
238
|
+
errors.add('username', ['error-a']);
|
|
239
|
+
errors.add('phone', ['error-1', 'error-2']);
|
|
240
|
+
|
|
241
|
+
errors.errorsFor('username');
|
|
242
|
+
// =>
|
|
243
|
+
// [
|
|
244
|
+
// { attribute: 'username', message: 'error-a' },
|
|
245
|
+
// ]
|
|
246
|
+
|
|
247
|
+
errors.errorsFor('phone');
|
|
248
|
+
// =>
|
|
249
|
+
// [
|
|
250
|
+
// { attribute: 'phone', message: 'error-1' },
|
|
251
|
+
// { attribute: 'phone', message: 'error-2' },
|
|
252
|
+
// ]
|
|
253
|
+
|
|
254
|
+
errors.clear();
|
|
255
|
+
|
|
256
|
+
errors.errorsFor('username');
|
|
257
|
+
// => undefined
|
|
258
|
+
|
|
259
|
+
errors.errorsFor('phone');
|
|
260
|
+
// => undefined
|
|
261
|
+
|
|
262
|
+
errors.messages
|
|
263
|
+
// => []
|
|
264
|
+
```
|
|
265
|
+
@public
|
|
266
|
+
*/
|
|
267
|
+
clear(): void;
|
|
268
|
+
/**
|
|
269
|
+
Checks if there are error messages for the given attribute.
|
|
270
|
+
|
|
271
|
+
```js [app/controllers/user/edit.js]
|
|
272
|
+
export default class UserEditController extends Controller {
|
|
273
|
+
@action
|
|
274
|
+
save(user) {
|
|
275
|
+
if (user.errors.has('email')) {
|
|
276
|
+
return alert('Please update your email before attempting to save.');
|
|
277
|
+
}
|
|
278
|
+
user.save();
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
@public
|
|
284
|
+
@param {String} attribute
|
|
285
|
+
@return {Boolean} true if there some errors on given attribute
|
|
286
|
+
*/
|
|
287
|
+
has(attribute: string): boolean;
|
|
288
|
+
}
|
|
289
|
+
export {};
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
import type { TypeFromInstance } from "@warp-drive/core/types/record";
|
|
2
|
+
import type { NoNull, RelationshipDecorator, RelationshipOptions } from "./belongs-to.js";
|
|
3
|
+
/**
|
|
4
|
+
`hasMany` is used to define Many-To-One and Many-To-Many, and Many-To-None
|
|
5
|
+
relationships on a {@link Model}.
|
|
6
|
+
|
|
7
|
+
`hasMany` takes a configuration hash as a second parameter, currently
|
|
8
|
+
supported options are:
|
|
9
|
+
|
|
10
|
+
- `async`: (*required*) A boolean value used to declare whether this is a sync (false) or async (true) relationship.
|
|
11
|
+
- `inverse`: (*required*) A string used to identify the inverse property on a related model, or `null`.
|
|
12
|
+
- `polymorphic`: (*optional*) A boolean value to mark the relationship as polymorphic
|
|
13
|
+
- `as`: (*optional*) A string used to declare the abstract type "this" record satisfies for polymorphism.
|
|
14
|
+
|
|
15
|
+
### Examples
|
|
16
|
+
|
|
17
|
+
To declare a **many-to-one** (or one-to-many) relationship, use
|
|
18
|
+
`belongsTo` in combination with `hasMany`:
|
|
19
|
+
|
|
20
|
+
```js
|
|
21
|
+
// app/models/post.js
|
|
22
|
+
import { Model, hasMany } from '@warp-drive/legacy/model';
|
|
23
|
+
|
|
24
|
+
export default class Post extends Model {
|
|
25
|
+
@hasMany('comment', { async: false, inverse: 'post' }) comments;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
// app/models/comment.js
|
|
30
|
+
import { Model, belongsTo } from '@warp-drive/legacy/model';
|
|
31
|
+
|
|
32
|
+
export default class Comment extends Model {
|
|
33
|
+
@belongsTo('post', { async: false, inverse: 'comments' }) post;
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
To declare a **many-to-many** relationship with managed inverses, use `hasMany` for both sides:
|
|
38
|
+
|
|
39
|
+
```js
|
|
40
|
+
// app/models/post.js
|
|
41
|
+
import { Model, hasMany } from '@warp-drive/legacy/model';
|
|
42
|
+
|
|
43
|
+
export default class Post extends Model {
|
|
44
|
+
@hasMany('tag', { async: true, inverse: 'posts' }) tags;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
// app/models/tag.js
|
|
48
|
+
import { Model, hasMany } from '@warp-drive/legacy/model';
|
|
49
|
+
|
|
50
|
+
export default class Tag extends Model {
|
|
51
|
+
@hasMany('post', { async: true, inverse: 'tags' }) posts;
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
To declare a **many-to-many** relationship without managed inverses, use `hasMany` for both sides
|
|
56
|
+
with `null` as the inverse:
|
|
57
|
+
|
|
58
|
+
```js
|
|
59
|
+
// app/models/post.js
|
|
60
|
+
import { Model, hasMany } from '@warp-drive/legacy/model';
|
|
61
|
+
|
|
62
|
+
export default class Post extends Model {
|
|
63
|
+
@hasMany('tag', { async: true, inverse: null }) tags;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
// app/models/tag.js
|
|
67
|
+
import { Model, hasMany } from '@warp-drive/legacy/model';
|
|
68
|
+
|
|
69
|
+
export default class Tag extends Model {
|
|
70
|
+
@hasMany('post', { async: true, inverse: null }) posts;
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
To declare a many-to-none relationship between two models, use
|
|
75
|
+
`hasMany` with inverse set to `null` on just one side::
|
|
76
|
+
|
|
77
|
+
```js
|
|
78
|
+
// app/models/post.js
|
|
79
|
+
import { Model, hasMany } from '@warp-drive/legacy/model';
|
|
80
|
+
|
|
81
|
+
export default class Post extends Model {
|
|
82
|
+
@hasMany('category', { async: true, inverse: null }) categories;
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
#### Sync vs Async Relationships
|
|
87
|
+
|
|
88
|
+
WarpDrive fulfills relationships using resource data available in
|
|
89
|
+
the cache.
|
|
90
|
+
|
|
91
|
+
Sync relationships point directly to the known related resources.
|
|
92
|
+
|
|
93
|
+
When a relationship is declared as async, if any of the known related
|
|
94
|
+
resources have not been loaded, they will be fetched. The property
|
|
95
|
+
on the record when accessed provides a promise that resolves once
|
|
96
|
+
all resources are loaded.
|
|
97
|
+
|
|
98
|
+
Async relationships may take advantage of links. On access, if the related
|
|
99
|
+
link has not been loaded, or if any known resources are not available in
|
|
100
|
+
the cache, the fresh state will be fetched using the link.
|
|
101
|
+
|
|
102
|
+
In contrast to async relationship, accessing a sync relationship
|
|
103
|
+
will error on access when any of the known related resources have
|
|
104
|
+
not been loaded.
|
|
105
|
+
|
|
106
|
+
If you are using `links` with sync relationships, you have to use
|
|
107
|
+
the HasMany reference API to fetch or refresh related resources
|
|
108
|
+
that aren't loaded. For instance, for a `comments` relationship:
|
|
109
|
+
|
|
110
|
+
```js
|
|
111
|
+
post.hasMany('comments').reload();
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
#### Polymorphic Relationships
|
|
115
|
+
|
|
116
|
+
To declare a polymorphic relationship, use `hasMany` with the `polymorphic`
|
|
117
|
+
option set to `true`:
|
|
118
|
+
|
|
119
|
+
```js
|
|
120
|
+
// app/models/comment.js
|
|
121
|
+
import { Model, belongsTo } from '@warp-drive/legacy/model';
|
|
122
|
+
|
|
123
|
+
export default class Comment extends Model {
|
|
124
|
+
@belongsTo('commentable', { async: false, inverse: 'comments', polymorphic: true }) parent;
|
|
125
|
+
}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
`'commentable'` here is referred to as the "abstract type" for the polymorphic
|
|
129
|
+
relationship.
|
|
130
|
+
|
|
131
|
+
Polymorphic relationships with `inverse: null` will accept any type of record as their content.
|
|
132
|
+
Polymorphic relationships with `inverse` set to a string will only accept records with a matching
|
|
133
|
+
inverse relationships declaring itself as satisfying the abstract type.
|
|
134
|
+
|
|
135
|
+
Below, 'as' is used to declare the that 'post' record satisfies the abstract type 'commentable'
|
|
136
|
+
for this relationship.
|
|
137
|
+
|
|
138
|
+
```js
|
|
139
|
+
// app/models/post.js
|
|
140
|
+
import { Model, hasMany } from '@warp-drive/legacy/model';
|
|
141
|
+
|
|
142
|
+
export default class Post extends Model {
|
|
143
|
+
@hasMany('comment', { async: false, inverse: 'parent', as: 'commentable' }) comments;
|
|
144
|
+
}
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
Note: every Model that declares an inverse to a polymorphic relationship must
|
|
148
|
+
declare itself exactly the same. This is because polymorphism is based on structural
|
|
149
|
+
traits.
|
|
150
|
+
|
|
151
|
+
Polymorphic to polymorphic relationships are supported. Both sides of the relationship
|
|
152
|
+
must be declared as polymorphic, and the `as` option must be used to declare the abstract
|
|
153
|
+
type each record satisfies on both sides.
|
|
154
|
+
|
|
155
|
+
@public
|
|
156
|
+
@param type the name of the related resource
|
|
157
|
+
@param options a hash of options
|
|
158
|
+
*/
|
|
159
|
+
export declare function hasMany(): never;
|
|
160
|
+
export declare function hasMany(type: string): never;
|
|
161
|
+
export declare function hasMany<T>(type: TypeFromInstance<NoNull<T>>, options: RelationshipOptions<T, boolean>): RelationshipDecorator<T>;
|
|
162
|
+
export declare function hasMany(type: string, options: RelationshipOptions<unknown, boolean>): RelationshipDecorator<unknown>;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { type Store } from "@warp-drive/core/store/-private";
|
|
2
|
+
import type { ResourceKey } from "@warp-drive/core/types/identifier";
|
|
3
|
+
import type { TypeFromInstance } from "@warp-drive/core/types/record";
|
|
4
|
+
import type { Model } from "./model.js";
|
|
5
|
+
export declare function instantiateRecord(this: Store, identifier: ResourceKey, createRecordArgs?: {
|
|
6
|
+
[key: string]: unknown;
|
|
7
|
+
}): Model;
|
|
8
|
+
export declare function teardownRecord(record: Model): void;
|
|
9
|
+
export declare function modelFor<T>(type: TypeFromInstance<T>): typeof Model | void;
|
|
10
|
+
export declare function modelFor(type: string): typeof Model | void;
|
package/dist/unpkg/dev-deprecated/declarations/model/-private/legacy-relationships-support.d.ts
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import type { Store } from "@warp-drive/core";
|
|
2
|
+
import type { CollectionEdge, ResourceEdge, UpgradedMeta } from "@warp-drive/core/graph/-private";
|
|
3
|
+
import type { LegacyManyArray } from "@warp-drive/core/store/-private";
|
|
4
|
+
import type { BaseFinderOptions, ResourceKey } from "@warp-drive/core/types";
|
|
5
|
+
import type { CollectionRelationship } from "@warp-drive/core/types/cache/relationship";
|
|
6
|
+
import type { LocalRelationshipOperation } from "@warp-drive/core/types/graph";
|
|
7
|
+
import type { OpaqueRecordInstance, TypeFromInstanceOrString } from "@warp-drive/core/types/record";
|
|
8
|
+
import type { CollectionResourceRelationship, InnerRelationshipDocument, SingleResourceRelationship } from "@warp-drive/core/types/spec/json-api-raw";
|
|
9
|
+
import type { MinimalLegacyRecord } from "./model-methods.js";
|
|
10
|
+
import type { BelongsToProxyCreateArgs } from "./promise-belongs-to.js";
|
|
11
|
+
import { PromiseBelongsTo } from "./promise-belongs-to.js";
|
|
12
|
+
import type { HasManyProxyCreateArgs } from "./promise-many-array.js";
|
|
13
|
+
import { PromiseManyArray } from "./promise-many-array.js";
|
|
14
|
+
import BelongsToReference from "./references/belongs-to.js";
|
|
15
|
+
import HasManyReference from "./references/has-many.js";
|
|
16
|
+
export declare const LEGACY_SUPPORT: Map<ResourceKey | MinimalLegacyRecord, LegacySupport>;
|
|
17
|
+
export declare function lookupLegacySupport(record: MinimalLegacyRecord): LegacySupport;
|
|
18
|
+
/**
|
|
19
|
+
* @hideconstructor
|
|
20
|
+
*/
|
|
21
|
+
export declare class LegacySupport {
|
|
22
|
+
identifier: ResourceKey;
|
|
23
|
+
constructor(record: MinimalLegacyRecord, identifier: ResourceKey);
|
|
24
|
+
/** @private */
|
|
25
|
+
_syncArray(array: LegacyManyArray): void;
|
|
26
|
+
mutate(mutation: LocalRelationshipOperation): void;
|
|
27
|
+
_findBelongsTo(key: string, resource: SingleResourceRelationship, relationship: ResourceEdge, options?: BaseFinderOptions): Promise<OpaqueRecordInstance | null>;
|
|
28
|
+
reloadBelongsTo(key: string, options?: BaseFinderOptions): Promise<OpaqueRecordInstance | null>;
|
|
29
|
+
getBelongsTo(key: string, options?: BaseFinderOptions): PromiseBelongsTo | OpaqueRecordInstance | null;
|
|
30
|
+
setDirtyBelongsTo(key: string, value: OpaqueRecordInstance | null): void;
|
|
31
|
+
_getCurrentState<T>(identifier: ResourceKey, field: string): [ResourceKey<TypeFromInstanceOrString<T>>[], CollectionRelationship];
|
|
32
|
+
getManyArray<T>(key: string, definition?: UpgradedMeta): LegacyManyArray<T>;
|
|
33
|
+
fetchAsyncHasMany(key: string, relationship: CollectionEdge, manyArray: LegacyManyArray, options?: BaseFinderOptions): Promise<LegacyManyArray>;
|
|
34
|
+
reloadHasMany<T>(key: string, options?: BaseFinderOptions): Promise<LegacyManyArray<T>> | PromiseManyArray<T>;
|
|
35
|
+
getHasMany(key: string, options?: BaseFinderOptions): PromiseManyArray | LegacyManyArray;
|
|
36
|
+
_updatePromiseProxyFor(kind: "hasMany", key: string, args: HasManyProxyCreateArgs): PromiseManyArray;
|
|
37
|
+
_updatePromiseProxyFor(kind: "belongsTo", key: string, args: BelongsToProxyCreateArgs): PromiseBelongsTo;
|
|
38
|
+
_updatePromiseProxyFor(kind: "belongsTo", key: string, args: {
|
|
39
|
+
promise: Promise<OpaqueRecordInstance | null>;
|
|
40
|
+
}): PromiseBelongsTo;
|
|
41
|
+
referenceFor(kind: "belongsTo", key: string): BelongsToReference;
|
|
42
|
+
referenceFor(kind: "hasMany", key: string): HasManyReference;
|
|
43
|
+
_findHasManyByJsonApiResource(resource: CollectionResourceRelationship, parentIdentifier: ResourceKey, relationship: CollectionEdge, options?: BaseFinderOptions): Promise<void | unknown[]> | void;
|
|
44
|
+
_findBelongsToByJsonApiResource(resource: SingleResourceRelationship, parentIdentifier: ResourceKey, relationship: ResourceEdge, options?: BaseFinderOptions): Promise<ResourceKey | null>;
|
|
45
|
+
destroy(): void;
|
|
46
|
+
}
|
|
47
|
+
export declare function areAllInverseRecordsLoaded(store: Store, resource: InnerRelationshipDocument): boolean;
|