@osdk/react 0.9.3 → 0.10.0-beta.10

package/build/cjs/public/experimental/admin.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/utils/usePlatformQuery.ts","../../../../src/new/platform-apis/admin/useCurrentFoundryUser.ts","../../../../src/new/platform-apis/admin/useFoundryUser.ts","../../../../src/new/platform-apis/admin/useFoundryUsersList.ts"],"names":["React","makeExternalStore","OsdkContext2","Users"],"mappings":";;;;;;;;;;AAkBO,SAAS,gBAAiB,CAAA;AAAA,EAC/B,KAAA;AAAA,EACA,SAAA;AAAA,EACA,OAAU,GAAA;AACZ,CAAG,EAAA;AACD,EAAM,MAAA,WAAA,GAAcA,uBAAM,MAAO,EAAA;AACjC,EAAM,MAAA,WAAA,GAAcA,sBAAM,CAAA,WAAA,CAAY,MAAM;AAC1C,IAAA,MAAM,WAAW,WAAY,CAAA,OAAA;AAC7B,IAAA,IAAI,YAAY,IAAM,EAAA;AACtB,IAAA,QAAA,CAAS,IAAK,CAAA;AAAA,MACZ,MAAQ,EAAA,SAAA;AAAA,MACR,IAAM,EAAA;AAAA,KACP,CAAA;AACD,IAAM,KAAA,EAAA,CAAE,KAAK,CAAQ,IAAA,KAAA;AACnB,MAAA,QAAA,CAAS,IAAK,CAAA;AAAA,QACZ,MAAQ,EAAA,SAAA;AAAA,QACR;AAAA,OACD,CAAA;AAAA,KACF,CAAE,CAAA,KAAA,CAAM,CAAO,GAAA,KAAA;AACd,MAAA,QAAA,CAAS,MAAM,GAAG,CAAA;AAAA,KACnB,CAAA;AAAA,GACH,EAAG,CAAC,KAAK,CAAC,CAAA;AACV,EAAM,MAAA;AAAA,IACJ,SAAA;AAAA,IACA;AAAA,GACF,GAAIA,sBAAM,CAAA,OAAA,CAAQ,MAAM;AACtB,IAAA,IAAI,CAAC,OAAS,EAAA;AACZ,MAAA,OAAOC,oCAAkB,OAAO;AAAA,QAC9B,aAAa,MAAM;AAAA;AAAC,OACtB,CAAA,EAAI,QAAQ,GAAI,CAAA,QAAA,KAAa,eAAe,CAAG,EAAA,SAAS,sBAAsB,MAAS,CAAA;AAAA;AAEzF,IAAA,OAAOA,oCAAkB,CAAY,QAAA,KAAA;AACnC,MAAA,WAAA,CAAY,OAAU,GAAA,QAAA;AACtB,MAAY,WAAA,EAAA;AACZ,MAAO,OAAA;AAAA,QACL,aAAa,MAAM;AACjB,UAAA,WAAA,CAAY,OAAU,GAAA,MAAA;AAAA;AACxB,OACF;AAAA,OACC,SAAS,CAAA;AAAA,GACX,EAAA,CAAC,OAAS,EAAA,SAAA,EAAW,WAAW,CAAC,CAAA;AACpC,EAAA,MAAM,OAAU,GAAAD,sBAAA,CAAM,oBAAqB,CAAA,SAAA,EAAW,WAAW,CAAA;AACjE,EAAI,IAAA,KAAA;AACJ,EAAA,IAAI,OAAW,IAAA,OAAA,IAAW,OAAW,IAAA,OAAA,CAAQ,SAAS,IAAM,EAAA;AAC1D,IAAA,KAAA,GAAQ,OAAQ,CAAA,KAAA;AAAA,GAClB,MAAA,IAAW,OAAS,EAAA,MAAA,KAAW,OAAS,EAAA;AACtC,IAAA,KAAA,GAAQ,IAAI,KAAA,CAAM,CAAiC,8BAAA,EAAA,SAAS,CAAE,CAAA,CAAA;AAAA;AAEhE,EAAO,OAAA;AAAA,IACL,MAAM,OAAS,EAAA,IAAA;AAAA,IACf,WAAW,OAAU,GAAA,OAAA,EAAS,MAAW,KAAA,SAAA,IAAa,CAAC,OAAU,GAAA,KAAA;AAAA,IACjE,KAAA;AAAA,IACA,OAAS,EAAA;AAAA,GACX;AACF;;;AChDO,SAAS,qBAAsB,CAAA;AAAA,EACpC,OAAU,GAAA;AACZ,CAAA,GAAI,EAAI,EAAA;AACN,EAAM,MAAA;AAAA,IACJ;AAAA,GACF,GAAIA,sBAAM,CAAA,UAAA,CAAWE,8BAAY,CAAA;AACjC,EAAM,MAAA,WAAA,GAAcF,sBAAM,CAAA,WAAA,CAAY,MAAMG,mBAAA,CAAM,WAAW,MAAM,CAAA,EAAG,CAAC,MAAM,CAAC,CAAA;AAC9E,EAAA,MAAM,QAAQ,gBAAiB,CAAA;AAAA,IAC7B,KAAO,EAAA,WAAA;AAAA,IACP,OAAA;AAAA,IACA,SAAW,EAAA;AAAA,GACZ,CAAA;AACD,EAAO,OAAA;AAAA,IACL,aAAa,KAAM,CAAA,IAAA;AAAA,IACnB,WAAW,KAAM,CAAA,SAAA;AAAA,IACjB,OAAO,KAAM,CAAA,KAAA;AAAA,IACb,SAAS,KAAM,CAAA;AAAA,GACjB;AACF;ACjBO,SAAS,eAAe,MAAQ,EAAA;AAAA,EACrC,OAAU,GAAA,IAAA;AAAA,EACV,MAAS,GAAA;AACX,CAAA,GAAI,EAAI,EAAA;AACN,EAAM,MAAA;AAAA,IACJ;AAAA,GACF,GAAIH,sBAAM,CAAA,UAAA,CAAWE,8BAAY,CAAA;AACjC,EAAM,MAAA,WAAA,GAAcF,sBAAM,CAAA,WAAA,CAAY,MAAM;AAC1C,IAAOG,OAAAA,mBAAAA,CAAM,GAAI,CAAA,MAAA,EAAQ,MAAQ,EAAA;AAAA,MAC/B;AAAA,KACD,CAAA;AAAA,GACA,EAAA,CAAC,MAAQ,EAAA,MAAA,EAAQ,MAAM,CAAC,CAAA;AAC3B,EAAA,MAAM,QAAQ,gBAAiB,CAAA;AAAA,IAC7B,KAAO,EAAA,WAAA;AAAA,IACP,OAAA;AAAA,IACA,SAAW,EAAA;AAAA,GACZ,CAAA;AACD,EAAO,OAAA;AAAA,IACL,MAAM,KAAM,CAAA,IAAA;AAAA,IACZ,WAAW,KAAM,CAAA,SAAA;AAAA,IACjB,OAAO,KAAM,CAAA,KAAA;AAAA,IACb,SAAS,KAAM,CAAA;AAAA,GACjB;AACF;ACxBO,SAAS,mBAAoB,CAAA;AAAA,EAClC,OAAU,GAAA,IAAA;AAAA,EACV,OAAU,GAAA,QAAA;AAAA,EACV,QAAW,GAAA,GAAA;AAAA,EACX;AACF,CAAA,GAAI,EAAI,EAAA;AACN,EAAM,MAAA;AAAA,IACJ;AAAA,GACF,GAAIH,sBAAM,CAAA,UAAA,CAAWE,8BAAY,CAAA;AACjC,EAAM,MAAA,WAAA,GAAcF,sBAAM,CAAA,WAAA,CAAY,MAAM;AAC1C,IAAOG,OAAAA,mBAAAA,CAAM,KAAK,MAAQ,EAAA;AAAA,MACxB,OAAA;AAAA,MACA,QAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,KACA,CAAC,MAAA,EAAQ,OAAS,EAAA,QAAA,EAAU,SAAS,CAAC,CAAA;AACzC,EAAA,MAAM,QAAQ,gBAAiB,CAAA;AAAA,IAC7B,KAAO,EAAA,WAAA;AAAA,IACP,OAAA;AAAA,IACA,SAAW,EAAA;AAAA,GACZ,CAAA;AACD,EAAO,OAAA;AAAA,IACL,KAAA,EAAO,MAAM,IAAM,EAAA,IAAA;AAAA,IACnB,aAAA,EAAe,MAAM,IAAM,EAAA,aAAA;AAAA,IAC3B,WAAW,KAAM,CAAA,SAAA;AAAA,IACjB,OAAO,KAAM,CAAA,KAAA;AAAA,IACb,SAAS,KAAM,CAAA;AAAA,GACjB;AACF","file":"admin.cjs","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\nimport React from \"react\";\nimport { makeExternalStore } from \"../new/makeExternalStore.js\";\nexport function usePlatformQuery({\n  query,\n  queryName,\n  enabled = true\n}) {\n  const observerRef = React.useRef();\n  const handleQuery = React.useCallback(() => {\n    const observer = observerRef.current;\n    if (observer == null) return;\n    observer.next({\n      status: \"loading\",\n      data: undefined\n    });\n    query().then(data => {\n      observer.next({\n        status: \"success\",\n        data\n      });\n    }).catch(err => {\n      observer.error(err);\n    });\n  }, [query]);\n  const {\n    subscribe,\n    getSnapShot\n  } = React.useMemo(() => {\n    if (!enabled) {\n      return makeExternalStore(() => ({\n        unsubscribe: () => {}\n      }), process.env.NODE_ENV !== \"production\" ? `${queryName} Query [DISABLED]` : undefined);\n    }\n    return makeExternalStore(observer => {\n      observerRef.current = observer;\n      handleQuery();\n      return {\n        unsubscribe: () => {\n          observerRef.current = undefined;\n        }\n      };\n    }, queryName);\n  }, [enabled, queryName, handleQuery]);\n  const payload = React.useSyncExternalStore(subscribe, getSnapShot);\n  let error;\n  if (payload && \"error\" in payload && payload.error != null) {\n    error = payload.error;\n  } else if (payload?.status === \"error\") {\n    error = new Error(`Failed to query platform API: ${queryName}`);\n  }\n  return {\n    data: payload?.data,\n    isLoading: enabled ? payload?.status === \"loading\" || !payload : false,\n    error,\n    refetch: handleQuery\n  };\n}","/*\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\nimport { Users } from \"@osdk/foundry.admin\";\nimport React from \"react\";\nimport { usePlatformQuery } from \"../../../utils/usePlatformQuery.js\";\nimport { OsdkContext2 } from \"../../OsdkContext2.js\";\n/**\n * Get the currently signed in User.\n * @param options Options to control the query.\n */\nexport function useCurrentFoundryUser({\n  enabled = true\n} = {}) {\n  const {\n    client\n  } = React.useContext(OsdkContext2);\n  const handleQuery = React.useCallback(() => Users.getCurrent(client), [client]);\n  const query = usePlatformQuery({\n    query: handleQuery,\n    enabled,\n    queryName: \"foundry-current-user\"\n  });\n  return {\n    currentUser: query.data,\n    isLoading: query.isLoading,\n    error: query.error,\n    refetch: query.refetch\n  };\n}","/*\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\nimport { Users } from \"@osdk/foundry.admin\";\nimport React from \"react\";\nimport { usePlatformQuery } from \"../../../utils/usePlatformQuery.js\";\nimport { OsdkContext2 } from \"../../OsdkContext2.js\";\n/**\n * Get the User with the specified id.\n * @param userId A Foundry User ID.\n * @param options Options to control the query.\n */\nexport function useFoundryUser(userId, {\n  enabled = true,\n  status = \"ACTIVE\"\n} = {}) {\n  const {\n    client\n  } = React.useContext(OsdkContext2);\n  const handleQuery = React.useCallback(() => {\n    return Users.get(client, userId, {\n      status\n    });\n  }, [client, userId, status]);\n  const query = usePlatformQuery({\n    query: handleQuery,\n    enabled,\n    queryName: \"foundry-user\"\n  });\n  return {\n    user: query.data,\n    isLoading: query.isLoading,\n    error: query.error,\n    refetch: query.refetch\n  };\n}","/*\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\nimport { Users } from \"@osdk/foundry.admin\";\nimport React from \"react\";\nimport { usePlatformQuery } from \"../../../utils/usePlatformQuery.js\";\nimport { OsdkContext2 } from \"../../OsdkContext2.js\";\n/**\n * Lists all Users. This is a paged endpoint. Each page may be smaller or larger than the requested page size.\n * @param options Options to control the query.\n */\nexport function useFoundryUsersList({\n  enabled = true,\n  include = \"ACTIVE\",\n  pageSize = 1000,\n  pageToken\n} = {}) {\n  const {\n    client\n  } = React.useContext(OsdkContext2);\n  const handleQuery = React.useCallback(() => {\n    return Users.list(client, {\n      include,\n      pageSize,\n      pageToken\n    });\n  }, [client, include, pageSize, pageToken]);\n  const query = usePlatformQuery({\n    query: handleQuery,\n    enabled,\n    queryName: \"foundry-users-list\"\n  });\n  return {\n    users: query.data?.data,\n    nextPageToken: query.data?.nextPageToken,\n    isLoading: query.isLoading,\n    error: query.error,\n    refetch: query.refetch\n  };\n}"]}

