@dereekb/firebase 13.9.0 → 13.10.1
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/index.cjs.js +19 -10
- package/index.esm.js +19 -10
- package/package.json +10 -10
- package/src/lib/client/function/function.d.ts +5 -0
- package/src/lib/client/function/function.factory.d.ts +5 -0
- package/src/lib/client/function/model.function.factory.d.ts +5 -0
- package/src/lib/common/auth/auth.d.ts +14 -0
- package/src/lib/common/development/function.d.ts +5 -0
- package/src/lib/common/firestore/accessor/document.d.ts +8 -0
- package/src/lib/common/firestore/collection/collection.d.ts +15 -0
- package/src/lib/common/firestore/driver/driver.d.ts +5 -0
- package/src/lib/common/firestore/query/constraint.d.ts +5 -0
- package/src/lib/common/storage/driver/accessor.d.ts +13 -0
- package/src/lib/common/storage/driver/driver.d.ts +5 -0
- package/src/lib/common/storage/storage.d.ts +5 -0
- package/src/lib/common/storage/types.d.ts +29 -0
- package/src/lib/model/notification/notification.api.d.ts +2 -2
- package/src/lib/model/notification/notification.d.ts +103 -0
- package/src/lib/model/notification/notification.id.d.ts +10 -0
- package/src/lib/model/notification/notification.message.d.ts +10 -0
- package/src/lib/model/notification/notification.task.subtask.d.ts +4 -0
- package/src/lib/model/oidcmodel/oidcmodel.api.d.ts +2 -2
- package/src/lib/model/oidcmodel/oidcmodel.d.ts +21 -1
- package/src/lib/model/oidcmodel/oidcmodel.id.d.ts +5 -0
- package/src/lib/model/oidcmodel/oidcmodel.interaction.d.ts +14 -0
- package/src/lib/model/storagefile/storagefile.d.ts +68 -1
- package/src/lib/model/storagefile/storagefile.id.d.ts +10 -0
- package/src/lib/model/storagefile/storagefile.upload.d.ts +5 -0
- package/src/lib/model/storagefile/storagefile.upload.determiner.d.ts +4 -0
- package/src/lib/model/system/system.d.ts +13 -0
- package/test/index.cjs.js +1 -0
- package/test/index.esm.js +1 -0
- package/test/package.json +9 -9
package/index.cjs.js
CHANGED
|
@@ -3362,7 +3362,7 @@ function optionalFirestoreField(config) {
|
|
|
3362
3362
|
};
|
|
3363
3363
|
}
|
|
3364
3364
|
fromData = function fromData(x) {
|
|
3365
|
-
return transformFrom(x
|
|
3365
|
+
return transformFrom(x !== null && x !== void 0 ? x : loadDefaultReadValueFn());
|
|
3366
3366
|
};
|
|
3367
3367
|
} else if (transformFrom !== util.passThrough) {
|
|
3368
3368
|
fromData = function fromData(x) {
|
|
@@ -4080,7 +4080,9 @@ function firestoreUniqueNumberArray(config) {
|
|
|
4080
4080
|
performFiltering = function performFiltering(x) {
|
|
4081
4081
|
var result = filterUnique(x);
|
|
4082
4082
|
if (filterFn) {
|
|
4083
|
-
result = result.filter(
|
|
4083
|
+
result = result.filter(function(v, i) {
|
|
4084
|
+
return filterFn(v, i);
|
|
4085
|
+
});
|
|
4084
4086
|
}
|
|
4085
4087
|
return result;
|
|
4086
4088
|
};
|
|
@@ -4294,10 +4296,9 @@ var assignDateCellRangeFunction = util.assignValuesToPOJOFunction({
|
|
|
4294
4296
|
valueFilter: util.KeyValueTypleValueFilter.NULL
|
|
4295
4297
|
});
|
|
4296
4298
|
var firestoreDateCellRangeAssignFn = function firestoreDateCellRangeAssignFn(input) {
|
|
4299
|
+
var _block, _to;
|
|
4297
4300
|
var block = assignDateCellRangeFunction(DEFAULT_DATE_CELL_RANGE_VALUE, input);
|
|
4298
|
-
|
|
4299
|
-
block.to = block.i;
|
|
4300
|
-
}
|
|
4301
|
+
(_to = (_block = block).to) !== null && _to !== void 0 ? _to : _block.to = block.i;
|
|
4301
4302
|
return block;
|
|
4302
4303
|
};
|
|
4303
4304
|
/**
|
|
@@ -7428,7 +7429,7 @@ function firestoreModelIdentity(parentOrModelName, collectionNameOrModelName, in
|
|
|
7428
7429
|
* @param key
|
|
7429
7430
|
* @returns
|
|
7430
7431
|
*/ function flatFirestoreModelKey(key) {
|
|
7431
|
-
return key.
|
|
7432
|
+
return key.replaceAll('/', '');
|
|
7432
7433
|
}
|
|
7433
7434
|
/**
|
|
7434
7435
|
* Creates a TwoWayFlatFirestoreModelKey from the input FirestoreModelKey.
|
|
@@ -7436,7 +7437,7 @@ function firestoreModelIdentity(parentOrModelName, collectionNameOrModelName, in
|
|
|
7436
7437
|
* @param key
|
|
7437
7438
|
* @returns
|
|
7438
7439
|
*/ function twoWayFlatFirestoreModelKey(key) {
|
|
7439
|
-
return key.
|
|
7440
|
+
return key.replaceAll('/', '_');
|
|
7440
7441
|
}
|
|
7441
7442
|
/**
|
|
7442
7443
|
* Creates a TwoWayFlatFirestoreModelKey from the input FirestoreModelKey.
|
|
@@ -7444,7 +7445,7 @@ function firestoreModelIdentity(parentOrModelName, collectionNameOrModelName, in
|
|
|
7444
7445
|
* @param key
|
|
7445
7446
|
* @returns
|
|
7446
7447
|
*/ function inferKeyFromTwoWayFlatFirestoreModelKey(key) {
|
|
7447
|
-
return key.
|
|
7448
|
+
return key.replaceAll('_', FIRESTORE_COLLECTION_NAME_SEPARATOR);
|
|
7448
7449
|
}
|
|
7449
7450
|
/**
|
|
7450
7451
|
* Firestore Model Id Regex
|
|
@@ -7967,7 +7968,7 @@ function _object_spread_props$e(target, source) {
|
|
|
7967
7968
|
* // id === 'userAAAexamplecom'
|
|
7968
7969
|
* ```
|
|
7969
7970
|
*/ function firestoreModelIdFromEmail(emailAddress) {
|
|
7970
|
-
return emailAddress.replace('@', 'AAA').
|
|
7971
|
+
return emailAddress.replace('@', 'AAA').replaceAll(/[^a-zA-Z0-9]/g, '');
|
|
7971
7972
|
}
|
|
7972
7973
|
|
|
7973
7974
|
/**
|
|
@@ -13682,6 +13683,8 @@ function _is_native_reflect_construct$3() {
|
|
|
13682
13683
|
* Used by both client and server code to access notification documents.
|
|
13683
13684
|
*
|
|
13684
13685
|
* @see `NotificationServerActions` in `@dereekb/firebase-server/model` for server-side action processing
|
|
13686
|
+
*
|
|
13687
|
+
* @dbxModelGroup Notification
|
|
13685
13688
|
*/ var NotificationFirestoreCollections = function NotificationFirestoreCollections() {
|
|
13686
13689
|
_class_call_check$7(this, NotificationFirestoreCollections);
|
|
13687
13690
|
};
|
|
@@ -16207,6 +16210,8 @@ function _is_native_reflect_construct$2() {
|
|
|
16207
16210
|
* Used by both client and server code to access oidc model documents.
|
|
16208
16211
|
*
|
|
16209
16212
|
* @see `OidcModelServerActions` in `@dereekb/firebase-server/oidc` for server-side action processing
|
|
16213
|
+
*
|
|
16214
|
+
* @dbxModelGroup OidcModel
|
|
16210
16215
|
*/ var OidcModelFirestoreCollections = function OidcModelFirestoreCollections() {
|
|
16211
16216
|
_class_call_check$4(this, OidcModelFirestoreCollections);
|
|
16212
16217
|
};
|
|
@@ -16668,6 +16673,8 @@ function _is_native_reflect_construct$1() {
|
|
|
16668
16673
|
* Abstract base providing access to StorageFile and StorageFileGroup Firestore collections.
|
|
16669
16674
|
*
|
|
16670
16675
|
* Implement this in your app module to wire up the collections for dependency injection.
|
|
16676
|
+
*
|
|
16677
|
+
* @dbxModelGroup StorageFile
|
|
16671
16678
|
*/ var StorageFileFirestoreCollections = function StorageFileFirestoreCollections() {
|
|
16672
16679
|
_class_call_check$1(this, StorageFileFirestoreCollections);
|
|
16673
16680
|
};
|
|
@@ -17825,7 +17832,7 @@ function _ts_generator$1(thisArg, body) {
|
|
|
17825
17832
|
]), a = _ref[0], b = _ref[1];
|
|
17826
17833
|
return [
|
|
17827
17834
|
2,
|
|
17828
|
-
_object_spread$2({}, a
|
|
17835
|
+
_object_spread$2({}, a, b)
|
|
17829
17836
|
];
|
|
17830
17837
|
}
|
|
17831
17838
|
});
|
|
@@ -18798,6 +18805,8 @@ function _is_native_reflect_construct() {
|
|
|
18798
18805
|
* Abstract base providing access to the SystemState Firestore collection.
|
|
18799
18806
|
*
|
|
18800
18807
|
* Implement this in your app module to wire up dependency injection.
|
|
18808
|
+
*
|
|
18809
|
+
* @dbxModelGroup SystemState
|
|
18801
18810
|
*/ var SystemStateFirestoreCollections = function SystemStateFirestoreCollections() {
|
|
18802
18811
|
_class_call_check(this, SystemStateFirestoreCollections);
|
|
18803
18812
|
};
|
package/index.esm.js
CHANGED
|
@@ -3360,7 +3360,7 @@ function optionalFirestoreField(config) {
|
|
|
3360
3360
|
};
|
|
3361
3361
|
}
|
|
3362
3362
|
fromData = function fromData(x) {
|
|
3363
|
-
return transformFrom(x
|
|
3363
|
+
return transformFrom(x !== null && x !== void 0 ? x : loadDefaultReadValueFn());
|
|
3364
3364
|
};
|
|
3365
3365
|
} else if (transformFrom !== passThrough) {
|
|
3366
3366
|
fromData = function fromData(x) {
|
|
@@ -4078,7 +4078,9 @@ function firestoreUniqueNumberArray(config) {
|
|
|
4078
4078
|
performFiltering = function performFiltering(x) {
|
|
4079
4079
|
var result = filterUnique(x);
|
|
4080
4080
|
if (filterFn) {
|
|
4081
|
-
result = result.filter(
|
|
4081
|
+
result = result.filter(function(v, i) {
|
|
4082
|
+
return filterFn(v, i);
|
|
4083
|
+
});
|
|
4082
4084
|
}
|
|
4083
4085
|
return result;
|
|
4084
4086
|
};
|
|
@@ -4292,10 +4294,9 @@ var assignDateCellRangeFunction = assignValuesToPOJOFunction({
|
|
|
4292
4294
|
valueFilter: KeyValueTypleValueFilter.NULL
|
|
4293
4295
|
});
|
|
4294
4296
|
var firestoreDateCellRangeAssignFn = function firestoreDateCellRangeAssignFn(input) {
|
|
4297
|
+
var _block, _to;
|
|
4295
4298
|
var block = assignDateCellRangeFunction(DEFAULT_DATE_CELL_RANGE_VALUE, input);
|
|
4296
|
-
|
|
4297
|
-
block.to = block.i;
|
|
4298
|
-
}
|
|
4299
|
+
(_to = (_block = block).to) !== null && _to !== void 0 ? _to : _block.to = block.i;
|
|
4299
4300
|
return block;
|
|
4300
4301
|
};
|
|
4301
4302
|
/**
|
|
@@ -7426,7 +7427,7 @@ function firestoreModelIdentity(parentOrModelName, collectionNameOrModelName, in
|
|
|
7426
7427
|
* @param key
|
|
7427
7428
|
* @returns
|
|
7428
7429
|
*/ function flatFirestoreModelKey(key) {
|
|
7429
|
-
return key.
|
|
7430
|
+
return key.replaceAll('/', '');
|
|
7430
7431
|
}
|
|
7431
7432
|
/**
|
|
7432
7433
|
* Creates a TwoWayFlatFirestoreModelKey from the input FirestoreModelKey.
|
|
@@ -7434,7 +7435,7 @@ function firestoreModelIdentity(parentOrModelName, collectionNameOrModelName, in
|
|
|
7434
7435
|
* @param key
|
|
7435
7436
|
* @returns
|
|
7436
7437
|
*/ function twoWayFlatFirestoreModelKey(key) {
|
|
7437
|
-
return key.
|
|
7438
|
+
return key.replaceAll('/', '_');
|
|
7438
7439
|
}
|
|
7439
7440
|
/**
|
|
7440
7441
|
* Creates a TwoWayFlatFirestoreModelKey from the input FirestoreModelKey.
|
|
@@ -7442,7 +7443,7 @@ function firestoreModelIdentity(parentOrModelName, collectionNameOrModelName, in
|
|
|
7442
7443
|
* @param key
|
|
7443
7444
|
* @returns
|
|
7444
7445
|
*/ function inferKeyFromTwoWayFlatFirestoreModelKey(key) {
|
|
7445
|
-
return key.
|
|
7446
|
+
return key.replaceAll('_', FIRESTORE_COLLECTION_NAME_SEPARATOR);
|
|
7446
7447
|
}
|
|
7447
7448
|
/**
|
|
7448
7449
|
* Firestore Model Id Regex
|
|
@@ -7965,7 +7966,7 @@ function _object_spread_props$e(target, source) {
|
|
|
7965
7966
|
* // id === 'userAAAexamplecom'
|
|
7966
7967
|
* ```
|
|
7967
7968
|
*/ function firestoreModelIdFromEmail(emailAddress) {
|
|
7968
|
-
return emailAddress.replace('@', 'AAA').
|
|
7969
|
+
return emailAddress.replace('@', 'AAA').replaceAll(/[^a-zA-Z0-9]/g, '');
|
|
7969
7970
|
}
|
|
7970
7971
|
|
|
7971
7972
|
/**
|
|
@@ -13680,6 +13681,8 @@ function _is_native_reflect_construct$3() {
|
|
|
13680
13681
|
* Used by both client and server code to access notification documents.
|
|
13681
13682
|
*
|
|
13682
13683
|
* @see `NotificationServerActions` in `@dereekb/firebase-server/model` for server-side action processing
|
|
13684
|
+
*
|
|
13685
|
+
* @dbxModelGroup Notification
|
|
13683
13686
|
*/ var NotificationFirestoreCollections = function NotificationFirestoreCollections() {
|
|
13684
13687
|
_class_call_check$7(this, NotificationFirestoreCollections);
|
|
13685
13688
|
};
|
|
@@ -16205,6 +16208,8 @@ function _is_native_reflect_construct$2() {
|
|
|
16205
16208
|
* Used by both client and server code to access oidc model documents.
|
|
16206
16209
|
*
|
|
16207
16210
|
* @see `OidcModelServerActions` in `@dereekb/firebase-server/oidc` for server-side action processing
|
|
16211
|
+
*
|
|
16212
|
+
* @dbxModelGroup OidcModel
|
|
16208
16213
|
*/ var OidcModelFirestoreCollections = function OidcModelFirestoreCollections() {
|
|
16209
16214
|
_class_call_check$4(this, OidcModelFirestoreCollections);
|
|
16210
16215
|
};
|
|
@@ -16666,6 +16671,8 @@ function _is_native_reflect_construct$1() {
|
|
|
16666
16671
|
* Abstract base providing access to StorageFile and StorageFileGroup Firestore collections.
|
|
16667
16672
|
*
|
|
16668
16673
|
* Implement this in your app module to wire up the collections for dependency injection.
|
|
16674
|
+
*
|
|
16675
|
+
* @dbxModelGroup StorageFile
|
|
16669
16676
|
*/ var StorageFileFirestoreCollections = function StorageFileFirestoreCollections() {
|
|
16670
16677
|
_class_call_check$1(this, StorageFileFirestoreCollections);
|
|
16671
16678
|
};
|
|
@@ -17823,7 +17830,7 @@ function _ts_generator$1(thisArg, body) {
|
|
|
17823
17830
|
]), a = _ref[0], b = _ref[1];
|
|
17824
17831
|
return [
|
|
17825
17832
|
2,
|
|
17826
|
-
_object_spread$2({}, a
|
|
17833
|
+
_object_spread$2({}, a, b)
|
|
17827
17834
|
];
|
|
17828
17835
|
}
|
|
17829
17836
|
});
|
|
@@ -18796,6 +18803,8 @@ function _is_native_reflect_construct() {
|
|
|
18796
18803
|
* Abstract base providing access to the SystemState Firestore collection.
|
|
18797
18804
|
*
|
|
18798
18805
|
* Implement this in your app module to wire up dependency injection.
|
|
18806
|
+
*
|
|
18807
|
+
* @dbxModelGroup SystemState
|
|
18799
18808
|
*/ var SystemStateFirestoreCollections = function SystemStateFirestoreCollections() {
|
|
18800
18809
|
_class_call_check(this, SystemStateFirestoreCollections);
|
|
18801
18810
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dereekb/firebase",
|
|
3
|
-
"version": "13.
|
|
3
|
+
"version": "13.10.1",
|
|
4
4
|
"exports": {
|
|
5
5
|
"./test": {
|
|
6
6
|
"module": "./test/index.esm.js",
|
|
@@ -17,17 +17,17 @@
|
|
|
17
17
|
}
|
|
18
18
|
},
|
|
19
19
|
"peerDependencies": {
|
|
20
|
-
"@dereekb/util": "13.
|
|
21
|
-
"@dereekb/date": "13.
|
|
22
|
-
"@dereekb/model": "13.
|
|
23
|
-
"@dereekb/rxjs": "13.
|
|
20
|
+
"@dereekb/util": "13.10.1",
|
|
21
|
+
"@dereekb/date": "13.10.1",
|
|
22
|
+
"@dereekb/model": "13.10.1",
|
|
23
|
+
"@dereekb/rxjs": "13.10.1",
|
|
24
24
|
"@firebase/rules-unit-testing": "5.0.0",
|
|
25
25
|
"arktype": "^2.2.0",
|
|
26
|
-
"date-fns": "^4.
|
|
27
|
-
"firebase": "^12.12.
|
|
28
|
-
"make-error": "^1.3.
|
|
29
|
-
"rxjs": "^7.8.
|
|
30
|
-
"ts-essentials": "^10.
|
|
26
|
+
"date-fns": "^4.1.0",
|
|
27
|
+
"firebase": "^12.12.1",
|
|
28
|
+
"make-error": "^1.3.6",
|
|
29
|
+
"rxjs": "^7.8.2",
|
|
30
|
+
"ts-essentials": "^10.2.0"
|
|
31
31
|
},
|
|
32
32
|
"module": "./index.esm.js",
|
|
33
33
|
"main": "./index.cjs.js",
|
|
@@ -43,6 +43,11 @@ export type FirebaseFunctionMapFactory<M extends FirebaseFunctionTypeMap> = (fun
|
|
|
43
43
|
export declare function firebaseFunctionMapFactory<M extends FirebaseFunctionTypeMap>(configMap: FirebaseFunctionTypeConfigMap<M>): FirebaseFunctionMapFactory<M>;
|
|
44
44
|
/**
|
|
45
45
|
* String key used to identify a function group in the app-level functions map.
|
|
46
|
+
*
|
|
47
|
+
* @semanticType
|
|
48
|
+
* @semanticTopic identifier
|
|
49
|
+
* @semanticTopic string
|
|
50
|
+
* @semanticTopic dereekb-firebase:functions
|
|
46
51
|
*/
|
|
47
52
|
export type FirebaseFunctionMapKey = string;
|
|
48
53
|
/**
|
|
@@ -9,6 +9,11 @@ import { type OnCallCreateModelResult } from '../../common/model/function';
|
|
|
9
9
|
* String identifier that routes a CRUD request to a specific sub-handler within a model's
|
|
10
10
|
* CRUD function. For example, a model's `update` might have specifiers like `'status'` or `'config'`
|
|
11
11
|
* to target different update behaviors.
|
|
12
|
+
*
|
|
13
|
+
* @semanticType
|
|
14
|
+
* @semanticTopic identifier
|
|
15
|
+
* @semanticTopic string
|
|
16
|
+
* @semanticTopic dereekb-firebase:functions
|
|
12
17
|
*/
|
|
13
18
|
export type ModelFirebaseCrudFunctionSpecifier = string;
|
|
14
19
|
/**
|
|
@@ -13,6 +13,11 @@ export declare const FIREBASE_AUTH_PASSWORD_MIN_LENGTH = 6;
|
|
|
13
13
|
export declare const FIREBASE_AUTH_PASSWORD_MAX_LENGTH = 128;
|
|
14
14
|
/**
|
|
15
15
|
* Unique identifier for a Firebase Authentication user (the `uid` from Firebase Auth).
|
|
16
|
+
*
|
|
17
|
+
* @semanticType
|
|
18
|
+
* @semanticTopic identifier
|
|
19
|
+
* @semanticTopic string
|
|
20
|
+
* @semanticTopic dereekb-firebase:auth
|
|
16
21
|
*/
|
|
17
22
|
export type FirebaseAuthUserId = string;
|
|
18
23
|
/**
|
|
@@ -25,6 +30,10 @@ export interface FirebaseAuthUserIdRef {
|
|
|
25
30
|
* Raw encoded JWT for Firebase Auth.
|
|
26
31
|
*
|
|
27
32
|
* Corresponds with IdToken type in Firebase Auth.
|
|
33
|
+
*
|
|
34
|
+
* @semanticType
|
|
35
|
+
* @semanticTopic string
|
|
36
|
+
* @semanticTopic dereekb-firebase:auth
|
|
28
37
|
*/
|
|
29
38
|
export type FirebaseAuthIdToken = string;
|
|
30
39
|
/**
|
|
@@ -65,6 +74,11 @@ export interface FirebaseAuthDetails extends FirebaseAuthToken, Readonly<Firebas
|
|
|
65
74
|
* A string key used to test for ownership of a particular set of objects.
|
|
66
75
|
*
|
|
67
76
|
* For instance, a database model (or its parent) may have an ownership key associated with it that is compared with the user's current claims.
|
|
77
|
+
*
|
|
78
|
+
* @semanticType
|
|
79
|
+
* @semanticTopic identifier
|
|
80
|
+
* @semanticTopic string
|
|
81
|
+
* @semanticTopic dereekb-firebase:auth
|
|
68
82
|
*/
|
|
69
83
|
export type FirebaseAuthOwnershipKey = string;
|
|
70
84
|
/**
|
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
* Identifies a specific development function endpoint to route requests to.
|
|
3
3
|
*
|
|
4
4
|
* Used in dev/test environments to invoke specific server-side functions by name.
|
|
5
|
+
*
|
|
6
|
+
* @semanticType
|
|
7
|
+
* @semanticTopic identifier
|
|
8
|
+
* @semanticTopic string
|
|
9
|
+
* @semanticTopic dereekb-firebase:functions
|
|
5
10
|
*/
|
|
6
11
|
export type DevelopmentFirebaseFunctionSpecifier = string;
|
|
7
12
|
/**
|
|
@@ -405,6 +405,14 @@ export declare function firestoreSingleDocumentAccessor<T, D extends FirestoreDo
|
|
|
405
405
|
* Default document ID used for single-document collections. The document is stored at path `<collection>/0`.
|
|
406
406
|
*/
|
|
407
407
|
export declare const DEFAULT_SINGLE_ITEM_FIRESTORE_COLLECTION_DOCUMENT_IDENTIFIER = "0";
|
|
408
|
+
/**
|
|
409
|
+
* Document ID used for the single document in a single-item Firestore collection.
|
|
410
|
+
*
|
|
411
|
+
* @semanticType
|
|
412
|
+
* @semanticTopic identifier
|
|
413
|
+
* @semanticTopic string
|
|
414
|
+
* @semanticTopic dereekb-firebase:firestore
|
|
415
|
+
*/
|
|
408
416
|
export type SingleItemFirestoreCollectionDocumentIdentifier = string;
|
|
409
417
|
export interface SingleItemFirestoreCollectionDocumentIdentifierRef {
|
|
410
418
|
/**
|
|
@@ -26,6 +26,11 @@ export type FirestoreModelType = ModelTypeString;
|
|
|
26
26
|
* with the same name to be returned regardless of their location in the document hierarchy.
|
|
27
27
|
*
|
|
28
28
|
* @example 'u', 'ps', 'or'
|
|
29
|
+
*
|
|
30
|
+
* @semanticType
|
|
31
|
+
* @semanticTopic identifier
|
|
32
|
+
* @semanticTopic string
|
|
33
|
+
* @semanticTopic dereekb-firebase:firestore
|
|
29
34
|
*/
|
|
30
35
|
export type FirestoreCollectionName = string;
|
|
31
36
|
/**
|
|
@@ -218,6 +223,11 @@ export interface FirestoreModelIdentityRef<I extends FirestoreModelIdentity = Fi
|
|
|
218
223
|
* Example:
|
|
219
224
|
*
|
|
220
225
|
* 12345
|
|
226
|
+
*
|
|
227
|
+
* @semanticType
|
|
228
|
+
* @semanticTopic identifier
|
|
229
|
+
* @semanticTopic string
|
|
230
|
+
* @semanticTopic dereekb-firebase:firestore
|
|
221
231
|
*/
|
|
222
232
|
export type FirestoreModelId = string;
|
|
223
233
|
/**
|
|
@@ -431,6 +441,11 @@ export declare function firestoreModelKeyPairObject(input: FirestoreModelKey | D
|
|
|
431
441
|
* String that is composed of the FirestoreCollectionNames derived from an input FirestoreModelKey and joined together via a separator.
|
|
432
442
|
*
|
|
433
443
|
* Is equivalent to a FirestoreCollectionType if the FIRESTORE_COLLECTION_NAME_SEPARATOR is used as the separator.
|
|
444
|
+
*
|
|
445
|
+
* @semanticType
|
|
446
|
+
* @semanticTopic identifier
|
|
447
|
+
* @semanticTopic string
|
|
448
|
+
* @semanticTopic dereekb-firebase:firestore
|
|
434
449
|
*/
|
|
435
450
|
export type FirestoreModelCollectionTypeArrayName = string;
|
|
436
451
|
/**
|
|
@@ -2,6 +2,11 @@ import { type FirestoreAccessorDriverRef } from './accessor';
|
|
|
2
2
|
import { type FirestoreQueryDriverRef } from './query';
|
|
3
3
|
/**
|
|
4
4
|
* Optional human-readable identifier for the Firestore driver (e.g., 'firebase-admin', 'firebase-web', 'testing').
|
|
5
|
+
*
|
|
6
|
+
* @semanticType
|
|
7
|
+
* @semanticTopic identifier
|
|
8
|
+
* @semanticTopic string
|
|
9
|
+
* @semanticTopic dereekb-firebase:firestore
|
|
5
10
|
*/
|
|
6
11
|
export type FirestoreDriverIdentifier = string;
|
|
7
12
|
/**
|
|
@@ -5,6 +5,11 @@ import { type ArrayOrValue, type SeparateResult, type SortingOrder, type Maybe,
|
|
|
5
5
|
*
|
|
6
6
|
* Used to uniquely identify different types of query constraints, such as
|
|
7
7
|
* where, limit, orderBy, etc.
|
|
8
|
+
*
|
|
9
|
+
* @semanticType
|
|
10
|
+
* @semanticTopic identifier
|
|
11
|
+
* @semanticTopic string
|
|
12
|
+
* @semanticTopic dereekb-firebase:firestore
|
|
8
13
|
*/
|
|
9
14
|
export type FirestoreQueryConstraintType = string;
|
|
10
15
|
/**
|
|
@@ -146,6 +146,11 @@ export interface StorageGetAclsResult {
|
|
|
146
146
|
}
|
|
147
147
|
/**
|
|
148
148
|
* String used as a cursor for iterating pages of file results.
|
|
149
|
+
*
|
|
150
|
+
* @semanticType
|
|
151
|
+
* @semanticTopic identifier
|
|
152
|
+
* @semanticTopic string
|
|
153
|
+
* @semanticTopic dereekb-firebase:storage
|
|
149
154
|
*/
|
|
150
155
|
export type StorageListFilesPageToken = string;
|
|
151
156
|
export interface StorageListFilesOptions {
|
|
@@ -192,6 +197,14 @@ export interface StorageListFileResult extends StorageListItemResult {
|
|
|
192
197
|
*/
|
|
193
198
|
file(): FirebaseStorageAccessorFile;
|
|
194
199
|
}
|
|
200
|
+
/**
|
|
201
|
+
* Token returned with a list-files result for resuming pagination on the next call.
|
|
202
|
+
*
|
|
203
|
+
* @semanticType
|
|
204
|
+
* @semanticTopic identifier
|
|
205
|
+
* @semanticTopic string
|
|
206
|
+
* @semanticTopic dereekb-firebase:storage
|
|
207
|
+
*/
|
|
195
208
|
export type StorageListFileResultNextPageToken = string;
|
|
196
209
|
export interface StorageListFilesResult<R = unknown> {
|
|
197
210
|
/**
|
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
import { type FirebaseStorageAccessorDriverRef } from './accessor';
|
|
2
2
|
/**
|
|
3
3
|
* Unique identifier string for a storage driver implementation.
|
|
4
|
+
*
|
|
5
|
+
* @semanticType
|
|
6
|
+
* @semanticTopic identifier
|
|
7
|
+
* @semanticTopic string
|
|
8
|
+
* @semanticTopic dereekb-firebase:storage
|
|
4
9
|
*/
|
|
5
10
|
export type FirebaseStorageDriverIdentifier = string;
|
|
6
11
|
/**
|
|
@@ -3,6 +3,11 @@ import { type SlashPath, type FactoryWithRequiredInput } from '@dereekb/util';
|
|
|
3
3
|
* Storage bucket identifier for Firebase Cloud Storage.
|
|
4
4
|
*
|
|
5
5
|
* Should contain no slashes — just the bucket name (e.g., `"my-app.appspot.com"`).
|
|
6
|
+
*
|
|
7
|
+
* @semanticType
|
|
8
|
+
* @semanticTopic identifier
|
|
9
|
+
* @semanticTopic string
|
|
10
|
+
* @semanticTopic dereekb-firebase:storage
|
|
6
11
|
*/
|
|
7
12
|
export type StorageBucketId = string;
|
|
8
13
|
/**
|
|
@@ -31,10 +31,20 @@ export type GoogleCloudLikeStorage = {
|
|
|
31
31
|
export type FirebaseStorage = FirebaseStorageLikeStorage | GoogleCloudLikeStorage;
|
|
32
32
|
/**
|
|
33
33
|
* The public storage url link.
|
|
34
|
+
*
|
|
35
|
+
* @semanticType
|
|
36
|
+
* @semanticTopic url
|
|
37
|
+
* @semanticTopic string
|
|
38
|
+
* @semanticTopic dereekb-firebase:storage
|
|
34
39
|
*/
|
|
35
40
|
export type StorageDownloadUrl = string;
|
|
36
41
|
/**
|
|
37
42
|
* A signed download link.
|
|
43
|
+
*
|
|
44
|
+
* @semanticType
|
|
45
|
+
* @semanticTopic url
|
|
46
|
+
* @semanticTopic string
|
|
47
|
+
* @semanticTopic dereekb-firebase:storage
|
|
38
48
|
*/
|
|
39
49
|
export type StorageSignedDownloadUrl = string;
|
|
40
50
|
/**
|
|
@@ -79,6 +89,10 @@ export interface StorageSignedDownloadUrlConfig {
|
|
|
79
89
|
/**
|
|
80
90
|
* Example:
|
|
81
91
|
* 'Hello! \\ud83d\\ude0a';
|
|
92
|
+
*
|
|
93
|
+
* @semanticType
|
|
94
|
+
* @semanticTopic string
|
|
95
|
+
* @semanticTopic dereekb-firebase:storage
|
|
82
96
|
*/
|
|
83
97
|
export type StorageRawDataString = string;
|
|
84
98
|
/**
|
|
@@ -92,6 +106,11 @@ export type StorageRawDataStringType = 'raw';
|
|
|
92
106
|
/**
|
|
93
107
|
* Example:
|
|
94
108
|
* '5b6p5Y+344GX44G+44GX44Gf77yB44GK44KB44Gn44Go44GG77yB';
|
|
109
|
+
*
|
|
110
|
+
* @semanticType
|
|
111
|
+
* @semanticTopic string
|
|
112
|
+
* @semanticTopic dereekb-firebase:storage
|
|
113
|
+
* @semanticTopic dereekb-firebase:encoding
|
|
95
114
|
*/
|
|
96
115
|
export type StorageBase64DataString = string;
|
|
97
116
|
/**
|
|
@@ -104,6 +123,11 @@ export type StorageBase64DataStringType = 'base64';
|
|
|
104
123
|
/**
|
|
105
124
|
* Example:
|
|
106
125
|
* '5b6p5Y-344GX44G-44GX44Gf77yB44GK44KB44Gn44Go44GG77yB';
|
|
126
|
+
*
|
|
127
|
+
* @semanticType
|
|
128
|
+
* @semanticTopic string
|
|
129
|
+
* @semanticTopic dereekb-firebase:storage
|
|
130
|
+
* @semanticTopic dereekb-firebase:encoding
|
|
107
131
|
*/
|
|
108
132
|
export type StorageBase64UrlDataString = string;
|
|
109
133
|
/**
|
|
@@ -116,6 +140,11 @@ export type StorageBase64UrlDataStringType = 'base64url';
|
|
|
116
140
|
/**
|
|
117
141
|
* Example:
|
|
118
142
|
* 'data:text/plain;base64,5b6p5Y+344GX44G+44GX44Gf77yB44GK44KB44Gn44Go44GG77yB'
|
|
143
|
+
*
|
|
144
|
+
* @semanticType
|
|
145
|
+
* @semanticTopic url
|
|
146
|
+
* @semanticTopic string
|
|
147
|
+
* @semanticTopic dereekb-firebase:storage
|
|
119
148
|
*/
|
|
120
149
|
export type StorageDataUrlString = string;
|
|
121
150
|
/**
|
|
@@ -91,7 +91,7 @@ export interface UpdateNotificationUserParams extends TargetModelParams {
|
|
|
91
91
|
}
|
|
92
92
|
export declare const updateNotificationUserParamsType: Type<UpdateNotificationUserParams>;
|
|
93
93
|
export type ResyncNotificationUserParams = TargetModelParams;
|
|
94
|
-
export declare const resyncNotificationUserParamsType:
|
|
94
|
+
export declare const resyncNotificationUserParamsType: import("arktype/internal/variants/object.ts").ObjectType<TargetModelParams, {}>;
|
|
95
95
|
export interface ResyncNotificationUserResult {
|
|
96
96
|
readonly notificationBoxesUpdated: number;
|
|
97
97
|
}
|
|
@@ -156,7 +156,7 @@ export interface InitializeAllApplicableNotificationSummariesResult {
|
|
|
156
156
|
* Used for updating the NotificationBox.
|
|
157
157
|
*/
|
|
158
158
|
export type UpdateNotificationBoxParams = TargetModelParams;
|
|
159
|
-
export declare const updateNotificationBoxParamsType:
|
|
159
|
+
export declare const updateNotificationBoxParamsType: import("arktype/internal/variants/object.ts").ObjectType<TargetModelParams, {}>;
|
|
160
160
|
/**
|
|
161
161
|
* Used to create/update a notification box recipient.
|
|
162
162
|
*/
|