@data-weave/backend-firestore 0.4.7 → 0.4.9

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.
Files changed (31) hide show
  1. package/lib/{backend-firestore/src/FirestoreDataManager.d.ts → FirestoreDataManager.d.ts} +11 -7
  2. package/lib/{backend-firestore/src/version.js → version.js} +1 -1
  3. package/package.json +3 -3
  4. package/lib/datamanager/src/Cache.d.ts +0 -15
  5. package/lib/datamanager/src/Cache.js +0 -32
  6. package/lib/datamanager/src/DataManager.d.ts +0 -42
  7. package/lib/datamanager/src/DataManager.js +0 -13
  8. package/lib/datamanager/src/List.d.ts +0 -11
  9. package/lib/datamanager/src/List.js +0 -24
  10. package/lib/datamanager/src/LiveList.d.ts +0 -24
  11. package/lib/datamanager/src/LiveList.js +0 -55
  12. package/lib/datamanager/src/LiveReference.d.ts +0 -21
  13. package/lib/datamanager/src/LiveReference.js +0 -46
  14. package/lib/datamanager/src/Reference.d.ts +0 -15
  15. package/lib/datamanager/src/Reference.js +0 -25
  16. package/lib/datamanager/src/index.d.ts +0 -6
  17. package/lib/datamanager/src/index.js +0 -22
  18. /package/lib/{backend-firestore/src/FirestoreDataManager.js → FirestoreDataManager.js} +0 -0
  19. /package/lib/{backend-firestore/src/FirestoreList.d.ts → FirestoreList.d.ts} +0 -0
  20. /package/lib/{backend-firestore/src/FirestoreList.js → FirestoreList.js} +0 -0
  21. /package/lib/{backend-firestore/src/FirestoreMetadata.d.ts → FirestoreMetadata.d.ts} +0 -0
  22. /package/lib/{backend-firestore/src/FirestoreMetadata.js → FirestoreMetadata.js} +0 -0
  23. /package/lib/{backend-firestore/src/FirestoreReference.d.ts → FirestoreReference.d.ts} +0 -0
  24. /package/lib/{backend-firestore/src/FirestoreReference.js → FirestoreReference.js} +0 -0
  25. /package/lib/{backend-firestore/src/firestoreTypes.d.ts → firestoreTypes.d.ts} +0 -0
  26. /package/lib/{backend-firestore/src/firestoreTypes.js → firestoreTypes.js} +0 -0
  27. /package/lib/{backend-firestore/src/index.d.ts → index.d.ts} +0 -0
  28. /package/lib/{backend-firestore/src/index.js → index.js} +0 -0
  29. /package/lib/{backend-firestore/src/utils.d.ts → utils.d.ts} +0 -0
  30. /package/lib/{backend-firestore/src/utils.js → utils.js} +0 -0
  31. /package/lib/{backend-firestore/src/version.d.ts → version.d.ts} +0 -0
@@ -1,9 +1,12 @@
1
1
  import { Cache, DataManager, IdentifiableReference, List, ListPaginationParams, WithMetadata, WithoutId } from '@data-weave/datamanager';
2
- import { FirestoreList, FirestoreListContext } from './FirestoreList';
2
+ import { FirestoreListContext } from './FirestoreList';
3
3
  import { FirestoreSerializedMetadata } from './FirestoreMetadata';
4
- import { FirestoreReference, FirestoreReferenceContext } from './FirestoreReference';
4
+ import { FirestoreReferenceContext } from './FirestoreReference';
5
5
  import { FilterBy, FirebaseCreateOptions, Firestore, FirestoreDataConverter, FirestoreReadMode, FirestoreReadOptions, FirestoreTypes, FirestoreWriteOptions, OrderBy, WithFieldValue } from './firestoreTypes';
6
6
  export type FirebaseDataManagerDeleteMode = 'soft' | 'hard';
