@warp-drive/legacy 5.9.0-beta.0 → 5.9.0-beta.2

package/dist/compat/-private.d.ts

@@ -0,0 +1,2 @@
+import { d as FetchManager, f as SaveOp, m as Snapshot, p as SnapshotRecordArray, u as upgradeStore } from "../compat-BbNNmTM-.js";
+export { FetchManager, SaveOp, Snapshot, SnapshotRecordArray, upgradeStore };

package/dist/compat/-private.js

@@ -1 +1,3 @@
-export { F as FetchManager, S as SaveOp, c as Snapshot, b as SnapshotRecordArray, u as upgradeStore } from "../-private-BG3bMiKp.js";
+import { i as Snapshot, l as SnapshotRecordArray, n as FetchManager, r as SaveOp, t as upgradeStore } from "../-private-DccRZQsm.js";
+
+export { FetchManager, SaveOp, Snapshot, SnapshotRecordArray, upgradeStore };

package/dist/compat/builders.d.ts

@@ -0,0 +1,169 @@
+import { StoreRequestInput } from "@warp-drive/core";
+import { RequestSignature } from "@warp-drive/core/types/symbols";
+import { FindAllOptions, FindRecordOptions, LegacyResourceQuery, QueryOptions, ResourceKey } from "@warp-drive/core/types";
+import { ResourceIdentifierObject } from "@warp-drive/core/types/spec/json-api-raw";
+import { TypeFromInstance, TypedRecordInstance } from "@warp-drive/core/types/record";
+//#region src/compat/builders/find-all.d.ts
+type FindAllRequestInput<T extends string = string, RT = unknown[]> = StoreRequestInput & {
+  op: "findAll";
+  data: {
+    type: T;
+    options: FindAllBuilderOptions;
+  };
+  [RequestSignature]?: RT;
+};
+type FindAllBuilderOptions = FindAllOptions;
+/**
+This function builds a request config to perform a `findAll` request for the given type.
+When passed to `store.request`, this config will result in the same behavior as a `store.findAll` request.
+Additionally, it takes the same options as `store.findAll`.
+
+All `@warp-drive/legacy/compat` builders exist to enable you to migrate your codebase to using the correct syntax for `store.request` while temporarily preserving legacy behaviors.
+This is useful for quickly upgrading an entire app to a unified syntax while a longer incremental migration is made to shift off of adapters and serializers.
+To that end, these builders are deprecated and will be removed in a future version of WarpDrive.
+
+@deprecated
+@public
+@param type the name of the resource
+@param options optional, may include `adapterOptions` hash which will be passed to adapter.findAll
+@return request config
+*/
+declare function findAllBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, options?: FindAllBuilderOptions): FindAllRequestInput<TypeFromInstance<T>, T[]>;
+declare function findAllBuilder(type: string, options?: FindAllBuilderOptions): FindAllRequestInput;
+//#endregion
+//#region src/compat/builders/find-record.d.ts
+type FindRecordRequestInput<T extends string = string, RT = unknown> = StoreRequestInput & {
+  op: "findRecord";
+  data: {
+    record: ResourceIdentifierObject<T>;
+    options: FindRecordBuilderOptions;
+  };
+  [RequestSignature]?: RT;
+};
+type FindRecordBuilderOptions = Omit<FindRecordOptions, "preload">;
+/**
+This function builds a request config to find the record for a given identifier or type and id combination.
+When passed to `store.request`, this config will result in the same behavior as a `store.findRecord` request.
+Additionally, it takes the same options as `store.findRecord`, with the exception of `preload` (which is unsupported).
+
+**Example 1**
+
+```ts
+import { findRecord } from '@warp-drive/legacy/compat/builders';
+const { content: post } = await store.request<Post>(findRecord<Post>('post', '1'));
+```
+
+**Example 2**
+
+`findRecord` can be called with a single identifier argument instead of the combination
+of `type` (modelName) and `id` as separate arguments. You may recognize this combo as
+the typical pairing from [JSON:API](https://jsonapi.org/format/#document-resource-object-identification)
+
+```ts
+import { findRecord } from '@warp-drive/legacy/compat/builders';
+const { content: post } = await store.request<Post>(findRecord<Post>({ type: 'post', id }));
+```
+
+All `@warp-drive/legacy/compat` builders exist to enable you to migrate your codebase to using the correct syntax for `store.request` while temporarily preserving legacy behaviors.
+This is useful for quickly upgrading an entire app to a unified syntax while a longer incremental migration is made to shift off of adapters and serializers.
+To that end, these builders are deprecated and will be removed in a future version of Warp Drive.
+
+@deprecated
+@public
+@param resource - either a string representing the name of the resource or a ResourceIdentifier object containing both the type (a string) and the id (a string) for the record or an lid (a string) of an existing record
+@param id - optional object with options for the request only if the first param is a ResourceIdentifier, else the string id of the record to be retrieved
+@param options - if the first param is a string this will be the optional options for the request. See examples for available options.
+@return request config
+*/
+declare function findRecordBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, id: string, options?: FindRecordBuilderOptions): FindRecordRequestInput<TypeFromInstance<T>, T>;
+declare function findRecordBuilder(type: string, id: string, options?: FindRecordBuilderOptions): FindRecordRequestInput;
+declare function findRecordBuilder<T extends TypedRecordInstance>(resource: ResourceIdentifierObject<TypeFromInstance<T>>, options?: FindRecordBuilderOptions): FindRecordRequestInput<TypeFromInstance<T>, T>;
+declare function findRecordBuilder(resource: ResourceIdentifierObject, options?: FindRecordBuilderOptions): FindRecordRequestInput;
+//#endregion
+//#region src/compat/builders/query.d.ts
+type QueryRequestInput<T extends string = string, RT = unknown[]> = StoreRequestInput & {
+  op: "query";
+  data: {
+    type: T;
+    query: LegacyResourceQuery;
+    options: QueryBuilderOptions;
+  };
+  [RequestSignature]?: RT;
+};
+type QueryBuilderOptions = QueryOptions;
+/**
+This function builds a request config for a given type and query object.
+When passed to `store.request`, this config will result in the same behavior as a `store.query` request.
+Additionally, it takes the same options as `store.query`.
+
+All `@warp-drive/legacy/compat` builders exist to enable you to migrate your codebase to using the correct syntax for `store.request` while temporarily preserving legacy behaviors.
+This is useful for quickly upgrading an entire app to a unified syntax while a longer incremental migration is made to shift off of adapters and serializers.
+To that end, these builders are deprecated and will be removed in a future version of WarpDrive.
+
+@deprecated
+@public
+@param type the name of the resource
+@param query a query to be used by the adapter
+@param options optional, may include `adapterOptions` hash which will be passed to adapter.query
+@return request config
+*/
+declare function queryBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, query: LegacyResourceQuery, options?: QueryBuilderOptions): QueryRequestInput<TypeFromInstance<T>, T[]>;
+declare function queryBuilder(type: string, query: LegacyResourceQuery, options?: QueryBuilderOptions): QueryRequestInput;
+type QueryRecordRequestInput<T extends string = string, RT = unknown> = StoreRequestInput & {
+  op: "queryRecord";
+  data: {
+    type: T;
+    query: LegacyResourceQuery;
+    options: QueryBuilderOptions;
+  };
+  [RequestSignature]?: RT;
+};
+/**
+This function builds a request config for a given type and query object.
+When passed to `store.request`, this config will result in the same behavior as a `store.queryRecord` request.
+Additionally, it takes the same options as `store.queryRecord`.
+
+All `@warp-drive/legacy/compat` builders exist to enable you to migrate your codebase to using the correct syntax for `store.request` while temporarily preserving legacy behaviors.
+This is useful for quickly upgrading an entire app to a unified syntax while a longer incremental migration is made to shift off of adapters and serializers.
+To that end, these builders are deprecated and will be removed in a future version of WarpDrive.
+
+@deprecated
+@public
+@param type the name of the resource
+@param query a query to be used by the adapter
+@param options optional, may include `adapterOptions` hash which will be passed to adapter.query
+@return request config
+*/
+declare function queryRecordBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, query: LegacyResourceQuery, options?: QueryBuilderOptions): QueryRecordRequestInput<TypeFromInstance<T>, T | null>;
+declare function queryRecordBuilder(type: string, query: LegacyResourceQuery, options?: QueryBuilderOptions): QueryRecordRequestInput;
+//#endregion
+//#region src/compat/builders/save-record.d.ts
+type SaveRecordRequestInput<T extends string = string, RT = unknown> = StoreRequestInput & {
+  op: "createRecord" | "deleteRecord" | "updateRecord";
+  data: {
+    record: ResourceKey<T>;
+    options: SaveRecordBuilderOptions;
+  };
+  records: [ResourceKey<T>];
+  [RequestSignature]?: RT;
+};
+type SaveRecordBuilderOptions = Record<string, unknown>;
+/**
+This function builds a request config for saving the given record (e.g. creating, updating, or deleting the record).
+When passed to `store.request`, this config will result in the same behavior as a legacy `store.saveRecord` request.
+Additionally, it takes the same options as `store.saveRecord`.
+
+All `@ember-data/legacy-compat` builders exist to enable you to migrate your codebase to using the correct syntax for `store.request` while temporarily preserving legacy behaviors.
+This is useful for quickly upgrading an entire app to a unified syntax while a longer incremental migration is made to shift off of adapters and serializers.
+To that end, these builders are deprecated and will be removed in a future version of Ember Data.
+
+@deprecated
+@public
+@param {Object} record a record to save
+@param {SaveRecordBuilderOptions} options optional, may include `adapterOptions` hash which will be passed to adapter.saveRecord
+@return {SaveRecordRequestInput} request config
+*/
+declare function saveRecordBuilder<T extends TypedRecordInstance>(record: T, options?: Record<string, unknown>): SaveRecordRequestInput<TypeFromInstance<T>, T>;
+//#endregion
+export { findAllBuilder as findAll, findRecordBuilder as findRecord, queryBuilder as query, queryRecordBuilder as queryRecord, saveRecordBuilder as saveRecord };
+//# sourceMappingURL=builders.d.ts.map

