@osdk/react 0.10.0-beta.1 → 0.10.0-beta.11
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/AGENTS.md +46 -221
- package/CHANGELOG.md +147 -0
- package/build/browser/new/makeExternalStore.js +61 -0
- package/build/browser/new/makeExternalStore.js.map +1 -1
- package/build/browser/new/platform-apis/admin/useCbacBanner.js +63 -0
- package/build/browser/new/platform-apis/admin/useCbacBanner.js.map +1 -0
- package/build/browser/new/platform-apis/admin/useCbacMarkingRestrictions.js +64 -0
- package/build/browser/new/platform-apis/admin/useCbacMarkingRestrictions.js.map +1 -0
- package/build/browser/new/platform-apis/admin/useMarkingCategories.js +46 -0
- package/build/browser/new/platform-apis/admin/useMarkingCategories.js.map +1 -0
- package/build/browser/new/platform-apis/admin/useMarkings.js +46 -0
- package/build/browser/new/platform-apis/admin/useMarkings.js.map +1 -0
- package/build/browser/new/platform-apis/admin/useUserMarkings.js +50 -0
- package/build/browser/new/platform-apis/admin/useUserMarkings.js.map +1 -0
- package/build/browser/new/useLinks.js +11 -4
- package/build/browser/new/useLinks.js.map +1 -1
- package/build/browser/new/useObjectSet.js +42 -18
- package/build/browser/new/useObjectSet.js.map +1 -1
- package/build/browser/new/useOsdkAction.js +2 -2
- package/build/browser/new/useOsdkAction.js.map +1 -1
- package/build/browser/new/useOsdkAggregation.js +65 -27
- package/build/browser/new/useOsdkAggregation.js.map +1 -1
- package/build/browser/new/useOsdkFunction.js +17 -12
- package/build/browser/new/useOsdkFunction.js.map +1 -1
- package/build/browser/new/useOsdkObject.js +48 -26
- package/build/browser/new/useOsdkObject.js.map +1 -1
- package/build/browser/new/useOsdkObjects.js +32 -19
- package/build/browser/new/useOsdkObjects.js.map +1 -1
- package/build/browser/public/experimental/admin.js +25 -0
- package/build/browser/public/experimental/admin.js.map +1 -0
- package/build/browser/public/experimental.js +0 -3
- package/build/browser/public/experimental.js.map +1 -1
- package/build/browser/useOsdkMetadata.js.map +1 -1
- package/build/cjs/{chunk-V32JHU3O.cjs → chunk-OVBG5VXE.cjs} +3 -8
- package/build/cjs/chunk-OVBG5VXE.cjs.map +1 -0
- package/build/cjs/chunk-SVVMLSKN.cjs +111 -0
- package/build/cjs/chunk-SVVMLSKN.cjs.map +1 -0
- package/build/cjs/index.cjs +4 -4
- package/build/cjs/index.d.cts +1 -1
- package/build/cjs/public/experimental/admin.cjs +293 -0
- package/build/cjs/public/experimental/admin.cjs.map +1 -0
- package/build/cjs/public/experimental/admin.d.cts +275 -0
- package/build/cjs/public/experimental.cjs +261 -492
- package/build/cjs/public/experimental.cjs.map +1 -1
- package/build/cjs/public/experimental.d.cts +113 -138
- package/build/cjs/useOsdkMetadata-BElt3F5s.d.cts +15 -0
- package/build/esm/new/makeExternalStore.js +61 -0
- package/build/esm/new/makeExternalStore.js.map +1 -1
- package/build/esm/new/platform-apis/admin/useCbacBanner.js +63 -0
- package/build/esm/new/platform-apis/admin/useCbacBanner.js.map +1 -0
- package/build/esm/new/platform-apis/admin/useCbacMarkingRestrictions.js +64 -0
- package/build/esm/new/platform-apis/admin/useCbacMarkingRestrictions.js.map +1 -0
- package/build/esm/new/platform-apis/admin/useMarkingCategories.js +46 -0
- package/build/esm/new/platform-apis/admin/useMarkingCategories.js.map +1 -0
- package/build/esm/new/platform-apis/admin/useMarkings.js +46 -0
- package/build/esm/new/platform-apis/admin/useMarkings.js.map +1 -0
- package/build/esm/new/platform-apis/admin/useUserMarkings.js +50 -0
- package/build/esm/new/platform-apis/admin/useUserMarkings.js.map +1 -0
- package/build/esm/new/useLinks.js +11 -4
- package/build/esm/new/useLinks.js.map +1 -1
- package/build/esm/new/useObjectSet.js +42 -18
- package/build/esm/new/useObjectSet.js.map +1 -1
- package/build/esm/new/useOsdkAction.js +2 -2
- package/build/esm/new/useOsdkAction.js.map +1 -1
- package/build/esm/new/useOsdkAggregation.js +65 -27
- package/build/esm/new/useOsdkAggregation.js.map +1 -1
- package/build/esm/new/useOsdkFunction.js +17 -12
- package/build/esm/new/useOsdkFunction.js.map +1 -1
- package/build/esm/new/useOsdkObject.js +48 -26
- package/build/esm/new/useOsdkObject.js.map +1 -1
- package/build/esm/new/useOsdkObjects.js +32 -19
- package/build/esm/new/useOsdkObjects.js.map +1 -1
- package/build/esm/public/experimental/admin.js +25 -0
- package/build/esm/public/experimental/admin.js.map +1 -0
- package/build/esm/public/experimental.js +0 -3
- package/build/esm/public/experimental.js.map +1 -1
- package/build/esm/useOsdkMetadata.js.map +1 -1
- package/build/types/new/makeExternalStore.d.ts +11 -0
- package/build/types/new/makeExternalStore.d.ts.map +1 -1
- package/build/types/new/platform-apis/admin/useCbacBanner.d.ts +33 -0
- package/build/types/new/platform-apis/admin/useCbacBanner.d.ts.map +1 -0
- package/build/types/new/platform-apis/admin/useCbacMarkingRestrictions.d.ts +34 -0
- package/build/types/new/platform-apis/admin/useCbacMarkingRestrictions.d.ts.map +1 -0
- package/build/types/new/platform-apis/admin/useMarkingCategories.d.ts +27 -0
- package/build/types/new/platform-apis/admin/useMarkingCategories.d.ts.map +1 -0
- package/build/types/new/platform-apis/admin/useMarkings.d.ts +27 -0
- package/build/types/new/platform-apis/admin/useMarkings.d.ts.map +1 -0
- package/build/types/new/platform-apis/admin/useUserMarkings.d.ts +33 -0
- package/build/types/new/platform-apis/admin/useUserMarkings.d.ts.map +1 -0
- package/build/types/new/useLinks.d.ts +19 -0
- package/build/types/new/useLinks.d.ts.map +1 -1
- package/build/types/new/useObjectSet.d.ts +10 -4
- package/build/types/new/useObjectSet.d.ts.map +1 -1
- package/build/types/new/useOsdkAggregation.d.ts +41 -3
- package/build/types/new/useOsdkAggregation.d.ts.map +1 -1
- package/build/types/new/useOsdkFunction.d.ts +11 -5
- package/build/types/new/useOsdkFunction.d.ts.map +1 -1
- package/build/types/new/useOsdkObject.d.ts +19 -7
- package/build/types/new/useOsdkObject.d.ts.map +1 -1
- package/build/types/new/useOsdkObjects.d.ts +32 -2
- package/build/types/new/useOsdkObjects.d.ts.map +1 -1
- package/build/types/public/experimental/admin.d.ts +11 -0
- package/build/types/public/experimental/admin.d.ts.map +1 -0
- package/build/types/public/experimental.d.ts +0 -3
- package/build/types/public/experimental.d.ts.map +1 -1
- package/build/types/useOsdkMetadata.d.ts +5 -4
- package/build/types/useOsdkMetadata.d.ts.map +1 -1
- package/docs/querying-data.md +19 -0
- package/{build/browser/intellisense.test.helpers/useOsdkObjectsWithPivot.js → experimental/admin.d.ts} +1 -19
- package/package.json +28 -7
- package/build/browser/intellisense.test.helpers/useOsdkObjectsWithPivot.js.map +0 -1
- package/build/browser/intellisense.test.helpers/useOsdkObjectsWithProperties.js +0 -34
- package/build/browser/intellisense.test.helpers/useOsdkObjectsWithProperties.js.map +0 -1
- package/build/browser/intellisense.test.js +0 -148
- package/build/browser/intellisense.test.js.map +0 -1
- package/build/cjs/chunk-V32JHU3O.cjs.map +0 -1
- package/build/cjs/useOsdkMetadata-DFZhnhGZ.d.cts +0 -14
- package/build/esm/intellisense.test.helpers/useOsdkObjectsWithPivot.js +0 -35
- package/build/esm/intellisense.test.helpers/useOsdkObjectsWithPivot.js.map +0 -1
- package/build/esm/intellisense.test.helpers/useOsdkObjectsWithProperties.js +0 -34
- package/build/esm/intellisense.test.helpers/useOsdkObjectsWithProperties.js.map +0 -1
- package/build/esm/intellisense.test.js +0 -148
- package/build/esm/intellisense.test.js.map +0 -1
- package/build/types/intellisense.test.d.ts +0 -1
- package/build/types/intellisense.test.d.ts.map +0 -1
- package/build/types/intellisense.test.helpers/useOsdkObjectsWithPivot.d.ts +0 -1
- package/build/types/intellisense.test.helpers/useOsdkObjectsWithPivot.d.ts.map +0 -1
- package/build/types/intellisense.test.helpers/useOsdkObjectsWithProperties.d.ts +0 -1
- package/build/types/intellisense.test.helpers/useOsdkObjectsWithProperties.d.ts.map +0 -1
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2025 Palantir Technologies, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
export { useCbacBanner } from "../../new/platform-apis/admin/useCbacBanner.js";
|
|
18
|
+
export { useCbacMarkingRestrictions } from "../../new/platform-apis/admin/useCbacMarkingRestrictions.js";
|
|
19
|
+
export { useCurrentFoundryUser } from "../../new/platform-apis/admin/useCurrentFoundryUser.js";
|
|
20
|
+
export { useFoundryUser } from "../../new/platform-apis/admin/useFoundryUser.js";
|
|
21
|
+
export { useFoundryUsersList } from "../../new/platform-apis/admin/useFoundryUsersList.js";
|
|
22
|
+
export { useMarkingCategories } from "../../new/platform-apis/admin/useMarkingCategories.js";
|
|
23
|
+
export { useMarkings } from "../../new/platform-apis/admin/useMarkings.js";
|
|
24
|
+
export { useUserViewMarkings } from "../../new/platform-apis/admin/useUserMarkings.js";
|
|
25
|
+
//# sourceMappingURL=admin.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"admin.js","names":["useCbacBanner","useCbacMarkingRestrictions","useCurrentFoundryUser","useFoundryUser","useFoundryUsersList","useMarkingCategories","useMarkings","useUserViewMarkings"],"sources":["admin.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport { useCbacBanner } from \"../../new/platform-apis/admin/useCbacBanner.js\";\nexport type {\n CbacBannerData,\n UseCbacBannerOptions,\n UseCbacBannerResult,\n} from \"../../new/platform-apis/admin/useCbacBanner.js\";\nexport { useCbacMarkingRestrictions } from \"../../new/platform-apis/admin/useCbacMarkingRestrictions.js\";\nexport type {\n CbacMarkingRestrictionsData,\n UseCbacMarkingRestrictionsOptions,\n UseCbacMarkingRestrictionsResult,\n} from \"../../new/platform-apis/admin/useCbacMarkingRestrictions.js\";\nexport { useCurrentFoundryUser } from \"../../new/platform-apis/admin/useCurrentFoundryUser.js\";\nexport { useFoundryUser } from \"../../new/platform-apis/admin/useFoundryUser.js\";\nexport { useFoundryUsersList } from \"../../new/platform-apis/admin/useFoundryUsersList.js\";\nexport { useMarkingCategories } from \"../../new/platform-apis/admin/useMarkingCategories.js\";\nexport { useMarkings } from \"../../new/platform-apis/admin/useMarkings.js\";\nexport { useUserViewMarkings } from \"../../new/platform-apis/admin/useUserMarkings.js\";\nexport type {\n UseUserViewMarkingsOptions,\n UseUserViewMarkingsResult,\n} from \"../../new/platform-apis/admin/useUserMarkings.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,aAAa,QAAQ,gDAAgD;AAM9E,SAASC,0BAA0B,QAAQ,6DAA6D;AAMxG,SAASC,qBAAqB,QAAQ,wDAAwD;AAC9F,SAASC,cAAc,QAAQ,iDAAiD;AAChF,SAASC,mBAAmB,QAAQ,sDAAsD;AAC1F,SAASC,oBAAoB,QAAQ,uDAAuD;AAC5F,SAASC,WAAW,QAAQ,8CAA8C;AAC1E,SAASC,mBAAmB,QAAQ,kDAAkD","ignoreList":[]}
|
|
@@ -15,9 +15,6 @@
|
|
|
15
15
|
*/
|
|
16
16
|
|
|
17
17
|
export { OsdkProvider2 } from "../new/OsdkProvider2.js";
|
|
18
|
-
export { useCurrentFoundryUser } from "../new/platform-apis/admin/useCurrentFoundryUser.js";
|
|
19
|
-
export { useFoundryUser } from "../new/platform-apis/admin/useFoundryUser.js";
|
|
20
|
-
export { useFoundryUsersList } from "../new/platform-apis/admin/useFoundryUsersList.js";
|
|
21
18
|
export { useLinks } from "../new/useLinks.js";
|
|
22
19
|
export { useObjectSet } from "../new/useObjectSet.js";
|
|
23
20
|
export { useOsdkAction } from "../new/useOsdkAction.js";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"experimental.js","names":["OsdkProvider2","
|
|
1
|
+
{"version":3,"file":"experimental.js","names":["OsdkProvider2","useLinks","useObjectSet","useOsdkAction","useOsdkAggregation","useOsdkFunction","useOsdkObject","useOsdkObjects","useOsdkClient","useOsdkMetadata","useDebouncedCallback"],"sources":["experimental.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport { OsdkProvider2 } from \"../new/OsdkProvider2.js\";\nexport { useLinks } from \"../new/useLinks.js\";\nexport { useObjectSet } from \"../new/useObjectSet.js\";\nexport { useOsdkAction } from \"../new/useOsdkAction.js\";\nexport type { UseOsdkAggregationResult } from \"../new/useOsdkAggregation.js\";\nexport { useOsdkAggregation } from \"../new/useOsdkAggregation.js\";\nexport type {\n UseOsdkFunctionOptions,\n UseOsdkFunctionResult,\n} from \"../new/useOsdkFunction.js\";\nexport { useOsdkFunction } from \"../new/useOsdkFunction.js\";\nexport { useOsdkObject } from \"../new/useOsdkObject.js\";\nexport type {\n UseOsdkListResult,\n UseOsdkObjectsOptions,\n} from \"../new/useOsdkObjects.js\";\nexport { useOsdkObjects } from \"../new/useOsdkObjects.js\";\nexport { useOsdkClient } from \"../useOsdkClient.js\";\nexport { useOsdkMetadata } from \"../useOsdkMetadata.js\";\nexport type { UseOsdkMetadataResult } from \"../useOsdkMetadata.js\";\nexport { useDebouncedCallback } from \"../utils/useDebouncedCallback.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,aAAa,QAAQ,yBAAyB;AACvD,SAASC,QAAQ,QAAQ,oBAAoB;AAC7C,SAASC,YAAY,QAAQ,wBAAwB;AACrD,SAASC,aAAa,QAAQ,yBAAyB;AAEvD,SAASC,kBAAkB,QAAQ,8BAA8B;AAKjE,SAASC,eAAe,QAAQ,2BAA2B;AAC3D,SAASC,aAAa,QAAQ,yBAAyB;AAKvD,SAASC,cAAc,QAAQ,0BAA0B;AACzD,SAASC,aAAa,QAAQ,qBAAqB;AACnD,SAASC,eAAe,QAAQ,uBAAuB;AAEvD,SAASC,oBAAoB,QAAQ,kCAAkC","ignoreList":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useOsdkMetadata.js","names":["React","useOsdkClient","useOsdkMetadata","type","client","metadata","setMetadata","useState","undefined","error","setError","fetchMetadata","then","fetchedMetadata","catch","errorMessage","Error","message","String","loading"],"sources":["useOsdkMetadata.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n InterfaceDefinition,\n InterfaceMetadata,\n ObjectMetadata,\n ObjectOrInterfaceDefinition,\n ObjectTypeDefinition,\n} from \"@osdk/api\";\nimport React from \"react\";\nimport { useOsdkClient } from \"./useOsdkClient.js\";\n\ntype MetadataFor<T extends
|
|
1
|
+
{"version":3,"file":"useOsdkMetadata.js","names":["React","useOsdkClient","useOsdkMetadata","type","client","metadata","setMetadata","useState","undefined","error","setError","fetchMetadata","then","fetchedMetadata","catch","errorMessage","Error","message","String","loading"],"sources":["useOsdkMetadata.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n ActionDefinition,\n ActionMetadata,\n InterfaceDefinition,\n InterfaceMetadata,\n ObjectMetadata,\n ObjectOrInterfaceDefinition,\n ObjectTypeDefinition,\n} from \"@osdk/api\";\nimport React from \"react\";\nimport { useOsdkClient } from \"./useOsdkClient.js\";\n\ntype MetadataFetchableDefinition =\n | ObjectOrInterfaceDefinition\n | ActionDefinition<any>;\n\ntype MetadataFor<T extends MetadataFetchableDefinition> = T extends\n ObjectTypeDefinition ? ObjectMetadata\n : T extends InterfaceDefinition ? InterfaceMetadata\n : T extends ActionDefinition<any> ? ActionMetadata\n : never;\n\nexport interface UseOsdkMetadataResult<T extends MetadataFetchableDefinition> {\n loading: boolean;\n metadata?: MetadataFor<T>;\n error?: string;\n}\n\nexport function useOsdkMetadata<T extends MetadataFetchableDefinition>(\n type: T,\n): UseOsdkMetadataResult<T> {\n const client = useOsdkClient();\n const [metadata, setMetadata] = React.useState<\n MetadataFor<T> | undefined\n >(undefined);\n const [error, setError] = React.useState<UseOsdkMetadataResult<T>[\"error\"]>();\n\n if (!metadata && !error) {\n client.fetchMetadata(type).then((fetchedMetadata) => {\n setMetadata(fetchedMetadata as MetadataFor<T>);\n }).catch((error: unknown) => {\n const errorMessage = error instanceof Error\n ? error.message\n : String(error);\n setError(errorMessage);\n });\n return { loading: true };\n }\n\n return { loading: false, metadata, error };\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAWA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,aAAa,QAAQ,oBAAoB;AAkBlD,OAAO,SAASC,eAAeA,CAC7BC,IAAO,EACmB;EAC1B,MAAMC,MAAM,GAAGH,aAAa,CAAC,CAAC;EAC9B,MAAM,CAACI,QAAQ,EAAEC,WAAW,CAAC,GAAGN,KAAK,CAACO,QAAQ,CAE5CC,SAAS,CAAC;EACZ,MAAM,CAACC,KAAK,EAAEC,QAAQ,CAAC,GAAGV,KAAK,CAACO,QAAQ,CAAoC,CAAC;EAE7E,IAAI,CAACF,QAAQ,IAAI,CAACI,KAAK,EAAE;IACvBL,MAAM,CAACO,aAAa,CAACR,IAAI,CAAC,CAACS,IAAI,CAAEC,eAAe,IAAK;MACnDP,WAAW,CAACO,eAAiC,CAAC;IAChD,CAAC,CAAC,CAACC,KAAK,CAAEL,KAAc,IAAK;MAC3B,MAAMM,YAAY,GAAGN,KAAK,YAAYO,KAAK,GACvCP,KAAK,CAACQ,OAAO,GACbC,MAAM,CAACT,KAAK,CAAC;MACjBC,QAAQ,CAACK,YAAY,CAAC;IACxB,CAAC,CAAC;IACF,OAAO;MAAEI,OAAO,EAAE;IAAK,CAAC;EAC1B;EAEA,OAAO;IAAEA,OAAO,EAAE,KAAK;IAAEd,QAAQ;IAAEI;EAAM,CAAC;AAC5C","ignoreList":[]}
|
|
@@ -8,3 +8,14 @@ export declare function makeExternalStore<X>(createObservation: (callback: Obser
|
|
|
8
8
|
subscribe: (notifyUpdate: () => void) => () => void
|
|
9
9
|
getSnapShot: () => Snapshot<X>
|
|
10
10
|
};
|
|
11
|
+
/**
|
|
12
|
+
* Like makeExternalStore but for async subscription creation.
|
|
13
|
+
*
|
|
14
|
+
* Uses an isActive flag to handle race conditions:
|
|
15
|
+
* If cleanup runs before promise resolves, the stale subscription is
|
|
16
|
+
* immediately unsubscribed when it eventually resolves
|
|
17
|
+
*/
|
|
18
|
+
export declare function makeExternalStoreAsync<X>(createObservation: (callback: Observer<X | undefined>) => Promise<Unsubscribable>, _name?: string, initialValue?: Snapshot<X>): {
|
|
19
|
+
subscribe: (notifyUpdate: () => void) => () => void
|
|
20
|
+
getSnapShot: () => Snapshot<X>
|
|
21
|
+
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cACE,UACA,sBACK,kCAAmC;AAE1C,YAAY,SAAS,KACjB,IAAI;CAAE,QAAQ;AAAO,KACpB,QAAQ,KAAK;CAAE,QAAQ;AAAO;AAGnC,OAAO,iBAAS,kBAAkB,GAChCA,oBAAoBC,UAAU,SAAS,mBAAmB,gBAC1DC,gBACAC,eAAe,SAAS,KACvB;CACD,YAAYC;CACZ,mBAAmB,SAAS;AAC7B","names":["createObservation: (callback: Observer<X | undefined>) => Unsubscribable","callback: Observer<X | undefined>","_name?: string","initialValue?: Snapshot<X>","notifyUpdate: () => void"],"sources":["../../../src/new/makeExternalStore.ts"],"version":3,"file":"makeExternalStore.d.ts"}
|
|
1
|
+
{"mappings":"AAgBA,cACE,UACA,sBACK,kCAAmC;AAE1C,YAAY,SAAS,KACjB,IAAI;CAAE,QAAQ;AAAO,KACpB,QAAQ,KAAK;CAAE,QAAQ;AAAO;AAGnC,OAAO,iBAAS,kBAAkB,GAChCA,oBAAoBC,UAAU,SAAS,mBAAmB,gBAC1DC,gBACAC,eAAe,SAAS,KACvB;CACD,YAAYC;CACZ,mBAAmB,SAAS;AAC7B;;;;;;;;AAyCD,OAAO,iBAAS,uBAAuB,GACrCC,oBACEJ,UAAU,SAAS,mBAChB,QAAQ,iBACbC,gBACAC,eAAe,SAAS,KACvB;CACD,YAAYC;CACZ,mBAAmB,SAAS;AAC7B","names":["createObservation: (callback: Observer<X | undefined>) => Unsubscribable","callback: Observer<X | undefined>","_name?: string","initialValue?: Snapshot<X>","notifyUpdate: () => void","createObservation: (\n callback: Observer<X | undefined>,\n ) => Promise<Unsubscribable>"],"sources":["../../../src/new/makeExternalStore.ts"],"version":3,"file":"makeExternalStore.d.ts"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
export interface CbacBannerData {
|
|
2
|
+
classificationString: string;
|
|
3
|
+
textColor: string;
|
|
4
|
+
backgroundColors: string[];
|
|
5
|
+
markingIds: string[];
|
|
6
|
+
}
|
|
7
|
+
export interface UseCbacBannerOptions {
|
|
8
|
+
markingIds: string[];
|
|
9
|
+
/**
|
|
10
|
+
* Enable or disable the query.
|
|
11
|
+
*
|
|
12
|
+
* When `false`, the query will not automatically execute.
|
|
13
|
+
*
|
|
14
|
+
* This is useful for:
|
|
15
|
+
* - Lazy/on-demand queries that should wait for user interaction
|
|
16
|
+
* - Dependent queries that need data from another query first
|
|
17
|
+
* - Conditional queries based on component state
|
|
18
|
+
*
|
|
19
|
+
* @default true
|
|
20
|
+
*/
|
|
21
|
+
enabled?: boolean;
|
|
22
|
+
}
|
|
23
|
+
export interface UseCbacBannerResult {
|
|
24
|
+
banner: CbacBannerData | undefined;
|
|
25
|
+
isLoading: boolean;
|
|
26
|
+
error: Error | undefined;
|
|
27
|
+
refetch: () => void;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Get the CBAC banner data for the given marking IDs.
|
|
31
|
+
* @param options Options to control the query.
|
|
32
|
+
*/
|
|
33
|
+
export declare function useCbacBanner({ markingIds, enabled: externalEnabled }: UseCbacBannerOptions): UseCbacBannerResult;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAqBA,iBAAiB,eAAe;CAC9B;CACA;CACA;CACA;AACD;AAED,iBAAiB,qBAAqB;CACpC;;;;;;;;;;;;;CAaA;AACD;AAED,iBAAiB,oBAAoB;CACnC,QAAQ;CACR;CAEA,OAAO;CAEP;AACD;;;;;AAMD,OAAO,iBAAS,cACd,EAAE,YAAY,SAAS,iBAA8C,EAApB,uBAChD","names":[],"sources":["../../../../../src/new/platform-apis/admin/useCbacBanner.ts"],"version":3,"file":"useCbacBanner.d.ts"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
export interface CbacMarkingRestrictionsData {
|
|
2
|
+
disallowedMarkings: string[];
|
|
3
|
+
impliedMarkings: string[];
|
|
4
|
+
requiredMarkings: string[][];
|
|
5
|
+
userSatisfiesMarkings: boolean;
|
|
6
|
+
isValid: boolean;
|
|
7
|
+
}
|
|
8
|
+
export interface UseCbacMarkingRestrictionsOptions {
|
|
9
|
+
markingIds: string[];
|
|
10
|
+
/**
|
|
11
|
+
* Enable or disable the query.
|
|
12
|
+
*
|
|
13
|
+
* When `false`, the query will not automatically execute.
|
|
14
|
+
*
|
|
15
|
+
* This is useful for:
|
|
16
|
+
* - Lazy/on-demand queries that should wait for user interaction
|
|
17
|
+
* - Dependent queries that need data from another query first
|
|
18
|
+
* - Conditional queries based on component state
|
|
19
|
+
*
|
|
20
|
+
* @default true
|
|
21
|
+
*/
|
|
22
|
+
enabled?: boolean;
|
|
23
|
+
}
|
|
24
|
+
export interface UseCbacMarkingRestrictionsResult {
|
|
25
|
+
restrictions: CbacMarkingRestrictionsData | undefined;
|
|
26
|
+
isLoading: boolean;
|
|
27
|
+
error: Error | undefined;
|
|
28
|
+
refetch: () => void;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Get CBAC marking restrictions (implied, disallowed, required) for the given marking IDs.
|
|
32
|
+
* @param options Options to control the query.
|
|
33
|
+
*/
|
|
34
|
+
export declare function useCbacMarkingRestrictions({ markingIds, enabled: externalEnabled }: UseCbacMarkingRestrictionsOptions): UseCbacMarkingRestrictionsResult;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAqBA,iBAAiB,4BAA4B;CAC3C;CACA;CACA;CACA;CACA;AACD;AAED,iBAAiB,kCAAkC;CACjD;;;;;;;;;;;;;CAaA;AACD;AAED,iBAAiB,iCAAiC;CAChD,cAAc;CACd;CAEA,OAAO;CAEP;AACD;;;;;AAMD,OAAO,iBAAS,2BACd,EAAE,YAAY,SAAS,iBACY,EAAjC,oCACD","names":[],"sources":["../../../../../src/new/platform-apis/admin/useCbacMarkingRestrictions.ts"],"version":3,"file":"useCbacMarkingRestrictions.d.ts"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { MarkingCategory } from "@osdk/foundry.admin";
|
|
2
|
+
export interface UseMarkingCategoriesOptions {
|
|
3
|
+
/**
|
|
4
|
+
* Enable or disable the query.
|
|
5
|
+
*
|
|
6
|
+
* When `false`, the query will not automatically execute.
|
|
7
|
+
*
|
|
8
|
+
* This is useful for:
|
|
9
|
+
* - Lazy/on-demand queries that should wait for user interaction
|
|
10
|
+
* - Dependent queries that need data from another query first
|
|
11
|
+
* - Conditional queries based on component state
|
|
12
|
+
*
|
|
13
|
+
* @default true
|
|
14
|
+
*/
|
|
15
|
+
enabled?: boolean;
|
|
16
|
+
}
|
|
17
|
+
export interface UseMarkingCategoriesResult {
|
|
18
|
+
categories: MarkingCategory[] | undefined;
|
|
19
|
+
isLoading: boolean;
|
|
20
|
+
error: Error | undefined;
|
|
21
|
+
refetch: () => void;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* List all marking categories.
|
|
25
|
+
* @param options Options to control the query.
|
|
26
|
+
*/
|
|
27
|
+
export declare function useMarkingCategories({ enabled }?: UseMarkingCategoriesOptions): UseMarkingCategoriesResult;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,uBAAuB,qBAAsB;AAM3D,iBAAiB,4BAA4B;;;;;;;;;;;;;CAa3C;AACD;AAED,iBAAiB,2BAA2B;CAC1C,YAAY;CACZ;CAEA,OAAO;CAEP;AACD;;;;;AAMD,OAAO,iBAAS,qBACd,EAAE,SAA6C,GAA3B,8BACnB","names":[],"sources":["../../../../../src/new/platform-apis/admin/useMarkingCategories.ts"],"version":3,"file":"useMarkingCategories.d.ts"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { Marking } from "@osdk/foundry.admin";
|
|
2
|
+
export interface UseMarkingsOptions {
|
|
3
|
+
/**
|
|
4
|
+
* Enable or disable the query.
|
|
5
|
+
*
|
|
6
|
+
* When `false`, the query will not automatically execute.
|
|
7
|
+
*
|
|
8
|
+
* This is useful for:
|
|
9
|
+
* - Lazy/on-demand queries that should wait for user interaction
|
|
10
|
+
* - Dependent queries that need data from another query first
|
|
11
|
+
* - Conditional queries based on component state
|
|
12
|
+
*
|
|
13
|
+
* @default true
|
|
14
|
+
*/
|
|
15
|
+
enabled?: boolean;
|
|
16
|
+
}
|
|
17
|
+
export interface UseMarkingsResult {
|
|
18
|
+
markings: Marking[] | undefined;
|
|
19
|
+
isLoading: boolean;
|
|
20
|
+
error: Error | undefined;
|
|
21
|
+
refetch: () => void;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* List all markings.
|
|
25
|
+
* @param options Options to control the query.
|
|
26
|
+
*/
|
|
27
|
+
export declare function useMarkings({ enabled }?: UseMarkingsOptions): UseMarkingsResult;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAgBA,cAAc,eAAe,qBAAsB;AAMnD,iBAAiB,mBAAmB;;;;;;;;;;;;;CAalC;AACD;AAED,iBAAiB,kBAAkB;CACjC,UAAU;CACV;CAEA,OAAO;CAEP;AACD;;;;;AAMD,OAAO,iBAAS,YACd,EAAE,SAAoC,GAAlB,qBACnB","names":[],"sources":["../../../../../src/new/platform-apis/admin/useMarkings.ts"],"version":3,"file":"useMarkings.d.ts"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
export interface UseUserViewMarkingsOptions {
|
|
2
|
+
/**
|
|
3
|
+
* The user ID to fetch view markings for.
|
|
4
|
+
* When omitted, fetches markings for the current user.
|
|
5
|
+
*/
|
|
6
|
+
userId?: string;
|
|
7
|
+
/**
|
|
8
|
+
* Enable or disable the query.
|
|
9
|
+
*
|
|
10
|
+
* When `false`, the query will not automatically execute.
|
|
11
|
+
*
|
|
12
|
+
* This is useful for:
|
|
13
|
+
* - Lazy/on-demand queries that should wait for user interaction
|
|
14
|
+
* - Dependent queries that need data from another query first
|
|
15
|
+
* - Conditional queries based on component state
|
|
16
|
+
*
|
|
17
|
+
* @default true
|
|
18
|
+
*/
|
|
19
|
+
enabled?: boolean;
|
|
20
|
+
}
|
|
21
|
+
export interface UseUserViewMarkingsResult {
|
|
22
|
+
markingIds: string[] | undefined;
|
|
23
|
+
isLoading: boolean;
|
|
24
|
+
error: Error | undefined;
|
|
25
|
+
refetch: () => void;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Get view-accessible markings for a user.
|
|
29
|
+
* When `userId` is provided, fetches markings for that user.
|
|
30
|
+
* When omitted, fetches markings for the current user.
|
|
31
|
+
* @param options Options to control the query.
|
|
32
|
+
*/
|
|
33
|
+
export declare function useUserViewMarkings({ userId, enabled }?: UseUserViewMarkingsOptions): UseUserViewMarkingsResult;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"mappings":"AAqBA,iBAAiB,2BAA2B;;;;;CAK1C;;;;;;;;;;;;;CAaA;AACD;AAED,iBAAiB,0BAA0B;CACzC;CACA;CAEA,OAAO;CAEP;AACD;;;;;;;AAQD,OAAO,iBAAS,oBACd,EAAE,QAAQ,SAA4C,GAA1B,6BAC3B","names":[],"sources":["../../../../../src/new/platform-apis/admin/useUserMarkings.ts"],"version":3,"file":"useUserMarkings.d.ts"}
|
|
@@ -12,6 +12,12 @@ export interface UseLinksOptions<T extends ObjectOrInterfaceDefinition> {
|
|
|
12
12
|
/** Sorting options for the linked objects */
|
|
13
13
|
orderBy?: { [K in PropertyKeys<T>]? : "asc" | "desc" };
|
|
14
14
|
/**
|
|
15
|
+
* Restrict which properties are returned for each linked object.
|
|
16
|
+
* When provided, only the specified properties will be fetched,
|
|
17
|
+
* reducing payload sizes for list views.
|
|
18
|
+
*/
|
|
19
|
+
$select?: readonly PropertyKeys<T>[];
|
|
20
|
+
/**
|
|
15
21
|
* The mode to use for fetching data.
|
|
16
22
|
* - undefined: Fetch data if not already in cache
|
|
17
23
|
* - "force": Always fetch fresh data
|
|
@@ -19,6 +25,13 @@ export interface UseLinksOptions<T extends ObjectOrInterfaceDefinition> {
|
|
|
19
25
|
*/
|
|
20
26
|
mode?: "force" | "offline";
|
|
21
27
|
/**
|
|
28
|
+
* The number of milliseconds to wait after the last observed link change.
|
|
29
|
+
*
|
|
30
|
+
* Two uses of `useLinks` with the same parameters will only trigger one
|
|
31
|
+
* network request if the second is within `dedupeIntervalMs`.
|
|
32
|
+
*/
|
|
33
|
+
dedupeIntervalMs?: number;
|
|
34
|
+
/**
|
|
22
35
|
* Enable or disable the query.
|
|
23
36
|
*
|
|
24
37
|
* When `false`, the query will not automatically execute. It will still
|
|
@@ -41,6 +54,12 @@ export interface UseLinksOptions<T extends ObjectOrInterfaceDefinition> {
|
|
|
41
54
|
}
|
|
42
55
|
export interface UseLinksResult<Q extends ObjectOrInterfaceDefinition> {
|
|
43
56
|
links: Osdk.Instance<Q>[] | undefined;
|
|
57
|
+
/**
|
|
58
|
+
* Maps each source object's primary key to its linked object instances.
|
|
59
|
+
* Useful when observing links from multiple source objects to determine
|
|
60
|
+
* which source links to which targets.
|
|
61
|
+
*/
|
|
62
|
+
linkedObjectsBySourcePrimaryKey: ReadonlyMap<string | number, ReadonlyArray<Osdk.Instance<Q>>>;
|
|
44
63
|
isLoading: boolean;
|
|
45
64
|
error: Error | undefined;
|
|
46
65
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cACE,YACA,WACA,mCACK,WAAY;AACnB,cAAc,MAAM,cAAc,mBAAmB,cAAe;AAMpE,iBAAiB,gBACf,UAAU,6BACV;;;;CAIA,QAAQ,YAAY;;;;CAKpB;;CAGA,aACG,KAAK,aAAa,OAAM,QAAQ;;;;;;;
|
|
1
|
+
{"mappings":"AAgBA,cACE,YACA,WACA,mCACK,WAAY;AACnB,cAAc,MAAM,cAAc,mBAAmB,cAAe;AAMpE,iBAAiB,gBACf,UAAU,6BACV;;;;CAIA,QAAQ,YAAY;;;;CAKpB;;CAGA,aACG,KAAK,aAAa,OAAM,QAAQ;;;;;;CAQnC,mBAAmB,aAAa;;;;;;;CAQhC,OAAO,UAAU;;;;;;;CAQjB;;;;;;;;;;;;;;;;;;;;CAqBA;AACD;AAED,iBAAiB,eACf,UAAU,6BACV;CACA,OAAO,KAAK,SAAS;;;;;;CAOrB,iCAAiC,6BAE/B,cAAc,KAAK,SAAS;CAG9B;CACA,OAAO;;;;CAKP;;;;CAKA,kBAAkB;;;;CAKlB;AACD;;;;;;;;;AAaD,OAAO,iBAAS;CACd,UAAU;CACV,UAAU,UAAU;EAEpBA,SAAS,KAAK,SAAS,KAAK,MAAM,KAAK,SAAS,iBAChDC,UAAU,GACVC,UAAS,gBAAgB,WAAW,GAAG,MACtC,eAAe,WAAW,GAAG","names":["objects: Osdk.Instance<T> | Array<Osdk.Instance<T>> | undefined","linkName: L","options: UseLinksOptions<LinkedType<T, L>>"],"sources":["../../../src/new/useLinks.ts"],"version":3,"file":"useLinks.d.ts"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { DerivedProperty, LinkNames,
|
|
1
|
+
import type { DerivedProperty, LinkNames, ObjectOrInterfaceDefinition, ObjectSet, Osdk, PropertyKeys, SimplePropertyDef, WhereClause } from "@osdk/api";
|
|
2
2
|
export interface UseObjectSetOptions<
|
|
3
|
-
Q extends
|
|
3
|
+
Q extends ObjectOrInterfaceDefinition,
|
|
4
4
|
RDPs extends Record<string, SimplePropertyDef> = {}
|
|
5
5
|
> {
|
|
6
6
|
/**
|
|
@@ -56,6 +56,12 @@ export interface UseObjectSetOptions<
|
|
|
56
56
|
*/
|
|
57
57
|
streamUpdates?: boolean;
|
|
58
58
|
/**
|
|
59
|
+
* Restrict which properties are returned for each object.
|
|
60
|
+
* When provided, only the specified properties will be fetched,
|
|
61
|
+
* reducing payload sizes for list views.
|
|
62
|
+
*/
|
|
63
|
+
$select?: readonly PropertyKeys<Q>[];
|
|
64
|
+
/**
|
|
59
65
|
* Enable or disable the query.
|
|
60
66
|
*
|
|
61
67
|
* When `false`, the query will not automatically execute. It will still
|
|
@@ -77,7 +83,7 @@ export interface UseObjectSetOptions<
|
|
|
77
83
|
enabled?: boolean;
|
|
78
84
|
}
|
|
79
85
|
export interface UseObjectSetResult<
|
|
80
|
-
Q extends
|
|
86
|
+
Q extends ObjectOrInterfaceDefinition,
|
|
81
87
|
RDPs extends Record<string, SimplePropertyDef> = {}
|
|
82
88
|
> {
|
|
83
89
|
/**
|
|
@@ -117,7 +123,7 @@ export interface UseObjectSetResult<
|
|
|
117
123
|
* @returns Object set data with both existing and new derived properties
|
|
118
124
|
*/
|
|
119
125
|
export declare function useObjectSet<
|
|
120
|
-
Q extends
|
|
126
|
+
Q extends ObjectOrInterfaceDefinition,
|
|
121
127
|
BaseRDPs extends Record<string, SimplePropertyDef> = never,
|
|
122
128
|
RDPs extends Record<string, SimplePropertyDef> = {}
|
|
123
129
|
>(baseObjectSet: ObjectSet<Q, BaseRDPs>, options?: UseObjectSetOptions<Q, RDPs>): UseObjectSetResult<Q, RDPs>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cACE,iBACA,WACA,WACA,
|
|
1
|
+
{"mappings":"AAgBA,cACE,iBACA,WACA,6BACA,WACA,MACA,cACA,mBACA,mBACK,WAAY;AAUnB,iBAAiB;CACf,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;CAIA,QAAQ,YAAY,GAAG;;;;CAKvB,oBAAoB,WAAW,QAAO,gBAAgB,QAAQ,GAAG,KAAK;;;;CAKtE,QAAQ,UAAU;;;;CAKlB,YAAY,UAAU;;;;CAKtB,WAAW,UAAU;;;;CAKrB,UAAU,UAAU;;;;CAKpB;;;;CAKA,aACG,KAAK,aAAa,OAAM,QAAQ;;;;CAMnC;;;;;;;;CASA;;;;;;;;CASA;;;;;;CAOA,mBAAmB,aAAa;;;;;;;;;;;;;;;;;;;;CAqBhC;AACD;AAED,iBAAiB;CACf,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;CAIA,MACI,KAAK,SAAS,GAAG,sBAAsB,aAAa,IAAI;;;;CAM5D;;;;CAKA,OAAO;;;;CAKP,kBAAkB;;;;CAKlB,WAAW,UAAU,GAAG;;;;CAKxB;AACD;;;;;;;;;;;;AAoBD,OAAO,iBAAS;CACd,UAAU;CACV,iBAAiB,eAAe;CAChC,aAAa,eAAe,qBAAqB,CAAE;EAEnDA,eAAe,UAAU,GAAG,WAC5BC,UAAS,oBAAoB,GAAG,QAC/B,mBAAmB,GAAG","names":["baseObjectSet: ObjectSet<Q, BaseRDPs>","options: UseObjectSetOptions<Q, RDPs>"],"sources":["../../../src/new/useObjectSet.tsx"],"version":3,"file":"useObjectSet.d.ts"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import type { AggregateOpts, AggregationsResults, DerivedProperty, ObjectOrInterfaceDefinition, SimplePropertyDef, WhereClause } from "@osdk/api";
|
|
2
|
-
|
|
1
|
+
import type { AggregateOpts, AggregationsResults, DerivedProperty, ObjectOrInterfaceDefinition, ObjectSet, SimplePropertyDef, WhereClause } from "@osdk/api";
|
|
2
|
+
import type { ObjectTypeDefinition } from "@osdk/client";
|
|
3
|
+
interface UseOsdkAggregationBaseOptions<
|
|
3
4
|
T extends ObjectOrInterfaceDefinition,
|
|
4
5
|
A extends AggregateOpts<T>,
|
|
5
6
|
RDPs extends Record<string, SimplePropertyDef> = {}
|
|
@@ -14,6 +15,14 @@ export interface UseOsdkAggregationOptions<
|
|
|
14
15
|
*/
|
|
15
16
|
withProperties?: { [K in keyof RDPs] : DerivedProperty.Creator<T, RDPs[K]> };
|
|
16
17
|
/**
|
|
18
|
+
* Intersect the main query with additional filtered object sets.
|
|
19
|
+
* Each entry creates a separate object set with its own where clause,
|
|
20
|
+
* and the final result is the intersection of all sets.
|
|
21
|
+
*/
|
|
22
|
+
intersectWith?: Array<{
|
|
23
|
+
where: WhereClause<T, RDPs>
|
|
24
|
+
}>;
|
|
25
|
+
/**
|
|
17
26
|
* Aggregation options including groupBy and select
|
|
18
27
|
*/
|
|
19
28
|
aggregate: A;
|
|
@@ -25,6 +34,21 @@ export interface UseOsdkAggregationOptions<
|
|
|
25
34
|
*/
|
|
26
35
|
dedupeIntervalMs?: number;
|
|
27
36
|
}
|
|
37
|
+
export interface UseOsdkAggregationOptions<
|
|
38
|
+
T extends ObjectOrInterfaceDefinition,
|
|
39
|
+
A extends AggregateOpts<T>,
|
|
40
|
+
RDPs extends Record<string, SimplePropertyDef> = {}
|
|
41
|
+
> extends UseOsdkAggregationBaseOptions<T, A, RDPs> {}
|
|
42
|
+
export interface UseOsdkAggregationOptionsWithObjectSet<
|
|
43
|
+
T extends ObjectTypeDefinition,
|
|
44
|
+
A extends AggregateOpts<T>,
|
|
45
|
+
RDPs extends Record<string, SimplePropertyDef> = {}
|
|
46
|
+
> extends UseOsdkAggregationBaseOptions<T, A, RDPs> {
|
|
47
|
+
/**
|
|
48
|
+
* The ObjectSet to aggregate on. Enables aggregation on pivoted, filtered, or composed ObjectSets.
|
|
49
|
+
*/
|
|
50
|
+
objectSet: ObjectSet<T>;
|
|
51
|
+
}
|
|
28
52
|
export interface UseOsdkAggregationResult<
|
|
29
53
|
T extends ObjectOrInterfaceDefinition,
|
|
30
54
|
A extends AggregateOpts<T>
|
|
@@ -46,6 +70,7 @@ export interface UseOsdkAggregationResult<
|
|
|
46
70
|
*
|
|
47
71
|
* @example
|
|
48
72
|
* ```tsx
|
|
73
|
+
* // Basic aggregation without ObjectSet
|
|
49
74
|
* const { data, isLoading, error } = useOsdkAggregation(Employee, {
|
|
50
75
|
* where: { department: "Engineering" },
|
|
51
76
|
* aggregate: {
|
|
@@ -56,10 +81,23 @@ export interface UseOsdkAggregationResult<
|
|
|
56
81
|
* }
|
|
57
82
|
* }
|
|
58
83
|
* });
|
|
84
|
+
*
|
|
85
|
+
* // With a pivoted ObjectSet
|
|
86
|
+
* const pivotedSet = useMemo(() => $(Employee).pivotTo("primaryOffice"), []);
|
|
87
|
+
* const { data } = useOsdkAggregation(Office, {
|
|
88
|
+
* objectSet: pivotedSet,
|
|
89
|
+
* aggregate: { $select: { $count: "unordered" } }
|
|
90
|
+
* });
|
|
59
91
|
* ```
|
|
60
92
|
*/
|
|
61
93
|
export declare function useOsdkAggregation<
|
|
62
94
|
Q extends ObjectOrInterfaceDefinition,
|
|
63
95
|
const A extends AggregateOpts<Q>,
|
|
64
96
|
RDPs extends Record<string, SimplePropertyDef> = {}
|
|
65
|
-
>(type: Q,
|
|
97
|
+
>(type: Q, options: UseOsdkAggregationOptions<Q, A, RDPs>): UseOsdkAggregationResult<Q, A>;
|
|
98
|
+
export declare function useOsdkAggregation<
|
|
99
|
+
Q extends ObjectTypeDefinition,
|
|
100
|
+
const A extends AggregateOpts<Q>,
|
|
101
|
+
RDPs extends Record<string, SimplePropertyDef> = {}
|
|
102
|
+
>(type: Q, options: UseOsdkAggregationOptionsWithObjectSet<Q, A, RDPs>): UseOsdkAggregationResult<Q, A>;
|
|
103
|
+
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cACE,eACA,qBACA,iBACA,6BACA,mBACA,mBACK,WAAY;
|
|
1
|
+
{"mappings":"AAgBA,cACE,eACA,qBACA,iBACA,6BACA,WACA,mBACA,mBACK,WAAY;AACnB,cAAc,4BAA4B,cAAe;UAU/C;CACR,UAAU;CACV,UAAU,cAAc;CACxB,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;CAIA,QAAQ,YAAY,GAAG;;;;;CAMvB,oBAAoB,WAAW,QAAO,gBAAgB,QAAQ,GAAG,KAAK;;;;;;CAOtE,gBAAgB,MAAM;EACpB,OAAO,YAAY,GAAG;CACvB;;;;CAKD,WAAW;;;;;;;CAQX;AACD;AAED,iBAAiB;CACf,UAAU;CACV,UAAU,cAAc;CACxB,aAAa,eAAe,qBAAqB,CAAE;UAC3C,8BAA8B,GAAG,GAAG,MAAM,CAAE;AAEtD,iBAAiB;CACf,UAAU;CACV,UAAU,cAAc;CACxB,aAAa,eAAe,qBAAqB,CAAE;UAC3C,8BAA8B,GAAG,GAAG,MAAM;;;;CAIlD,WAAW,UAAU;AACtB;AAID,iBAAiB;CACf,UAAU;CACV,UAAU,cAAc;EACxB;CACA,MAAM,oBAAoB,GAAG;CAC7B;CACA,OAAO;CACP;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCD,OAAO,iBAAS;CACd,UAAU;OACJ,UAAU,cAAc;CAC9B,aAAa,eAAe,qBAAqB,CAAE;EAEnDA,MAAM,GACNC,SAAS,0BAA0B,GAAG,GAAG,QACxC,yBAAyB,GAAG;AAC/B,OAAO,iBAAS;CACd,UAAU;OACJ,UAAU,cAAc;CAC9B,aAAa,eAAe,qBAAqB,CAAE;EAEnDD,MAAM,GACNE,SAAS,uCAAuC,GAAG,GAAG,QACrD,yBAAyB,GAAG","names":["type: Q","options: UseOsdkAggregationOptions<Q, A, RDPs>","options: UseOsdkAggregationOptionsWithObjectSet<Q, A, RDPs>"],"sources":["../../../src/new/useOsdkAggregation.ts"],"version":3,"file":"useOsdkAggregation.d.ts"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { CompileTimeMetadata, ObjectTypeDefinition, Osdk, QueryDefinition } from "@osdk/api";
|
|
2
|
-
import type { QueryParameterType
|
|
1
|
+
import type { CompileTimeMetadata, ObjectSet, ObjectTypeDefinition, Osdk, QueryDefinition } from "@osdk/api";
|
|
2
|
+
import type { QueryParameterType } from "@osdk/client/unstable-do-not-use";
|
|
3
3
|
export interface UseOsdkFunctionOptions<Q extends QueryDefinition<unknown>> {
|
|
4
4
|
/**
|
|
5
5
|
* Parameters to pass to the function.
|
|
@@ -18,17 +18,23 @@ export interface UseOsdkFunctionOptions<Q extends QueryDefinition<unknown>> {
|
|
|
18
18
|
*/
|
|
19
19
|
dependsOn?: Array<ObjectTypeDefinition | string>;
|
|
20
20
|
/**
|
|
21
|
-
* Specific object instances this function depends on.
|
|
21
|
+
* Specific object instances or ObjectSets this function depends on.
|
|
22
22
|
* When any of these specific objects change, the function will refetch.
|
|
23
23
|
* More fine-grained than dependsOn for precise invalidation control.
|
|
24
24
|
*
|
|
25
|
+
* For ObjectSets, the object type is extracted asynchronously and changes
|
|
26
|
+
* to any object of that type will trigger a refetch.
|
|
27
|
+
*
|
|
25
28
|
* @example
|
|
26
29
|
* ```tsx
|
|
27
30
|
* // Refetch when this specific employee changes
|
|
28
31
|
* { dependsOnObjects: [employee] }
|
|
32
|
+
*
|
|
33
|
+
* // Refetch when any object in the ObjectSet's type changes
|
|
34
|
+
* { dependsOnObjects: [employeeObjectSet] }
|
|
29
35
|
* ```
|
|
30
36
|
*/
|
|
31
|
-
dependsOnObjects?: Array<Osdk.Instance<ObjectTypeDefinition>>;
|
|
37
|
+
dependsOnObjects?: Array<Osdk.Instance<ObjectTypeDefinition> | ObjectSet<ObjectTypeDefinition>>;
|
|
32
38
|
/**
|
|
33
39
|
* The number of milliseconds to dedupe identical function calls.
|
|
34
40
|
* Two calls with the same function and params will share results
|
|
@@ -57,7 +63,7 @@ export interface UseOsdkFunctionResult<Q extends QueryDefinition<unknown>> {
|
|
|
57
63
|
/**
|
|
58
64
|
* The function result, or undefined if not yet loaded or on error.
|
|
59
65
|
*/
|
|
60
|
-
data:
|
|
66
|
+
data: (CompileTimeMetadata<Q>["signature"] extends (...args: never[]) => infer R ? Awaited<R> : never) | undefined;
|
|
61
67
|
/**
|
|
62
68
|
* True while the function is executing.
|
|
63
69
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cACE,qBACA,sBACA,MACA,uBACK,WAAY;AACnB,cAEE,
|
|
1
|
+
{"mappings":"AAgBA,cACE,qBACA,WACA,sBACA,MACA,uBACK,WAAY;AACnB,cAEE,0BACK,kCAAmC;AAM1C,iBAAiB,uBAAuB,UAAU,0BAA0B;;;;;CAK1E,SAAS,oBAAoB,GAAG,sBAAsB,oCAElD,mBAAmB,oBAAoB,GAAG;;;;;;;;;;;CAY9C,YAAY,MAAM;;;;;;;;;;;;;;;;;;CAmBlB,mBAAmB,MACjB,KAAK,SAAS,wBAAwB,UAAU;;;;;;;CASlD;;;;;;;;;;;;;;;;CAiBA;AACD;AAED,iBAAiB,sBAAsB,UAAU,0BAA0B;;;;CAIzE,OACK,oBAAoB,GAAG,sBAAsB,GAAG,wBAAwB,IACvE,QAAQ;;;;CAOd;;;;CAKA,OAAO;;;;CAKP;;;;;CAMA;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCD,OAAO,iBAAS,gBAAgB,UAAU,0BACxCA,UAAU,GACVC,UAAS,uBAAuB,KAC/B,sBAAsB","names":["queryDef: Q","options: UseOsdkFunctionOptions<Q>"],"sources":["../../../src/new/useOsdkFunction.ts"],"version":3,"file":"useOsdkFunction.d.ts"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
export interface UseOsdkObjectResult<Q extends
|
|
1
|
+
import type { ObjectOrInterfaceDefinition, Osdk, PrimaryKeyType, PropertyKeys } from "@osdk/api";
|
|
2
|
+
export interface UseOsdkObjectResult<Q extends ObjectOrInterfaceDefinition> {
|
|
3
3
|
object: Osdk.Instance<Q> | undefined;
|
|
4
4
|
isLoading: boolean;
|
|
5
5
|
error: Error | undefined;
|
|
@@ -13,12 +13,24 @@ export interface UseOsdkObjectResult<Q extends ObjectTypeDefinition> {
|
|
|
13
13
|
* @param obj an existing `Osdk.Instance` object to get metadata for.
|
|
14
14
|
* @param enabled Enable or disable the query (defaults to true)
|
|
15
15
|
*/
|
|
16
|
-
export declare function useOsdkObject<Q extends
|
|
16
|
+
export declare function useOsdkObject<Q extends ObjectOrInterfaceDefinition>(obj: Osdk.Instance<Q>, enabled?: boolean): UseOsdkObjectResult<Q>;
|
|
17
17
|
/**
|
|
18
|
-
* Loads an object by type and primary key.
|
|
18
|
+
* Loads an object or interface instance by type and primary key.
|
|
19
19
|
*
|
|
20
|
-
* @param type
|
|
21
|
-
* @param primaryKey
|
|
20
|
+
* @param type The object type or interface definition
|
|
21
|
+
* @param primaryKey The primary key of the object
|
|
22
22
|
* @param enabled Enable or disable the query (defaults to true)
|
|
23
23
|
*/
|
|
24
|
-
export declare function useOsdkObject<Q extends
|
|
24
|
+
export declare function useOsdkObject<Q extends ObjectOrInterfaceDefinition>(type: Q, primaryKey: PrimaryKeyType<Q>, enabled?: boolean): UseOsdkObjectResult<Q>;
|
|
25
|
+
/**
|
|
26
|
+
* Loads an object or interface instance by type and primary key with options.
|
|
27
|
+
*
|
|
28
|
+
* @param type The object type or interface definition
|
|
29
|
+
* @param primaryKey The primary key of the object
|
|
30
|
+
* @param options Options including $select, enabled, and $loadPropertySecurityMetadata
|
|
31
|
+
*/
|
|
32
|
+
export declare function useOsdkObject<Q extends ObjectOrInterfaceDefinition>(type: Q, primaryKey: PrimaryKeyType<Q>, options?: {
|
|
33
|
+
$select?: readonly PropertyKeys<Q>[]
|
|
34
|
+
enabled?: boolean
|
|
35
|
+
$loadPropertySecurityMetadata?: boolean
|
|
36
|
+
}): UseOsdkObjectResult<Q>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,
|
|
1
|
+
{"mappings":"AAgBA,cACE,6BACA,MACA,gBACA,oBACK,WAAY;AAMnB,iBAAiB,oBACf,UAAU,6BACV;CACA,QAAQ,KAAK,SAAS;CACtB;CAEA,OAAO;;;;CAKP;CACA;AACD;;;;;AAMD,OAAO,iBAAS,cACd,UAAU,6BAEVA,KAAK,KAAK,SAAS,IACnBC,oBACC,oBAAoB;;;;;;;;AAQvB,OAAO,iBAAS,cACd,UAAU,6BAEVC,MAAM,GACNC,YAAY,eAAe,IAC3BF,oBACC,oBAAoB;;;;;;;;AAQvB,OAAO,iBAAS,cACd,UAAU,6BAEVC,MAAM,GACNC,YAAY,eAAe,IAC3BC,UAAU;CACR,mBAAmB,aAAa;CAChC;CACA;AACD,IACA,oBAAoB","names":["obj: Osdk.Instance<Q>","enabled?: boolean","type: Q","primaryKey: PrimaryKeyType<Q>","options?: {\n $select?: readonly PropertyKeys<Q>[];\n enabled?: boolean;\n $loadPropertySecurityMetadata?: boolean;\n }"],"sources":["../../../src/new/useOsdkObject.ts"],"version":3,"file":"useOsdkObject.d.ts"}
|
|
@@ -79,10 +79,27 @@ export interface UseOsdkObjectsOptions<
|
|
|
79
79
|
*/
|
|
80
80
|
autoFetchMore?: boolean | number;
|
|
81
81
|
streamUpdates?: boolean;
|
|
82
|
+
/**
|
|
83
|
+
* Restrict which properties are returned for each object.
|
|
84
|
+
* When provided, only the specified properties will be fetched,
|
|
85
|
+
* reducing payload sizes for list views.
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* // Only fetch name and status properties
|
|
89
|
+
* useOsdkObjects(Employee, { $select: ["name", "status"] })
|
|
90
|
+
*/
|
|
91
|
+
$select?: readonly PropertyKeys<T>[];
|
|
92
|
+
/**
|
|
93
|
+
* When true, loads per-property security metadata (marking requirements)
|
|
94
|
+
* alongside each object. The returned objects will have `$propertySecurities`
|
|
95
|
+
* populated with conjunctive/disjunctive marking requirements per property.
|
|
96
|
+
*/
|
|
97
|
+
$loadPropertySecurityMetadata?: boolean;
|
|
82
98
|
}
|
|
83
99
|
export interface UseOsdkListResult<
|
|
84
100
|
T extends ObjectOrInterfaceDefinition,
|
|
85
|
-
RDPs extends Record<string, SimplePropertyDef> = {}
|
|
101
|
+
RDPs extends Record<string, SimplePropertyDef> = {},
|
|
102
|
+
EXTRA_OPTIONS extends never | "$rid" = never
|
|
86
103
|
> {
|
|
87
104
|
/**
|
|
88
105
|
* Function to fetch more pages (undefined if no more pages)
|
|
@@ -91,7 +108,7 @@ export interface UseOsdkListResult<
|
|
|
91
108
|
/**
|
|
92
109
|
* The fetched data with derived properties
|
|
93
110
|
*/
|
|
94
|
-
data: Osdk.Instance<T, "$allBaseProperties", PropertyKeys<T>, RDPs>[] | undefined;
|
|
111
|
+
data: Osdk.Instance<T, "$allBaseProperties" | EXTRA_OPTIONS, PropertyKeys<T>, RDPs>[] | undefined;
|
|
95
112
|
/**
|
|
96
113
|
* Whether data is currently being loaded
|
|
97
114
|
*/
|
|
@@ -113,12 +130,25 @@ export interface UseOsdkListResult<
|
|
|
113
130
|
*/
|
|
114
131
|
totalCount?: string;
|
|
115
132
|
}
|
|
133
|
+
export declare function useOsdkObjects<
|
|
134
|
+
Q extends ObjectOrInterfaceDefinition,
|
|
135
|
+
L extends LinkNames<Q>
|
|
136
|
+
>(type: Q, options: UseOsdkObjectsOptions<Q> & {
|
|
137
|
+
pivotTo: L
|
|
138
|
+
rids: readonly string[]
|
|
139
|
+
}): UseOsdkListResult<LinkedType<Q, L>, {}, "$rid">;
|
|
116
140
|
export declare function useOsdkObjects<
|
|
117
141
|
Q extends ObjectOrInterfaceDefinition,
|
|
118
142
|
L extends LinkNames<Q>
|
|
119
143
|
>(type: Q, options: UseOsdkObjectsOptions<Q> & {
|
|
120
144
|
pivotTo: L
|
|
121
145
|
}): UseOsdkListResult<LinkedType<Q, L>>;
|
|
146
|
+
export declare function useOsdkObjects<
|
|
147
|
+
Q extends ObjectOrInterfaceDefinition,
|
|
148
|
+
RDPs extends Record<string, SimplePropertyDef> = {}
|
|
149
|
+
>(type: Q, options: UseOsdkObjectsOptions<Q, RDPs> & {
|
|
150
|
+
rids: readonly string[]
|
|
151
|
+
}): UseOsdkListResult<Q, RDPs, "$rid">;
|
|
122
152
|
export declare function useOsdkObjects<
|
|
123
153
|
Q extends ObjectOrInterfaceDefinition,
|
|
124
154
|
RDPs extends Record<string, SimplePropertyDef> = {}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AAgBA,cACE,iBACA,YACA,WACA,6BACA,MACA,cACA,mBACA,mBACK,WAAY;AAMnB,iBAAiB;CACf,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;;;;;;;CAiBA;;;;;;CAOA,QAAQ,YAAY,GAAG;;;;CAKvB,aACG,KAAK,aAAa,OAAM,QAAQ;;;;CAMnC;;;;;CAMA,oBAAoB,WAAW,QAAO,gBAAgB,QAAQ,GAAG,KAAK;;;;;;;CAQtE;;;;;;;;;CAUA;;;;;;CAOA,gBAAgB,MAAM;EACpB,OAAO,YAAY,GAAG;CACvB;;;;;CAMD,UAAU,UAAU;;;;;;;;;;CAWpB;CAEA;AACD;AAED,iBAAiB;CACf,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;
|
|
1
|
+
{"mappings":"AAgBA,cACE,iBACA,YACA,WACA,6BACA,MACA,cACA,mBACA,mBACK,WAAY;AAMnB,iBAAiB;CACf,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;;;;;;;CAiBA;;;;;;CAOA,QAAQ,YAAY,GAAG;;;;CAKvB,aACG,KAAK,aAAa,OAAM,QAAQ;;;;CAMnC;;;;;CAMA,oBAAoB,WAAW,QAAO,gBAAgB,QAAQ,GAAG,KAAK;;;;;;;CAQtE;;;;;;;;;CAUA;;;;;;CAOA,gBAAgB,MAAM;EACpB,OAAO,YAAY,GAAG;CACvB;;;;;CAMD,UAAU,UAAU;;;;;;;;;;CAWpB;CAEA;;;;;;;;;;CAWA,mBAAmB,aAAa;;;;;;CAOhC;AACD;AAED,iBAAiB;CACf,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,8BAA8B;EAC9B;;;;CAIA,kBAAkB;;;;CAKlB,MACI,KAAK,SACL,GACA,uBAAuB,eACvB,aAAa,IACb;;;;CAOJ;;;;CAKA,OAAO;;;;;;;;CASP;;;;CAKA;AACD;AAUD,OAAO,iBAAS;CACd,UAAU;CACV,UAAU,UAAU;EAEpBA,MAAM,GACNC,SAAS,sBAAsB,KAAK;CAAE,SAAS;CAAG;AAAyB,IAC1E,kBAAkB,WAAW,GAAG,IAAI,CAAE,GAAE;AAE3C,OAAO,iBAAS;CACd,UAAU;CACV,UAAU,UAAU;EAEpBD,MAAM,GACNE,SAAS,sBAAsB,KAAK;CAAE,SAAS;AAAG,IACjD,kBAAkB,WAAW,GAAG;AAEnC,OAAO,iBAAS;CACd,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EAEnDF,MAAM,GACNG,SAAS,sBAAsB,GAAG,QAAQ;CAAE;AAAyB,IACpE,kBAAkB,GAAG,MAAM;AAE9B,OAAO,iBAAS;CACd,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EAEnDH,MAAM,GACNI,UAAU,sBAAsB,GAAG,QAClC,kBAAkB,GAAG","names":["type: Q","options: UseOsdkObjectsOptions<Q> & { pivotTo: L; rids: readonly string[] }","options: UseOsdkObjectsOptions<Q> & { pivotTo: L }","options: UseOsdkObjectsOptions<Q, RDPs> & { rids: readonly string[] }","options?: UseOsdkObjectsOptions<Q, RDPs>"],"sources":["../../../src/new/useOsdkObjects.ts"],"version":3,"file":"useOsdkObjects.d.ts"}
|