js-bao-wss-client 2.0.6 → 2.0.8
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/README.md +1 -1
- package/dist/JsBaoClient.d.ts +71 -47
- package/dist/JsBaoClient.d.ts.map +1 -1
- package/dist/JsBaoClient.js +93 -10
- package/dist/JsBaoClient.js.map +1 -1
- package/dist/api/cacheFacade.d.ts +6 -6
- package/dist/api/cacheFacade.d.ts.map +1 -1
- package/dist/api/cacheFacade.js.map +1 -1
- package/dist/api/collectionTypeConfigsApi.d.ts +23 -0
- package/dist/api/collectionTypeConfigsApi.d.ts.map +1 -1
- package/dist/api/collectionTypeConfigsApi.js.map +1 -1
- package/dist/api/collectionsApi.d.ts +15 -0
- package/dist/api/collectionsApi.d.ts.map +1 -1
- package/dist/api/collectionsApi.js.map +1 -1
- package/dist/api/cronTriggersApi.d.ts +4 -4
- package/dist/api/cronTriggersApi.d.ts.map +1 -1
- package/dist/api/databaseTypeConfigsApi.d.ts +104 -1
- package/dist/api/databaseTypeConfigsApi.d.ts.map +1 -1
- package/dist/api/databaseTypeConfigsApi.js.map +1 -1
- package/dist/api/databasesApi.d.ts +63 -22
- package/dist/api/databasesApi.d.ts.map +1 -1
- package/dist/api/databasesApi.js +22 -2
- package/dist/api/databasesApi.js.map +1 -1
- package/dist/api/documentsApi.d.ts +16 -4
- package/dist/api/documentsApi.d.ts.map +1 -1
- package/dist/api/documentsApi.js +16 -0
- package/dist/api/documentsApi.js.map +1 -1
- package/dist/api/geminiApi.d.ts +9 -9
- package/dist/api/geminiApi.d.ts.map +1 -1
- package/dist/api/geminiApi.js.map +1 -1
- package/dist/api/invitationsApi.d.ts +15 -3
- package/dist/api/invitationsApi.d.ts.map +1 -1
- package/dist/api/invitationsApi.js +15 -3
- package/dist/api/invitationsApi.js.map +1 -1
- package/dist/api/llmApi.d.ts +8 -8
- package/dist/api/llmApi.d.ts.map +1 -1
- package/dist/api/llmApi.js.map +1 -1
- package/dist/api/notificationsApi.d.ts +2 -2
- package/dist/api/ruleSetsApi.d.ts +57 -11
- package/dist/api/ruleSetsApi.d.ts.map +1 -1
- package/dist/api/ruleSetsApi.js.map +1 -1
- package/dist/browser.umd.js +278 -36
- package/dist/browser.umd.js.map +1 -1
- package/dist/internal/blobManager.d.ts +5 -5
- package/dist/internal/blobManager.d.ts.map +1 -1
- package/dist/internal/blobManager.js.map +1 -1
- package/dist/internal/documentManager.d.ts +1 -0
- package/dist/internal/documentManager.d.ts.map +1 -1
- package/dist/internal/documentManager.js.map +1 -1
- package/dist/internal/httpClient.d.ts +58 -1
- package/dist/internal/httpClient.d.ts.map +1 -1
- package/dist/internal/httpClient.js +132 -21
- package/dist/internal/httpClient.js.map +1 -1
- package/package.json +1 -1
|
@@ -6,14 +6,14 @@ export interface CacheFacade {
|
|
|
6
6
|
* @param base - The base string for the cache key (e.g., an endpoint name)
|
|
7
7
|
* @param params - Optional parameters that are hashed into the key for uniqueness
|
|
8
8
|
*/
|
|
9
|
-
key: (base: string, params?:
|
|
9
|
+
key: (base: string, params?: unknown) => string;
|
|
10
10
|
/**
|
|
11
11
|
* Returns a cached value if available, otherwise calls the fetcher and caches the result.
|
|
12
12
|
* @param keyOrParts - A cache key string or an array of parts to build a key from
|
|
13
13
|
* @param fetcher - Async function that produces the value when the cache misses
|
|
14
14
|
* @param options - Controls cache freshness, network behavior, and timeout
|
|
15
15
|
*/
|
|
16
|
-
fetchCached: <T>(keyOrParts: string |
|
|
16
|
+
fetchCached: <T>(keyOrParts: string | unknown[], fetcher: () => Promise<T>, options?: FetchCachedOptions) => Promise<T | null>;
|
|
17
17
|
/**
|
|
18
18
|
* Fetches data from an HTTP endpoint with automatic caching based on request parameters.
|
|
19
19
|
* @param req.method - HTTP method (e.g., "GET", "POST")
|
|
@@ -26,8 +26,8 @@ export interface CacheFacade {
|
|
|
26
26
|
fetchHttp: <T>(req: {
|
|
27
27
|
method: string;
|
|
28
28
|
path: string;
|
|
29
|
-
query?: Record<string,
|
|
30
|
-
body?:
|
|
29
|
+
query?: Record<string, unknown>;
|
|
30
|
+
body?: unknown;
|
|
31
31
|
keyBase?: string;
|
|
32
32
|
}, options?: FetchCachedOptions) => Promise<T | null>;
|
|
33
33
|
/**
|
|
@@ -49,8 +49,8 @@ export interface CacheFacade {
|
|
|
49
49
|
export interface CreateCacheFacadeOptions {
|
|
50
50
|
appId: string;
|
|
51
51
|
getNetworkMode: () => "auto" | "online" | "offline";
|
|
52
|
-
emit: (event: string, args:
|
|
53
|
-
makeRequest: (method: string, path: string, data?:
|
|
52
|
+
emit: (event: string, args: unknown[]) => void;
|
|
53
|
+
makeRequest: (method: string, path: string, data?: unknown) => Promise<unknown>;
|
|
54
54
|
storageProvider?: StorageProvider;
|
|
55
55
|
}
|
|
56
56
|
export interface CacheFacadeResult {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cacheFacade.d.ts","sourceRoot":"","sources":["../../api/cacheFacade.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAEpE,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,
|
|
1
|
+
{"version":3,"file":"cacheFacade.d.ts","sourceRoot":"","sources":["../../api/cacheFacade.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAEpE,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,KAAK,MAAM,CAAC;IAChD;;;;;OAKG;IACH,WAAW,EAAE,CAAC,CAAC,EACb,UAAU,EAAE,MAAM,GAAG,OAAO,EAAE,EAC9B,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACzB,OAAO,CAAC,EAAE,kBAAkB,KACzB,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACvB;;;;;;;;OAQG;IACH,SAAS,EAAE,CAAC,CAAC,EACX,GAAG,EAAE;QACH,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,EACD,OAAO,CAAC,EAAE,kBAAkB,KACzB,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACvB;;;OAGG;IACH,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvE;;;OAGG;IACH,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,0CAA0C;IAC1C,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACpD,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IAC/C,WAAW,EAAE,CACX,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,KACX,OAAO,CAAC,OAAO,CAAC,CAAC;IACtB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,WAAW,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,wBAAwB,GAChC,iBAAiB,CA2EnB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cacheFacade.js","sourceRoot":"","sources":["../../api/cacheFacade.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAA2B,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"cacheFacade.js","sourceRoot":"","sources":["../../api/cacheFacade.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAA2B,MAAM,gBAAgB,CAAC;AAuElE;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAiC;IAEjC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC;QAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,cAAc,EAAE,OAAO,CAAC,cAAc;QACtC,OAAO,EAAE,OAAO,CAAC,IAAI;QACrB,eAAe,EAAE,OAAO,CAAC,eAAe;KACzC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAgB;QACzB,GAAG,EAAE,CAAC,IAAY,EAAE,MAAgB,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC;QAClE,WAAW,EAAE,CACX,UAA8B,EAC9B,OAAyB,EACzB,YAAiC,EACjC,EAAE,CAAC,OAAO,CAAC,WAAW,CAAI,UAAU,EAAE,OAAO,EAAE,YAAY,CAAC;QAC9D,SAAS,EAAE,KAAK,EACd,GAMC,EACD,YAAiC,EACd,EAAE;YACrB,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YACzD,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,IAAI,QAAQ,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;YACzD,MAAM,SAAS,GAA4B,EAAE,CAAC;YAE9C,IAAI,GAAG,CAAC,KAAK,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC/C,SAAS,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;YAC9B,CAAC;YACD,IAAI,MAAM,KAAK,KAAK,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC/C,SAAS,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;YAC5B,CAAC;YAED,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAE9C,MAAM,OAAO,GAAG,KAAK,IAAgB,EAAE;gBACrC,IAAI,SAAS,GAAG,GAAG,CAAC,IAAI,CAAC;gBACzB,IAAI,GAAG,CAAC,KAAK,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAC/C,IAAI,CAAC;wBACH,MAAM,EAAE,GAAG,IAAI,eAAe,EAAE,CAAC;wBACjC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;6BACnC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,KAAM,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;6BAC1C,IAAI,EAAE;6BACN,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,KAAM,CAAC,CAAC,CAAC,CAAsB,CAAC,CAAC;wBACvD,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,OAAO,EAAE,CAAC;4BAC7B,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gCACrB,KAAK,MAAM,IAAI,IAAI,CAAC,EAAE,CAAC;oCACrB,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gCAC7B,CAAC;4BACH,CAAC;iCAAM,IAAI,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;gCAC/C,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;4BAC/B,CAAC;iCAAM,CAAC;gCACN,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;4BACvB,CAAC;wBACH,CAAC;wBACD,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;wBAC5B,IAAI,KAAK,EAAE,CAAC;4BACV,SAAS,GAAG,GAAG,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,EAAE,CAAC;wBAC3E,CAAC;oBACH,CAAC;oBAAC,MAAM,CAAC,CAAA,CAAC;gBACZ,CAAC;gBACD,OAAO,OAAO,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,GAAG,CAAC,IAAI,CAAe,CAAC;YACxE,CAAC,CAAC;YAEF,OAAO,OAAO,CAAC,WAAW,CAAI,QAAQ,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;QACxC,KAAK,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC;QAC1C,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE;KACnC,CAAC;IAEF,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAC5B,CAAC"}
|
|
@@ -1,8 +1,18 @@
|
|
|
1
1
|
import type { JsBaoClient } from "../JsBaoClient";
|
|
2
|
+
import type { DeclaredMetadataManifest } from "./databaseTypeConfigsApi";
|
|
3
|
+
export type { DeclaredMetadataManifest, DeclaredManifestPath, DeclaredManifestPathFrom, DeclaredManifestPathRootFrom, } from "./databaseTypeConfigsApi";
|
|
2
4
|
export interface CollectionTypeConfigInfo {
|
|
3
5
|
appId: string;
|
|
4
6
|
collectionType: string;
|
|
5
7
|
ruleSetId: string | null;
|
|
8
|
+
/**
|
|
9
|
+
* The declared-access manifest for this type's CEL rule set (issue #1420),
|
|
10
|
+
* returned parsed. `null` when none is set. A collection rule set can read a
|
|
11
|
+
* metadata category as `md.self.<category>.<key>` only when the category is
|
|
12
|
+
* declared here — this is the manifest prerequisite for migrating a
|
|
13
|
+
* `collection.contextId` binding to a metadata category.
|
|
14
|
+
*/
|
|
15
|
+
metadataManifest: DeclaredMetadataManifest | null;
|
|
6
16
|
createdAt: string;
|
|
7
17
|
modifiedAt: string;
|
|
8
18
|
createdBy: string;
|
|
@@ -12,10 +22,23 @@ export interface CreateCollectionTypeConfigParams {
|
|
|
12
22
|
collectionType: string;
|
|
13
23
|
/** Rule set to enforce for collections of this type. Must have `resourceType: "collection"`. */
|
|
14
24
|
ruleSetId?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Optional declared-access manifest (issue #1420) that lets this type's rule
|
|
27
|
+
* set load metadata categories as `md.self.<category>.<key>`. Declaring a
|
|
28
|
+
* category here is the prerequisite for migrating a `collection.contextId`
|
|
29
|
+
* binding to a metadata category.
|
|
30
|
+
*/
|
|
31
|
+
metadataManifest?: DeclaredMetadataManifest;
|
|
15
32
|
}
|
|
16
33
|
export interface UpdateCollectionTypeConfigParams {
|
|
17
34
|
/** New rule set ID to associate, or null to remove the current rule set */
|
|
18
35
|
ruleSetId?: string | null;
|
|
36
|
+
/**
|
|
37
|
+
* Replacement declared-access manifest (issue #1420), or null to clear it.
|
|
38
|
+
* Set this to make metadata categories reachable from this type's rule set as
|
|
39
|
+
* `md.self.<category>.<key>` when migrating off `collection.contextId`.
|
|
40
|
+
*/
|
|
41
|
+
metadataManifest?: DeclaredMetadataManifest | null;
|
|
19
42
|
}
|
|
20
43
|
export declare class CollectionTypeConfigsAPI {
|
|
21
44
|
private client;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"collectionTypeConfigsApi.d.ts","sourceRoot":"","sources":["../../api/collectionTypeConfigsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"collectionTypeConfigsApi.d.ts","sourceRoot":"","sources":["../../api/collectionTypeConfigsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAIzE,YAAY,EACV,wBAAwB,EACxB,oBAAoB,EACpB,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,0BAA0B,CAAC;AAElC,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;;;;;OAMG;IACH,gBAAgB,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAClD,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gCAAgC;IAC/C,2EAA2E;IAC3E,cAAc,EAAE,MAAM,CAAC;IACvB,gGAAgG;IAChG,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;CAC7C;AAED,MAAM,WAAW,gCAAgC;IAC/C,2EAA2E;IAC3E,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;CACpD;AAED,qBAAa,wBAAwB;IACvB,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,WAAW;IAEvC,oEAAoE;IAC9D,IAAI,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAIjD;;;OAGG;IACG,GAAG,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAOpE;;;OAGG;IACG,MAAM,CACV,MAAM,EAAE,gCAAgC,GACvC,OAAO,CAAC,wBAAwB,CAAC;IAIpC;;;;OAIG;IACG,MAAM,CACV,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,gCAAgC,GACvC,OAAO,CAAC,wBAAwB,CAAC;IAQpC;;;OAGG;IACG,MAAM,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;CAMpE"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"collectionTypeConfigsApi.js","sourceRoot":"","sources":["../../api/collectionTypeConfigsApi.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"collectionTypeConfigsApi.js","sourceRoot":"","sources":["../../api/collectionTypeConfigsApi.ts"],"names":[],"mappings":"AAsDA,MAAM,OAAO,wBAAwB;IACnC,YAAoB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAE3C,oEAAoE;IACpE,KAAK,CAAC,IAAI;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,0BAA0B,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,GAAG,CAAC,cAAsB;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,KAAK,EACL,4BAA4B,kBAAkB,CAAC,cAAc,CAAC,EAAE,CACjE,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CACV,MAAwC;QAExC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,cAAsB,EACtB,MAAwC;QAExC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,OAAO,EACP,4BAA4B,kBAAkB,CAAC,cAAc,CAAC,EAAE,EAChE,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,cAAsB;QACjC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,QAAQ,EACR,4BAA4B,kBAAkB,CAAC,cAAc,CAAC,EAAE,CACjE,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -15,6 +15,14 @@ export interface CollectionInfo {
|
|
|
15
15
|
* CEL rules (`collection.contextId`) to identify the external entity the
|
|
16
16
|
* collection is bound to (e.g. a class ID, project ID). `null` for
|
|
17
17
|
* collections not bound to any context. Immutable after create.
|
|
18
|
+
*
|
|
19
|
+
* @deprecated Prefer resource metadata categories (issue #1420). Stamp a
|
|
20
|
+
* category at create time via {@link CreateCollectionParams.initialMetadata}
|
|
21
|
+
* and read it from CEL as `md.self.<category>.<key>`. Note the migration is
|
|
22
|
+
* not 1:1: because `collection.contextId` is consumed inside rule sets, a rule
|
|
23
|
+
* set can read `md.self.<category>.<key>` only when the collection type config
|
|
24
|
+
* declares a `metadataManifest` for that category. See `collections.md`. The
|
|
25
|
+
* field keeps working.
|
|
18
26
|
*/
|
|
19
27
|
contextId: string | null;
|
|
20
28
|
documentCount: number;
|
|
@@ -100,6 +108,13 @@ export interface CreateCollectionParams {
|
|
|
100
108
|
* Optional. Per-instance identifier that ties the collection to an
|
|
101
109
|
* external entity (e.g. a class ID). Exposed to CEL rules as
|
|
102
110
|
* `collection.contextId`. Must not contain `"#"`. Immutable after create.
|
|
111
|
+
*
|
|
112
|
+
* @deprecated Prefer resource metadata categories (issue #1420). Stamp the
|
|
113
|
+
* binding via {@link initialMetadata} and read it from CEL as
|
|
114
|
+
* `md.self.<category>.<key>`. The migration is not 1:1: a rule set can read
|
|
115
|
+
* `md.self.<category>.<key>` only when the collection type config declares a
|
|
116
|
+
* `metadataManifest` for that category. See `collections.md`. The field keeps
|
|
117
|
+
* working.
|
|
103
118
|
*/
|
|
104
119
|
contextId?: string;
|
|
105
120
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"collectionsApi.d.ts","sourceRoot":"","sources":["../../api/collectionsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAGlD,MAAM,WAAW,cAAc;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB
|
|
1
|
+
{"version":3,"file":"collectionsApi.d.ts","sourceRoot":"","sources":["../../api/collectionsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAGlD,MAAM,WAAW,cAAc;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;;;;;;;;;;;OAaG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,YAAY,CAAC;CACtC;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,kEAAkE;IAClE,OAAO,EAAE,MAAM,CAAC;IAChB,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC;IAChB,sBAAsB;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,UAAU,EAAE,OAAO,GAAG,YAAY,GAAG,QAAQ,CAAC;IAC9C,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,6BAA6B;IAC5C,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,6BAA6B,EAAE,CAAC;IACxC,OAAO,EAAE,oBAAoB,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC3D;AAED,MAAM,WAAW,sBAAsB;IACrC,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oCAAoC;IACnD,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,OAAO,EAAE,MAAM,CAAC;IAChB,8DAA8D;IAC9D,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GACjC;IACE,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;;OAGG;IACH,UAAU,EAAE,QAAQ,GAAG,YAAY,CAAC;IACpC,6DAA6D;IAC7D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,qDAAqD;IACrD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,GACD;IACE,qEAAqE;IACrE,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,KAAK,CAAC;IACf;;OAEG;IACH,UAAU,EAAE,QAAQ,GAAG,YAAY,CAAC;IACpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,2DAA2D;IAC3D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEN;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC;8EAC0E;IAC1E,MAAM,EAAE,OAAO,GAAG,gBAAgB,CAAC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,QAAQ,GAAG,YAAY,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,QAAQ,GAAG,YAAY,CAAC;IACpC,oBAAoB,EAAE,OAAO,CAAC;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,mEAAmE;IACnE,YAAY,EAAE,MAAM,CAAC;IACrB,uEAAuE;IACvE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,yBAAyB,GACjC,mBAAmB,GACnB,qBAAqB,CAAC;AAE1B,kDAAkD;AAClD,MAAM,WAAW,gCAAgC;IAC/C,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,UAAU,EAAE,QAAQ,GAAG,YAAY,CAAC;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,qBAAa,cAAc;IACb,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,WAAW;IAEvC;;;OAGG;IACG,MAAM,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,cAAc,CAAC;IAIrE;;;;;;;;;;;;;;OAcG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IAQ3C;;;;;;;;;;OAUG;IACG,OAAO,CACX,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IAW3C;;;;;;;;;;OAUG;IACG,GAAG,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAIxD;;;;OAIG;IACG,MAAM,CACV,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,cAAc,CAAC;IAQ1B;;;OAGG;IACG,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAIjE;;;;OAIG;IACG,WAAW,CACf,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,sBAAsB,CAAC;IAQlC;;;;OAIG;IACG,cAAc,CAClB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAOhC;;;;;;OAMG;IACG,aAAa,CACjB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC;IAWnD;;;;;;;;;;;;OAYG;IACG,0BAA0B,CAC9B,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC;IAWnD;;;OAGG;IACG,SAAS,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAOpE;;;;OAIG;IACG,oBAAoB,CACxB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,oCAAoC,GAC3C,OAAO,CAAC,6BAA6B,CAAC;IAQzC;;;;;OAKG;IACG,qBAAqB,CACzB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAOhC;;;;;;;;;;;;;;;;;OAiBG;IACG,SAAS,CACb,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,yBAAyB,GAChC,OAAO,CAAC,yBAAyB,CAAC;IAQrC;;;;OAIG;IACG,YAAY,CAChB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAOhC;;;;;;;;;;OAUG;IACG,sBAAsB,CAC1B,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,gCAAgC,EAAE,CAAC;CAO/C"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"collectionsApi.js","sourceRoot":"","sources":["../../api/collectionsApi.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"collectionsApi.js","sourceRoot":"","sources":["../../api/collectionsApi.ts"],"names":[],"mappings":"AA8PA,MAAM,OAAO,cAAc;IACzB,YAAoB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAE3C;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,MAA8B;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,IAAI,CACR,OAA2B;QAE3B,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,IAAI,OAAO,EAAE,KAAK;YAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/D,IAAI,OAAO,EAAE,MAAM;YAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAO,CACX,OAA2B;QAE3B,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,IAAI,OAAO,EAAE,KAAK;YAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/D,IAAI,OAAO,EAAE,MAAM;YAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,KAAK,EACL,qBAAqB,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAC1C,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,YAAoB;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,gBAAgB,YAAY,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,YAAoB,EACpB,MAA8B;QAE9B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,OAAO,EACP,gBAAgB,YAAY,EAAE,EAC9B,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,YAAoB;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,gBAAgB,YAAY,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CACf,YAAoB,EACpB,UAAkB;QAElB,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,MAAM,EACN,gBAAgB,YAAY,YAAY,EACxC,EAAE,UAAU,EAAE,CACf,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAClB,YAAoB,EACpB,UAAkB;QAElB,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,QAAQ,EACR,gBAAgB,YAAY,cAAc,UAAU,EAAE,CACvD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CACjB,YAAoB,EACpB,OAA2B;QAE3B,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,IAAI,OAAO,EAAE,KAAK;YAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/D,IAAI,OAAO,EAAE,MAAM;YAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,KAAK,EACL,gBAAgB,YAAY,aAAa,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAC9D,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,0BAA0B,CAC9B,UAAkB,EAClB,OAA2B;QAE3B,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,IAAI,OAAO,EAAE,KAAK;YAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/D,IAAI,OAAO,EAAE,MAAM;YAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,KAAK,EACL,cAAc,UAAU,eAAe,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAC5D,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS,CAAC,YAAoB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,KAAK,EACL,gBAAgB,YAAY,SAAS,CACtC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,oBAAoB,CACxB,YAAoB,EACpB,MAA4C;QAE5C,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,MAAM,EACN,gBAAgB,YAAY,oBAAoB,EAChD,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,YAAoB,EACpB,SAAiB,EACjB,OAAe;QAEf,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,QAAQ,EACR,gBAAgB,YAAY,sBAAsB,SAAS,IAAI,OAAO,EAAE,CACzE,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,SAAS,CACb,YAAoB,EACpB,MAAiC;QAEjC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,MAAM,EACN,gBAAgB,YAAY,UAAU,EACtC,MAAM,CAC+B,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAChB,YAAoB,EACpB,MAAc;QAEd,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,QAAQ,EACR,gBAAgB,YAAY,YAAY,MAAM,EAAE,CACjD,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,sBAAsB,CAC1B,YAAoB;QAEpB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5C,KAAK,EACL,gBAAgB,YAAY,sBAAsB,CACnD,CAAC;QACF,OAAO,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAuC,CAAC;IACvE,CAAC;CACF"}
|
|
@@ -32,7 +32,7 @@ export interface CronTriggerInfo {
|
|
|
32
32
|
* *return* shape) stays `string | null` because the server serializes it —
|
|
33
33
|
* `I` types only the object you write here.
|
|
34
34
|
*/
|
|
35
|
-
export interface CreateCronTriggerParams<I =
|
|
35
|
+
export interface CreateCronTriggerParams<I = unknown> {
|
|
36
36
|
/** Unique per-app identifier (alphanumerics, hyphens, underscores). */
|
|
37
37
|
triggerKey: string;
|
|
38
38
|
/** Display name shown in UIs. */
|
|
@@ -53,7 +53,7 @@ export interface CreateCronTriggerParams<I = any> {
|
|
|
53
53
|
inputMapping?: any;
|
|
54
54
|
}
|
|
55
55
|
/** See {@link CreateCronTriggerParams} for the `I` (write-side `rootInput`) generic. */
|
|
56
|
-
export interface UpdateCronTriggerParams<I =
|
|
56
|
+
export interface UpdateCronTriggerParams<I = unknown> {
|
|
57
57
|
displayName?: string;
|
|
58
58
|
description?: string | null;
|
|
59
59
|
cron?: string;
|
|
@@ -87,12 +87,12 @@ export declare class CronTriggersAPI {
|
|
|
87
87
|
* Create a new cron trigger. The associated Durable Object is bound and
|
|
88
88
|
* scheduled as part of this call.
|
|
89
89
|
*/
|
|
90
|
-
create<I =
|
|
90
|
+
create<I = unknown>(params: CreateCronTriggerParams<I>): Promise<CronTriggerInfo>;
|
|
91
91
|
/**
|
|
92
92
|
* Update one or more fields of an existing cron trigger. Schedule-relevant
|
|
93
93
|
* field changes (cron, timezone, state) are pushed to the Durable Object.
|
|
94
94
|
*/
|
|
95
|
-
update<I =
|
|
95
|
+
update<I = unknown>(triggerId: string, params: UpdateCronTriggerParams<I>): Promise<CronTriggerInfo>;
|
|
96
96
|
/**
|
|
97
97
|
* Soft-delete (archive) a cron trigger and cancel its pending alarm.
|
|
98
98
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cronTriggersApi.d.ts","sourceRoot":"","sources":["../../api/cronTriggersApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,cAAc,GAAG,UAAU,CAAC;IACzD,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE;QACR,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAC9B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC,CAAC;CACH;AAED;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC,GAAG,
|
|
1
|
+
{"version":3,"file":"cronTriggersApi.d.ts","sourceRoot":"","sources":["../../api/cronTriggersApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,cAAc,GAAG,UAAU,CAAC;IACzD,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE;QACR,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAC9B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;KACjC,CAAC;CACH;AAED;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC,GAAG,OAAO;IAClD,uEAAuE;IACvE,UAAU,EAAE,MAAM,CAAC;IACnB,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,WAAW,EAAE,MAAM,CAAC;IACpB,kEAAkE;IAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gGAAgG;IAChG,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,sDAAsD;IACtD,SAAS,CAAC,EAAE,CAAC,CAAC;IACd,0EAA0E;IAC1E,YAAY,CAAC,EAAE,GAAG,CAAC;CACpB;AAED,wFAAwF;AACxF,MAAM,WAAW,uBAAuB,CAAC,CAAC,GAAG,OAAO;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;IACrB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,KAAK,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;CAC1C;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,eAAe,EAAE,CAAC;CAC1B;AAED,qBAAa,eAAe;IACd,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,WAAW;IAEvC;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAI5C;;OAEG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAItD;;;OAGG;IACG,MAAM,CAAC,CAAC,GAAG,OAAO,EACtB,MAAM,EAAE,uBAAuB,CAAC,CAAC,CAAC,GACjC,OAAO,CAAC,eAAe,CAAC;IAI3B;;;OAGG;IACG,MAAM,CAAC,CAAC,GAAG,OAAO,EACtB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,uBAAuB,CAAC,CAAC,CAAC,GACjC,OAAO,CAAC,eAAe,CAAC;IAQ3B;;OAEG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC;IAO/D;;;OAGG;IACG,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAOxD;;;OAGG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAOzD;;OAEG;IACG,IAAI,CACR,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAMtF"}
|
|
@@ -1,5 +1,69 @@
|
|
|
1
1
|
import type { JsBaoClient } from "../JsBaoClient";
|
|
2
2
|
import type { ModelRulesInfo } from "./ruleSetsApi";
|
|
3
|
+
/**
|
|
4
|
+
* A `from`-rooted traversal edge: hop from an already-declared source node
|
|
5
|
+
* (`self` or another declared path) to the target whose id is stored at `via`
|
|
6
|
+
* (`<category>.<key>`) on that source. Carries no `rootFrom`.
|
|
7
|
+
*/
|
|
8
|
+
export interface DeclaredManifestPathFrom {
|
|
9
|
+
/** Source node (`self` or another declared path); pairs with `via`. */
|
|
10
|
+
from: string;
|
|
11
|
+
/** `<category>.<key>` on the source node whose value is the target's id. */
|
|
12
|
+
via: string;
|
|
13
|
+
rootFrom?: never;
|
|
14
|
+
/** The target resource's `resourceType`. */
|
|
15
|
+
type: string;
|
|
16
|
+
/** Target categories to load and bind under `md.<name>`. */
|
|
17
|
+
categories: string[];
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* A `rootFrom`-rooted traversal edge: the target id comes straight from a
|
|
21
|
+
* static dotted context path (`input.*` / `record.*` / `params.*`, or the
|
|
22
|
+
* server-authenticated `user.userId`). It roots the graph, so it takes no
|
|
23
|
+
* `from` / `via`.
|
|
24
|
+
*/
|
|
25
|
+
export interface DeclaredManifestPathRootFrom {
|
|
26
|
+
/** Static dotted context path holding the target id (subjectless rules). */
|
|
27
|
+
rootFrom: string;
|
|
28
|
+
from?: never;
|
|
29
|
+
via?: never;
|
|
30
|
+
/** The target resource's `resourceType`. */
|
|
31
|
+
type: string;
|
|
32
|
+
/** Target categories to load and bind under `md.<name>`. */
|
|
33
|
+
categories: string[];
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* A single declared traversal edge in a {@link DeclaredMetadataManifest}
|
|
37
|
+
* (`md.<name>.<category>.<key>`). Exactly one of the two variants roots the
|
|
38
|
+
* edge — a `from` + `via` hop off an already-declared node, or a `rootFrom`
|
|
39
|
+
* static-context root. Modeled as an exclusive union so a shape the server's
|
|
40
|
+
* `validatePathGraph` rejects with HTTP 400 (neither root, both roots, `from`
|
|
41
|
+
* without `via`, or `rootFrom` combined with `via`) is a compile error rather
|
|
42
|
+
* than a runtime 400. Mirrors the server's `PathDeclaration` (issue #1304 /
|
|
43
|
+
* #1420).
|
|
44
|
+
*/
|
|
45
|
+
export type DeclaredManifestPath = DeclaredManifestPathFrom | DeclaredManifestPathRootFrom;
|
|
46
|
+
/**
|
|
47
|
+
* A declared-access manifest (issue #1304 / #1420). Declares exactly which
|
|
48
|
+
* resource metadata categories and scalar roots a type config's CEL rules may
|
|
49
|
+
* load: `self` categories on the subject, declared traversal `paths`, and the
|
|
50
|
+
* `secrets` / `vars` keys the rules reference. A category is reachable from a
|
|
51
|
+
* rule as `md.self.<category>.<key>` only when it is declared here — this is the
|
|
52
|
+
* manifest prerequisite for migrating off `metadataAccess` / `contextId` to
|
|
53
|
+
* metadata categories. Persisted JSON-stringified; the API returns it parsed.
|
|
54
|
+
*/
|
|
55
|
+
export interface DeclaredMetadataManifest {
|
|
56
|
+
/** Categories on the subject resource to load under `md.self`. */
|
|
57
|
+
self?: {
|
|
58
|
+
categories: string[];
|
|
59
|
+
};
|
|
60
|
+
/** Declared traversal edges, keyed by the `md.<name>` they bind under. */
|
|
61
|
+
paths?: Record<string, DeclaredManifestPath>;
|
|
62
|
+
/** Secret keys the rules may reference as `secrets.<KEY>`. */
|
|
63
|
+
secrets?: string[];
|
|
64
|
+
/** Non-secret config-var keys the rules may reference as `vars.<KEY>`. */
|
|
65
|
+
vars?: string[];
|
|
66
|
+
}
|
|
3
67
|
/**
|
|
4
68
|
* A serialized database-type-configuration row, as returned by the
|
|
5
69
|
* `databases/types` endpoints.
|
|
@@ -23,8 +87,23 @@ export interface DatabaseTypeConfigInfo {
|
|
|
23
87
|
/**
|
|
24
88
|
* CEL expression evaluated to decide whether the caller can read database
|
|
25
89
|
* metadata. `null` when not configured.
|
|
90
|
+
*
|
|
91
|
+
* @deprecated Prefer resource metadata categories (issue #1420). This single
|
|
92
|
+
* expression gates read AND update of the database CEL context, so granting
|
|
93
|
+
* read also grants update. Declare a metadata category in
|
|
94
|
+
* {@link metadataManifest} — a category has separate `readRule`/`writeRule`
|
|
95
|
+
* — and read it from CEL as `md.self.<category>.<key>`. See the migration
|
|
96
|
+
* recipe in `databases.md`. The field keeps working; the runtime gate is
|
|
97
|
+
* unchanged.
|
|
26
98
|
*/
|
|
27
99
|
metadataAccess: string | null;
|
|
100
|
+
/**
|
|
101
|
+
* The declared-access manifest for this type's CEL rules (issue #1420),
|
|
102
|
+
* returned parsed. `null` when none is set. Declaring a category here is the
|
|
103
|
+
* prerequisite for reading `md.self.<category>.<key>` from this type's rules —
|
|
104
|
+
* i.e. for migrating a `metadataAccess` gate to a metadata category.
|
|
105
|
+
*/
|
|
106
|
+
metadataManifest: DeclaredMetadataManifest | null;
|
|
28
107
|
createdAt: string;
|
|
29
108
|
modifiedAt: string;
|
|
30
109
|
createdBy: string;
|
|
@@ -39,8 +118,22 @@ export interface CreateDatabaseTypeConfigParams {
|
|
|
39
118
|
* against the schema defined in `database-type-config-controller.ts`.
|
|
40
119
|
*/
|
|
41
120
|
triggers?: Record<string, ModelRulesInfo>;
|
|
42
|
-
/**
|
|
121
|
+
/**
|
|
122
|
+
* Optional CEL expression gating metadata access.
|
|
123
|
+
*
|
|
124
|
+
* @deprecated Prefer resource metadata categories (issue #1420) — declare a
|
|
125
|
+
* category in {@link metadataManifest} (separate `readRule`/`writeRule`, so
|
|
126
|
+
* read no longer implies update) and read it as `md.self.<category>.<key>`.
|
|
127
|
+
* See `databases.md`.
|
|
128
|
+
*/
|
|
43
129
|
metadataAccess?: string;
|
|
130
|
+
/**
|
|
131
|
+
* Optional declared-access manifest (issue #1420) that lets this type's CEL
|
|
132
|
+
* rules load metadata categories as `md.self.<category>.<key>` (and traversed
|
|
133
|
+
* `md.<node>.*`). Declaring a category here is the prerequisite for migrating
|
|
134
|
+
* a `metadataAccess` gate to a metadata category.
|
|
135
|
+
*/
|
|
136
|
+
metadataManifest?: DeclaredMetadataManifest;
|
|
44
137
|
}
|
|
45
138
|
export interface UpdateDatabaseTypeConfigParams {
|
|
46
139
|
/** New rule set ID to associate, or null to remove the current rule set */
|
|
@@ -52,8 +145,18 @@ export interface UpdateDatabaseTypeConfigParams {
|
|
|
52
145
|
triggers?: Record<string, ModelRulesInfo> | null;
|
|
53
146
|
/**
|
|
54
147
|
* Replacement metadata-access CEL expression, or null to clear it.
|
|
148
|
+
*
|
|
149
|
+
* @deprecated Prefer resource metadata categories (issue #1420) — declare a
|
|
150
|
+
* category in {@link metadataManifest} (separate `readRule`/`writeRule`) and
|
|
151
|
+
* read it as `md.self.<category>.<key>`. See `databases.md`.
|
|
55
152
|
*/
|
|
56
153
|
metadataAccess?: string | null;
|
|
154
|
+
/**
|
|
155
|
+
* Replacement declared-access manifest (issue #1420), or null to clear it.
|
|
156
|
+
* Set this to make metadata categories reachable from this type's CEL rules
|
|
157
|
+
* as `md.self.<category>.<key>` when migrating off `metadataAccess`.
|
|
158
|
+
*/
|
|
159
|
+
metadataManifest?: DeclaredMetadataManifest | null;
|
|
57
160
|
}
|
|
58
161
|
export declare class DatabaseTypeConfigsAPI {
|
|
59
162
|
private client;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"databaseTypeConfigsApi.d.ts","sourceRoot":"","sources":["../../api/databaseTypeConfigsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAEpD;;;;;;;;GAQG;AACH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,IAAI,CAAC;IAChD
|
|
1
|
+
{"version":3,"file":"databaseTypeConfigsApi.d.ts","sourceRoot":"","sources":["../../api/databaseTypeConfigsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAEpD;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,4EAA4E;IAC5E,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,4BAA4B;IAC3C,4EAA4E;IAC5E,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,GAAG,CAAC,EAAE,KAAK,CAAC;IACZ,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,oBAAoB,GAC5B,wBAAwB,GACxB,4BAA4B,CAAC;AAEjC;;;;;;;;GAQG;AACH,MAAM,WAAW,wBAAwB;IACvC,kEAAkE;IAClE,IAAI,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAChC,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAC7C,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,IAAI,CAAC;IAChD;;;;;;;;;;;OAWG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;;;;OAKG;IACH,gBAAgB,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAClD,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,8BAA8B;IAC7C,iEAAiE;IACjE,YAAY,EAAE,MAAM,CAAC;IACrB,iGAAiG;IACjG,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC1C;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;CAC7C;AAED,MAAM,WAAW,8BAA8B;IAC7C,2EAA2E;IAC3E,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,IAAI,CAAC;IACjD;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;CACpD;AAED,qBAAa,sBAAsB;IACrB,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,WAAW;IAEvC,kEAAkE;IAC5D,IAAI,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAI/C;;;OAGG;IACG,GAAG,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAOhE;;;OAGG;IACG,MAAM,CACV,MAAM,EAAE,8BAA8B,GACrC,OAAO,CAAC,sBAAsB,CAAC;IAIlC;;;;OAIG;IACG,MAAM,CACV,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,8BAA8B,GACrC,OAAO,CAAC,sBAAsB,CAAC;IAQlC;;;OAGG;IACG,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;CAMlE"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"databaseTypeConfigsApi.js","sourceRoot":"","sources":["../../api/databaseTypeConfigsApi.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"databaseTypeConfigsApi.js","sourceRoot":"","sources":["../../api/databaseTypeConfigsApi.ts"],"names":[],"mappings":"AAwKA,MAAM,OAAO,sBAAsB;IACjC,YAAoB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAE3C,kEAAkE;IAClE,KAAK,CAAC,IAAI;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,GAAG,CAAC,YAAoB;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,KAAK,EACL,oBAAoB,kBAAkB,CAAC,YAAY,CAAC,EAAE,CACvD,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CACV,MAAsC;QAEtC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,YAAoB,EACpB,MAAsC;QAEtC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,OAAO,EACP,oBAAoB,kBAAkB,CAAC,YAAY,CAAC,EAAE,EACtD,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,YAAoB;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,QAAQ,EACR,oBAAoB,kBAAkB,CAAC,YAAY,CAAC,EAAE,CACvD,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -7,9 +7,13 @@ export interface DatabaseInfo {
|
|
|
7
7
|
title: string;
|
|
8
8
|
databaseType: string | null;
|
|
9
9
|
/**
|
|
10
|
-
* @deprecated Prefer
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* @deprecated Prefer resource metadata categories (issue #1420) — a category
|
|
11
|
+
* has separate `readRule`/`writeRule` (granting read no longer grants update)
|
|
12
|
+
* and is read from CEL as `md.self.<category>.<key>`. See the migration recipe
|
|
13
|
+
* in `databases.md`. This field is the legacy wire-level name for the same
|
|
14
|
+
* dict as the (also-deprecated) {@link celContext}; it stays for backwards
|
|
15
|
+
* compatibility with stored CEL expressions that reference
|
|
16
|
+
* `database.metadata.<key>`.
|
|
13
17
|
*/
|
|
14
18
|
metadata: Record<string, any> | null;
|
|
15
19
|
/**
|
|
@@ -17,6 +21,14 @@ export interface DatabaseInfo {
|
|
|
17
21
|
* Values here are referenced from CEL access rules as
|
|
18
22
|
* `database.celContext.<key>` (or the legacy `database.metadata.<key>`)
|
|
19
23
|
* and from filter JSON as `$database.celContext.<key>`.
|
|
24
|
+
*
|
|
25
|
+
* @deprecated Prefer resource metadata categories (issue #1420). A category
|
|
26
|
+
* carries separate `readRule`/`writeRule`, so granting read no longer implies
|
|
27
|
+
* granting update — the foot-gun of the CEL-context access gate
|
|
28
|
+
* (`metadataAccess`), which gates read AND update with a single expression.
|
|
29
|
+
* Declare a category in the database type config's `metadataManifest` and read
|
|
30
|
+
* it from CEL as `md.self.<category>.<key>`. See the migration recipe in
|
|
31
|
+
* `databases.md`. The field keeps working; nothing is removed here.
|
|
20
32
|
*/
|
|
21
33
|
celContext: Record<string, any> | null;
|
|
22
34
|
permission: string | null;
|
|
@@ -62,7 +74,7 @@ export interface DatabaseOwnershipTransferResult {
|
|
|
62
74
|
previousOwnerId: string;
|
|
63
75
|
newOwnerId: string;
|
|
64
76
|
}
|
|
65
|
-
export interface CsvImportOptions<T extends object = Record<string,
|
|
77
|
+
export interface CsvImportOptions<T extends object = Record<string, unknown>> {
|
|
66
78
|
/** CSV string to parse. Provide either `csv` or `data`. */
|
|
67
79
|
csv?: string;
|
|
68
80
|
/** Pre-parsed rows (array of objects). Provide either `csv` or `data`. */
|
|
@@ -133,8 +145,11 @@ export interface CreateDatabaseParams {
|
|
|
133
145
|
databaseType: string;
|
|
134
146
|
/**
|
|
135
147
|
* Optional key-value pairs to attach as the database's CEL context.
|
|
136
|
-
* @deprecated Prefer
|
|
137
|
-
*
|
|
148
|
+
* @deprecated Prefer resource metadata categories (issue #1420) — a category
|
|
149
|
+
* has separate `readRule`/`writeRule` and is read from CEL as
|
|
150
|
+
* `md.self.<category>.<key>`. See the migration recipe in `databases.md`. The
|
|
151
|
+
* legacy name ("metadata") is the same field as the (also-deprecated)
|
|
152
|
+
* {@link celContext} and still works.
|
|
138
153
|
*/
|
|
139
154
|
metadata?: Record<string, string | number | boolean | null>;
|
|
140
155
|
/**
|
|
@@ -142,6 +157,12 @@ export interface CreateDatabaseParams {
|
|
|
142
157
|
* Values set here can be referenced from CEL access rules as
|
|
143
158
|
* `database.celContext.<key>` (or the legacy `database.metadata.<key>`)
|
|
144
159
|
* and from filter JSON as `$database.celContext.<key>`.
|
|
160
|
+
*
|
|
161
|
+
* @deprecated Prefer resource metadata categories (issue #1420) — a category
|
|
162
|
+
* has separate `readRule`/`writeRule` (read no longer implies update, unlike
|
|
163
|
+
* the `metadataAccess` gate) and is read from CEL as `md.self.<category>.<key>`.
|
|
164
|
+
* Stamp create-time category values via {@link initialMetadata} instead. See
|
|
165
|
+
* the migration recipe in `databases.md`. The field keeps working.
|
|
145
166
|
*/
|
|
146
167
|
celContext?: Record<string, string | number | boolean | null>;
|
|
147
168
|
/**
|
|
@@ -173,7 +194,7 @@ export interface GrantPermissionParams {
|
|
|
173
194
|
/** The access level to grant (must be "manager") */
|
|
174
195
|
permission: "manager";
|
|
175
196
|
}
|
|
176
|
-
export interface ExecuteOperationOptions<P extends object = Record<string,
|
|
197
|
+
export interface ExecuteOperationOptions<P extends object = Record<string, unknown>> {
|
|
177
198
|
/** Runtime parameter values to pass into the operation */
|
|
178
199
|
params?: P;
|
|
179
200
|
/** Maximum number of records to return */
|
|
@@ -198,7 +219,7 @@ export interface ExecuteOperationOptions<P extends object = Record<string, any>>
|
|
|
198
219
|
* Keep this in sync with the internal copy in
|
|
199
220
|
* `internal/databaseSubscriptions.ts` — see #949 (the two had drifted).
|
|
200
221
|
*/
|
|
201
|
-
export interface DatabaseChangeEvent<T =
|
|
222
|
+
export interface DatabaseChangeEvent<T = unknown> {
|
|
202
223
|
changeType?: "enter" | "update" | "leave";
|
|
203
224
|
op: "save" | "patch" | "delete" | "increment" | "addToSet" | "removeFromSet";
|
|
204
225
|
modelName: string;
|
|
@@ -217,7 +238,7 @@ export interface DatabaseChangeEvent<T = any> {
|
|
|
217
238
|
previousData?: T | null;
|
|
218
239
|
}
|
|
219
240
|
/** Envelope for a `db.change` event (one event, potentially N changes). */
|
|
220
|
-
export interface DatabaseChangePayload<T =
|
|
241
|
+
export interface DatabaseChangePayload<T = unknown> {
|
|
221
242
|
type: "db.change";
|
|
222
243
|
databaseId: string;
|
|
223
244
|
subscriptionKey: string;
|
|
@@ -263,7 +284,7 @@ export interface DatabaseChangePayload<T = any> {
|
|
|
263
284
|
* binds `T` across the whole delivery path (event → payload envelope →
|
|
264
285
|
* `onChange`).
|
|
265
286
|
*/
|
|
266
|
-
export interface DatabaseSubscribeOptions<T =
|
|
287
|
+
export interface DatabaseSubscribeOptions<T = unknown, P extends object = Record<string, unknown>> {
|
|
267
288
|
/** Bound params passed to the server; available in filter CEL as `params.*` */
|
|
268
289
|
params?: P;
|
|
269
290
|
/** Called for every matching `db.change` frame until `unsub()` is called */
|
|
@@ -277,7 +298,7 @@ export interface DatabaseSubscribeOptions<T = any, P extends object = Record<str
|
|
|
277
298
|
* by `getCelContext` and its deprecated `getMetadata` alias so the two can't
|
|
278
299
|
* drift.
|
|
279
300
|
*/
|
|
280
|
-
export interface CelContextResult<C extends object = Record<string,
|
|
301
|
+
export interface CelContextResult<C extends object = Record<string, unknown>> {
|
|
281
302
|
databaseId: string;
|
|
282
303
|
metadata: C | null;
|
|
283
304
|
celContext: C | null;
|
|
@@ -322,7 +343,7 @@ export declare class DatabasesAPI {
|
|
|
322
343
|
* unsub();
|
|
323
344
|
* ```
|
|
324
345
|
*/
|
|
325
|
-
subscribe<T =
|
|
346
|
+
subscribe<T = unknown, P extends object = Record<string, unknown>>(databaseId: string, subscriptionKey: string, options: DatabaseSubscribeOptions<T, P>): () => void;
|
|
326
347
|
/**
|
|
327
348
|
* Create a new database.
|
|
328
349
|
* @param params - Configuration for the new database
|
|
@@ -370,9 +391,14 @@ export declare class DatabasesAPI {
|
|
|
370
391
|
* The returned payload includes the same dict under both `metadata` (legacy
|
|
371
392
|
* wire name) and `celContext` (new user-facing name).
|
|
372
393
|
*
|
|
394
|
+
* @deprecated Prefer resource metadata categories (issue #1420). The
|
|
395
|
+
* `metadataAccess` gate that controls this read uses one CEL expression to
|
|
396
|
+
* gate read AND update, so granting read also grants update. A metadata
|
|
397
|
+
* category has separate `readRule`/`writeRule`; read its values from CEL as
|
|
398
|
+
* `md.self.<category>.<key>`. See the migration recipe in `databases.md`.
|
|
373
399
|
* @param databaseId - The unique identifier of the database to read
|
|
374
400
|
*/
|
|
375
|
-
getCelContext<C extends object = Record<string,
|
|
401
|
+
getCelContext<C extends object = Record<string, unknown>>(databaseId: string): Promise<CelContextResult<C>>;
|
|
376
402
|
/**
|
|
377
403
|
* Update a database's CEL context dict (merge with existing).
|
|
378
404
|
*
|
|
@@ -380,23 +406,38 @@ export declare class DatabasesAPI {
|
|
|
380
406
|
* `database.celContext.<key>` (or legacy `database.metadata.<key>`) and
|
|
381
407
|
* from filter JSON as `$database.celContext.<key>`.
|
|
382
408
|
*
|
|
409
|
+
* @deprecated Prefer resource metadata categories (issue #1420). Writing here
|
|
410
|
+
* is gated by the same single `metadataAccess` expression that gates reads, so
|
|
411
|
+
* anyone allowed to read can also update. A metadata category has separate
|
|
412
|
+
* `readRule`/`writeRule`; write its values with `resourceMetadata` /
|
|
413
|
+
* `initialMetadata` and read them from CEL as `md.self.<category>.<key>`. See
|
|
414
|
+
* the migration recipe in `databases.md`.
|
|
383
415
|
* @param databaseId - The unique identifier of the database to update
|
|
384
416
|
* @param celContext - Key-value pairs to merge into the database's existing CEL context
|
|
385
417
|
*/
|
|
386
|
-
updateCelContext<C extends object = Record<string,
|
|
418
|
+
updateCelContext<C extends object = Record<string, unknown>>(databaseId: string, celContext: C): Promise<DatabaseInfo>;
|
|
387
419
|
/**
|
|
388
420
|
* Read a database's CEL context dict.
|
|
389
|
-
* @deprecated
|
|
421
|
+
* @deprecated Prefer resource metadata categories (issue #1420) — a category
|
|
422
|
+
* has separate `readRule`/`writeRule` (read no longer implies update) and is
|
|
423
|
+
* read from CEL as `md.self.<category>.<key>`. See the migration recipe in
|
|
424
|
+
* `databases.md`. This is the legacy wire-name alias of the (also-deprecated)
|
|
425
|
+
* {@link getCelContext}.
|
|
390
426
|
* @param databaseId - The unique identifier of the database to read
|
|
391
427
|
*/
|
|
392
|
-
getMetadata<C extends object = Record<string,
|
|
428
|
+
getMetadata<C extends object = Record<string, unknown>>(databaseId: string): Promise<CelContextResult<C>>;
|
|
393
429
|
/**
|
|
394
430
|
* Update a database's CEL context dict (merge with existing).
|
|
395
|
-
* @deprecated
|
|
431
|
+
* @deprecated Prefer resource metadata categories (issue #1420) — a category
|
|
432
|
+
* has separate `readRule`/`writeRule`, so a writer no longer inherits update
|
|
433
|
+
* from read access. Write category values with `resourceMetadata` /
|
|
434
|
+
* `initialMetadata` and read them from CEL as `md.self.<category>.<key>`. See
|
|
435
|
+
* the migration recipe in `databases.md`. This is the legacy wire-name alias
|
|
436
|
+
* of the (also-deprecated) {@link updateCelContext}.
|
|
396
437
|
* @param databaseId - The unique identifier of the database to update
|
|
397
438
|
* @param metadata - Key-value pairs to merge into the database's existing CEL context
|
|
398
439
|
*/
|
|
399
|
-
updateMetadata<C extends object = Record<string,
|
|
440
|
+
updateMetadata<C extends object = Record<string, unknown>>(databaseId: string, metadata: C): Promise<DatabaseInfo>;
|
|
400
441
|
/**
|
|
401
442
|
* Delete a database.
|
|
402
443
|
* @param databaseId - The unique identifier of the database to delete
|
|
@@ -522,7 +563,7 @@ export declare class DatabasesAPI {
|
|
|
522
563
|
* @param name - The name of the operation to execute
|
|
523
564
|
* @param options - Execution options for parameters, pagination, and diagnostics
|
|
524
565
|
*/
|
|
525
|
-
executeOperation<R =
|
|
566
|
+
executeOperation<R = unknown, P extends object = Record<string, unknown>>(databaseId: string, name: string, options?: ExecuteOperationOptions<P>): Promise<R>;
|
|
526
567
|
/**
|
|
527
568
|
* Execute a batch of records using a named mutation operation.
|
|
528
569
|
* @param databaseId - The unique identifier of the database to execute against
|
|
@@ -530,7 +571,7 @@ export declare class DatabasesAPI {
|
|
|
530
571
|
* @param batch - Array of parameter objects, each passed to the operation as a single invocation
|
|
531
572
|
* @returns Object with `imported` and `failed` record counts
|
|
532
573
|
*/
|
|
533
|
-
executeBatch<P extends object = Record<string,
|
|
574
|
+
executeBatch<P extends object = Record<string, unknown>>(databaseId: string, operationName: string, batch: Array<{
|
|
534
575
|
params: P;
|
|
535
576
|
}>): Promise<{
|
|
536
577
|
imported: number;
|
|
@@ -539,7 +580,7 @@ export declare class DatabasesAPI {
|
|
|
539
580
|
/**
|
|
540
581
|
* @deprecated Use executeBatch instead
|
|
541
582
|
*/
|
|
542
|
-
importBulk<P extends object = Record<string,
|
|
583
|
+
importBulk<P extends object = Record<string, unknown>>(databaseId: string, operationName: string, batch: Array<{
|
|
543
584
|
params: P;
|
|
544
585
|
}>): Promise<{
|
|
545
586
|
imported: number;
|
|
@@ -571,6 +612,6 @@ export declare class DatabasesAPI {
|
|
|
571
612
|
* @param options.syncIndexes - Whether to sync model indexes after import (defaults to true; only applies when `model` is a class)
|
|
572
613
|
* @param options.operationName - Name of the registered mutation operation to use (defaults to "save")
|
|
573
614
|
*/
|
|
574
|
-
importCsv<T extends object = Record<string,
|
|
615
|
+
importCsv<T extends object = Record<string, unknown>>(databaseId: string, options: CsvImportOptions<T>): Promise<CsvImportResult>;
|
|
575
616
|
}
|
|
576
617
|
//# sourceMappingURL=databasesApi.d.ts.map
|