7
+ type Constructor<T = {}> = new (...args: any[]) => T;
8
+ export type FirestoreReferenceClass = Constructor<IdentifiableReference<any>>;
9
+ export type FirestoreListClass = Constructor<List<any>>;
7
10
  export interface FirebaseDataManagerOptions {
8
11
  readonly idResolver?: () => string;
9
12
  readonly deleteMode?: FirebaseDataManagerDeleteMode;
@@ -11,8 +14,8 @@ export interface FirebaseDataManagerOptions {
11
14
  readonly preventOverwriteOnCreate?: boolean;
12
15
  readonly errorInterceptor?: (error: unknown, ctx: FirestoreReferenceContext | FirestoreListContext) => void;
13
16
  readonly snapshotOptions?: FirestoreTypes.SnapshotOptions;
14
- readonly Reference?: typeof FirestoreReference;
15
- readonly List?: typeof FirestoreList;
17
+ readonly Reference?: FirestoreReferenceClass;
18
+ readonly List?: FirestoreListClass;
16
19
  readonly listCache?: Cache;
17
20
  readonly refCache?: Cache;
18
21
  }
@@ -33,13 +36,14 @@ export declare class FirestoreDataManager<T extends FirestoreTypes.DocumentData,
33
36
  private listCache;
34
37
  constructor(firestore: Firestore, collectionPath: string, converter: FirestoreDataConverter<T, SerializedT>, opts?: FirebaseDataManagerOptions | undefined);
35
38
  read(id: string, options?: FirestoreReadOptions): Promise<WithMetadata<T> | undefined>;
36
- create(data: WithFieldValue<WithoutId<T>>, options?: FirebaseCreateOptions): Promise<IdentifiableReference<WithMetadata<T>>>;
39
+ create(data: WithFieldValue<WithoutId<T>>, options?: FirebaseCreateOptions): Promise<IdentifiableReference<any>>;
37
40
  private _update;
38
41
  update(id: string, data: WithoutId<Partial<WithFieldValue<T>>>, options?: FirestoreWriteOptions): Promise<void>;
39
42
  upsert(id: string, data: WithFieldValue<WithoutId<T>>, options?: FirestoreWriteOptions): Promise<void>;
40
43
  delete(id: string, options?: FirestoreWriteOptions): Promise<void>;
41
- getRef(id: string): IdentifiableReference<WithMetadata<T>>;
44
+ getRef(id: string): IdentifiableReference<any>;
42
45
  private _getFilteredQuery;
43
- getList(params?: QueryParams<SerializedT> & ListPaginationParams): List<WithMetadata<T>>;
46
+ getList(params?: QueryParams<SerializedT> & ListPaginationParams): List<any>;
44
47
  private preventOverwriteOnCreate;
45
48
  }
49
+ export {};
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  // Generated by genversion.
3
- module.exports = '0.4.7';
3
+ module.exports = '0.4.9';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@data-weave/backend-firestore",
3
- "version": "0.4.7",
3
+ "version": "0.4.9",
4
4
  "author": "",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
@@ -23,8 +23,8 @@
23
23
  "registry": "https://registry.npmjs.org/"
24
24
  },
25
25
  "peerDependencies": {
26
- "@data-weave/datamanager": "0.4.6",
26
+ "@data-weave/datamanager": "0.4.8",
27
27
  "firebase": ">=11.0.0"
28
28
  },
29
- "gitHead": "09a715b9694113e389eedab5787a559c6e522a3a"
29
+ "gitHead": "0ad313c53c63576679585988cb4b9d0fea031f7b"
30
30
  }