package/build/cjs/public/experimental/admin.d.cts

@@ -0,0 +1,118 @@
+import { User, ListUsersResponse } from '@osdk/foundry.admin';
+import { UserStatus } from '@osdk/foundry.core';
+
+interface UseCurrentFoundryUserOptions {
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     * });
+     */
+    enabled?: boolean;
+}
+interface UseCurrentFoundryUserResult {
+    currentUser: User | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * Get the currently signed in User.
+ * @param options Options to control the query.
+ */
+declare function useCurrentFoundryUser({ enabled }?: UseCurrentFoundryUserOptions): UseCurrentFoundryUserResult;
+
+interface UseFoundryUserOptions {
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     * });
+     */
+    enabled?: boolean;
+    /**
+     * The default status of the users returned in the list.
+     *
+     * @default "ACTIVE"
+     */
+    status?: UserStatus;
+}
+interface UseFoundryUserResult {
+    user: User | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * Get the User with the specified id.
+ * @param userId A Foundry User ID.
+ * @param options Options to control the query.
+ */
+declare function useFoundryUser(userId: string, { enabled, status }?: UseFoundryUserOptions): UseFoundryUserResult;
+
+interface UseFoundryUsersListOptions {
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     * });
+     */
+    enabled?: boolean;
+    /**
+     * The default status of the users returned in the list.
+     *
+     * @default "ACTIVE"
+     */
+    include?: UserStatus;
+    /**
+     * The preferred page size for the list.
+     *
+     * @default 1000
+     */
+    pageSize?: number;
+    /**
+     * The page token indicates where to start paging. This should be omitted from the first page's request.
+     * To fetch the next page, clients should take the value from the nextPageToken field of the previous
+     * response and use it to populate the pageToken field of the next request.
+     */
+    pageToken?: string;
+}
+interface UseFoundryUsersListResult {
+    users: ListUsersResponse["data"] | undefined;
+    /**
+     * The page token to be used for the next page of users. If this is undefined, there are no more
+     * pages of users to load.
+     */
+    nextPageToken: string | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * Lists all Users. This is a paged endpoint. Each page may be smaller or larger than the requested page size.
+ * @param options Options to control the query.
+ */
+declare function useFoundryUsersList({ enabled, include, pageSize, pageToken }?: UseFoundryUsersListOptions): UseFoundryUsersListResult;
+
+export { useCurrentFoundryUser, useFoundryUser, useFoundryUsersList };