package/dist/compat/builders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builders.d.ts","names":[],"sources":["../../src/compat/builders/find-all.ts","../../src/compat/builders/find-record.ts","../../src/compat/builders/query.ts","../../src/compat/builders/save-record.ts"],"mappings":";;;;;;KASK,oBAAoB,2BAA2B,kBAAkB;EACpE;EACA;IACE,MAAM;IACN,SAAS;;GAEV,oBAAoB;;KAGlB,wBAAwB;;;;;;;;;;;;;;;;iBAiBb,eAAe,UAAU,qBACvC,MAAM,iBAAiB,IACvB,UAAU,wBACT,oBAAoB,iBAAiB,IAAI;iBAC5B,eAAe,cAAc,UAAU,wBAAwB;;;KC5B1E,uBAAuB,2BAA2B,gBAAgB;EACrE;EACA;IACE,QAAQ,yBAAyB;IACjC,SAAS;;GAEV,oBAAoB;;KAGlB,2BAA2B,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoCrB,kBAAkB,UAAU,qBAC1C,MAAM,iBAAiB,IACvB,YACA,UAAU,2BACT,uBAAuB,iBAAiB,IAAI;iBAC/B,kBAAkB,cAAc,YAAY,UAAU,2BAA2B;iBACjF,kBAAkB,UAAU,qBAC1C,UAAU,yBAAyB,iBAAiB,KACpD,UAAU,2BACT,uBAAuB,iBAAiB,IAAI;iBAC/B,kBACd,UAAU,0BACV,UAAU,2BACT;;;KC5DE,kBAAkB,2BAA2B,kBAAkB;EAClE;EACA;IACE,MAAM;IACN,OAAO;IACP,SAAS;;GAEV,oBAAoB;;KAGlB,sBAAsB;;;;;;;;;;;;;;;;;iBAkBX,aAAa,UAAU,qBACrC,MAAM,iBAAiB,IACvB,OAAO,qBACP,UAAU,sBACT,kBAAkB,iBAAiB,IAAI;iBAC1B,aACd,cACA,OAAO,qBACP,UAAU,sBACT;KAwBE,wBAAwB,2BAA2B,gBAAgB;EACtE;EACA;IACE,MAAM;IACN,OAAO;IACP,SAAS;;GAEV,oBAAoB;;;;;;;;;;;;;;;;;;iBAmBP,mBAAmB,UAAU,qBAC3C,MAAM,iBAAiB,IACvB,OAAO,qBACP,UAAU,sBACT,wBAAwB,iBAAiB,IAAI;iBAChC,mBACd,cACA,OAAO,qBACP,UAAU,sBACT;;;KChGE,uBAAuB,2BAA2B,gBAAgB;EACrE;EACA;IACE,QAAQ,YAAY;IACpB,SAAS;;EAEX,UAAU,YAAY;GACrB,oBAAoB;;KAGlB,2BAA2B;;;;;;;;;;;;;;;;iBA0BhB,kBAAkB,UAAU,qBAC1C,QAAQ,GACR,UAAS,0BACR,uBAAuB,iBAAiB,IAAI"}