@@ -1,15 +0,0 @@
1
- export interface Cache<K = any, V = any> {
2
- get(key: K): V | undefined;
3
- set(key: K, value: V): void;
4
- has(key: K): boolean;
5
- }
6
- export declare class MapCache<K, V> implements Cache<K, V> {
7
- private cache;
8
- private maxSize?;
9
- constructor(maxSize?: number);
10
- get(key: K): V | undefined;
11
- set(key: K, value: V): void;
12
- has(key: K): boolean;
13
- delete(key: K): boolean;
14
- clear(): void;
15
- }
@@ -1,32 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.MapCache = void 0;
4
- class MapCache {
5
- constructor(maxSize) {
6
- this.cache = new Map();
7
- this.maxSize = maxSize;
8
- }
9
- get(key) {
10
- return this.cache.get(key);
11
- }
12
- set(key, value) {
13
- if (this.maxSize && this.cache.size >= this.maxSize && !this.cache.has(key)) {
14
- // Remove the first entry (oldest) when cache is full
15
- const firstKey = this.cache.keys().next().value;
16
- if (firstKey) {
17
- this.cache.delete(firstKey);
18
- }
19
- }
20
- this.cache.set(key, value);
21
- }
22
- has(key) {
23
- return this.cache.has(key);
24
- }
25
- delete(key) {
26
- return this.cache.delete(key);
27
- }
28
- clear() {
29
- this.cache.clear();
30
- }
31
- }
32
- exports.MapCache = MapCache;
@@ -1,42 +0,0 @@
1
- import { List } from './List';
2
- import { IdentifiableReference, WithoutId } from './Reference';
3
- export interface ReadOptions {
4
- readonly transaction?: unknown;
5
- }
6
- export interface WriteOptions {
7
- readonly transaction?: unknown;
8
- readonly batcher?: unknown;
9
- }
10
- export interface CreateOptions extends WriteOptions {
11
- id?: string;
12
- merge?: boolean;
13
- }
14
- export type OrderByOption = 'asc' | 'desc';
15
- export interface GetListOptions {
16
- readonly filterBy?: unknown;
17
- readonly orderBy?: unknown;
18
- readonly limit?: number;
19
- }
20
- export interface Metadata {
21
- readonly id: string;
22
- readonly createdAt: Date;
23
- readonly updatedAt: Date;
24
- readonly deleted: boolean;
25
- }
26
- export type WithMetadata<T> = T & Metadata;
27
- /**
28
- * DataManager is the base class for all data managers.
29
- * It is responsible for reading, creating, deleting, and updating data.
30
- * It is also responsible for returning references and lists.
31
- * It is generic and can be used for any type of data.
32
- * @template T - The type of the data to be managed.
33
- */
34
- export declare abstract class DataManager<T> {
35
- abstract read(id: string): Promise<T | undefined>;
36
- abstract create(data: WithoutId<T>, options?: CreateOptions): Promise<IdentifiableReference<WithMetadata<T>>>;
37
- abstract delete(id: string): Promise<void>;
38
- abstract update(id: string, data: Partial<WithoutId<T>>): Promise<void>;
39
- abstract upsert(id: string, data: WithoutId<T>): Promise<void>;
40
- abstract getRef(id: string): IdentifiableReference<WithMetadata<T>>;
41
- abstract getList(params?: GetListOptions): List<WithMetadata<T>>;
42
- }
@@ -1,13 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DataManager = void 0;
4
- /**
5
- * DataManager is the base class for all data managers.
6
- * It is responsible for reading, creating, deleting, and updating data.
7
- * It is also responsible for returning references and lists.
8
- * It is generic and can be used for any type of data.
9
- * @template T - The type of the data to be managed.
10
- */
11
- class DataManager {
12
- }
13
- exports.DataManager = DataManager;
@@ -1,11 +0,0 @@
1
- import { Resolvable } from './Reference';
2
- export interface ListPaginationParams {
3
- readonly pageSize?: number;
4
- readonly append?: boolean;
5
- readonly loadFirstPageManually?: boolean;
6
- }
7
- export interface List<T> extends Resolvable<readonly T[]> {
8
- readonly values: readonly T[];
9
- }
10
- export declare function createInitializedList<T>(values: ReadonlyArray<T>): List<T>;
11
- export declare function createEmptyList<T>(): List<T>;
@@ -1,24 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.createInitializedList = createInitializedList;
13
- exports.createEmptyList = createEmptyList;
14
- function createInitializedList(values) {
15
- return {
16
- values,
17
- resolved: true,
18
- hasError: false,
19
- resolve: () => __awaiter(this, void 0, void 0, function* () { return values; }),
20
- };
21
- }
22
- function createEmptyList() {
23
- return createInitializedList([]);
24
- }
@@ -1,24 +0,0 @@
1
- import { List } from './List';
2
- export interface LiveListOptions<T> {
3
- onUpdate?: (newValues: T[]) => void;
4
- onError?: (error: unknown) => void;
5
- }
6
- export declare class LiveList<T> implements List<T> {
7
- private _values;
8
- private _resolved;
9
- private _hasError;
10
- private _options;
11
- constructor(options: LiveListOptions<T>);
12
- resolve(): Promise<readonly T[]>;
13
- get values(): T[];
14
- get hasError(): boolean;
15
- get resolved(): boolean;
16
- protected setStale(): void;
17
- protected onValuesChange(): void;
18
- protected onUpdate(): void;
19
- protected onUpdateAll(values: T[]): void;
20
- protected onUpdateAtIndex(index: number, value: T): void;
21
- protected onAddAtIndex(index: number, value: T): void;
22
- protected onRemoveAtIndex(index: number): void;
23
- protected onError(error: unknown): void;
24
- }
@@ -1,55 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.LiveList = void 0;
4
- class LiveList {
5
- constructor(options) {
6
- this._values = [];
7
- this._resolved = false;
8
- this._hasError = false;
9
- this._options = options;
10
- }
11
- resolve() {
12
- throw new Error('Method not implemented.');
13
- }
14
- get values() {
15
- return this._values;
16
- }
17
- get hasError() {
18
- return this._hasError;
19
- }
20
- get resolved() {
21
- return this._resolved;
22
- }
23
- setStale() {
24
- this._resolved = false;
25
- }
26
- onValuesChange() { }
27
- onUpdate() {
28
- var _a, _b;
29
- this._resolved = true;
30
- this.onValuesChange();
31
- (_b = (_a = this._options).onUpdate) === null || _b === void 0 ? void 0 : _b.call(_a, this._values);
32
- }
33
- onUpdateAll(values) {
34
- this._values = values;
35
- this.onUpdate();
36
- }
37
- onUpdateAtIndex(index, value) {
38
- this._values[index] = value;
39
- }
40
- onAddAtIndex(index, value) {
41
- this._values.splice(index, 0, value);
42
- }
43
- onRemoveAtIndex(index) {
44
- this._values.splice(index, 1);
45
- }
46
- onError(error) {
47
- var _a, _b;
48
- this._hasError = true;
49
- this._values = [];
50
- this._resolved = true;
51
- (_b = (_a = this._options).onError) === null || _b === void 0 ? void 0 : _b.call(_a, error);
52
- this.onValuesChange();
53
- }
54
- }
55
- exports.LiveList = LiveList;
@@ -1,21 +0,0 @@
1
- import { Reference } from './Reference';
2
- export interface LiveReferenceOptions<T> {
3
- onUpdate?: (newValue: T | undefined) => void;
4
- onError?: (error: unknown) => void;
5
- }
6
- export declare class LiveReference<T> implements Reference<T> {
7
- readonly options: LiveReferenceOptions<T>;
8
- private _value;
9
- private _resolved;
10
- private _hasError;
11
- private _options;
12
- resolve(): Promise<T | undefined>;
13
- constructor(options: LiveReferenceOptions<T>);
14
- get value(): T | undefined;
15
- get resolved(): boolean;
16
- get hasError(): boolean;
17
- protected setStale(): void;
18
- protected onUpdate(data: T | undefined): void;
19
- protected onError(error: unknown): void;
20
- protected onValueChange(): void;
21
- }
@@ -1,46 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.LiveReference = void 0;
4
- class LiveReference {
5
- resolve() {
6
- throw new Error('Method not implemented.');
7
- }
8
- constructor(options) {
9
- this.options = options;
10
- this._resolved = false;
11
- this._hasError = false;
12
- this._value = undefined;
13
- this._resolved = false;
14
- this._hasError = false;
15
- this._options = options;
16
- }
17
- get value() {
18
- return this._value;
19
- }
20
- get resolved() {
21
- return this._resolved;
22
- }
23
- get hasError() {
24
- return this._hasError;
25
- }
26
- setStale() {
27
- this._resolved = false;
28
- }
29
- onUpdate(data) {
30
- var _a, _b;
31
- this._value = data;
32
- this._resolved = true;
33
- this.onValueChange();
34
- (_b = (_a = this._options).onUpdate) === null || _b === void 0 ? void 0 : _b.call(_a, this._value);
35
- }
36
- onError(error) {
37
- var _a, _b;
38
- this._hasError = true;
39
- this._value = undefined;
40
- this._resolved = true;
41
- this.onValueChange();
42
- (_b = (_a = this._options).onError) === null || _b === void 0 ? void 0 : _b.call(_a, error);
43
- }
44
- onValueChange() { }
45
- }
46
- exports.LiveReference = LiveReference;
@@ -1,15 +0,0 @@
1
- export interface Identifiable {
2
- readonly id: string;
3
- }
4
- export type WithoutId<T> = Omit<T, 'id'>;
5
- export interface Resolvable<T> {
6
- readonly resolved: boolean;
7
- readonly hasError: boolean;
8
- resolve(): Promise<T>;
9
- }
10
- export interface Reference<T> extends Resolvable<T | undefined> {
11
- readonly value: T | undefined;
12
- }
13
- export type IdentifiableReference<T> = Reference<T> & Identifiable;
14
- export declare function createInitializedIdentifiableReference<T>(value: T | undefined, id: string): Reference<T> & Identifiable;
15
- export declare function createEmptyIdentifiableReference<T>(id: string): Reference<T>;
@@ -1,25 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.createInitializedIdentifiableReference = createInitializedIdentifiableReference;
13
- exports.createEmptyIdentifiableReference = createEmptyIdentifiableReference;
14
- function createInitializedIdentifiableReference(value, id) {
15
- return {
16
- id,
17
- value,
18
- resolved: true,
19
- hasError: false,
20
- resolve: () => __awaiter(this, void 0, void 0, function* () { return value; }),
21
- };
22
- }
23
- function createEmptyIdentifiableReference(id) {
24
- return createInitializedIdentifiableReference(undefined, id);
25
- }
@@ -1,6 +0,0 @@
1
- export * from './Cache';
2
- export * from './DataManager';
3
- export * from './List';
4
- export * from './LiveList';
5
- export * from './LiveReference';
6
- export * from './Reference';
@@ -1,22 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./Cache"), exports);
18
- __exportStar(require("./DataManager"), exports);
19
- __exportStar(require("./List"), exports);
20
- __exportStar(require("./LiveList"), exports);
21
- __exportStar(require("./LiveReference"), exports);
22
- __exportStar(require("./Reference"), exports);