-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add check-api for @osdk/client (#494)
- Loading branch information
1 parent
fee51a3
commit ddeb76f
Showing
10 changed files
with
196 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| --- | ||
| --- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| ## API Report File for "@osdk/client" | ||
|
|
||
| > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). | ||
| ```ts | ||
|
|
||
| import type { ActionDefinition } from '@osdk/api'; | ||
| import { ActionEditResponse } from '@osdk/client.api'; | ||
| import { ActionReturnTypeForOptions } from '@osdk/client.api'; | ||
| import type { ActionSignatureFromDef } from '@osdk/client.api'; | ||
| import { ActionValidationResponse } from '@osdk/client.api'; | ||
| import { ApplyActionOptions } from '@osdk/client.api'; | ||
| import { ApplyBatchActionOptions } from '@osdk/client.api'; | ||
| import type { Attachment } from '@osdk/client.api'; | ||
| import type { GreaterThan } from 'type-fest'; | ||
| import type { GreaterThanOrEqual } from 'type-fest'; | ||
| import type { InterfaceDefinition } from '@osdk/api'; | ||
| import { InterfaceObjectSet } from '@osdk/client.api'; | ||
| import type { IsEqual } from 'type-fest'; | ||
| import type { LessThan } from 'type-fest'; | ||
| import type { Logger } from 'pino'; | ||
| import { NOOP } from '@osdk/client.api'; | ||
| import type { ObjectOrInterfaceDefinition } from '@osdk/api'; | ||
| import { ObjectSet } from '@osdk/client.api'; | ||
| import type { ObjectSet as ObjectSet_2 } from '@osdk/internal.foundry'; | ||
| import type { ObjectTypeDefinition } from '@osdk/api'; | ||
| import { Osdk } from '@osdk/client.api'; | ||
| import { OsdkActionParameters } from '@osdk/client.api'; | ||
| import { OsdkObject } from '@osdk/client.api'; | ||
| import { PageResult } from '@osdk/client.api'; | ||
| import { PalantirApiError } from '@osdk/shared.net.errors'; | ||
| import type { QueryDefinition } from '@osdk/api'; | ||
| import type { QuerySignatureFromDef } from '@osdk/client.api'; | ||
| import type { SharedClient } from '@osdk/shared.client'; | ||
| import { SharedClientContext } from '@osdk/shared.client'; | ||
| import type { VersionBound } from '@osdk/api'; | ||
| import { WhereClause } from '@osdk/client.api'; | ||
|
|
||
| export { ActionEditResponse } | ||
|
|
||
| export { ActionReturnTypeForOptions } | ||
|
|
||
| // @public (undocumented) | ||
| export class ActionValidationError extends Error { | ||
| constructor(validation: ActionValidationResponse); | ||
| // (undocumented) | ||
| validation: ActionValidationResponse; | ||
| } | ||
|
|
||
| export { ActionValidationResponse } | ||
|
|
||
| export { ApplyActionOptions } | ||
|
|
||
| export { ApplyBatchActionOptions } | ||
|
|
||
| // Warning: (ae-forgotten-export) The symbol "MinimalClient" needs to be exported by the entry point index.d.ts | ||
| // | ||
| // @public (undocumented) | ||
| export interface Client extends SharedClient<MinimalClient> { | ||
| // Warning: (ae-forgotten-export) The symbol "CheckVersionBound" needs to be exported by the entry point index.d.ts | ||
| // | ||
| // (undocumented) | ||
| <Q extends (ObjectTypeDefinition<any, any> & VersionBound<any>)>(o: CheckVersionBound<Q>): ObjectSet<Q>; | ||
| // (undocumented) | ||
| <Q extends ActionDefinition<any, any, any>>(o: CheckVersionBound<Q>): ActionSignatureFromDef<Q>; | ||
| // (undocumented) | ||
| <Q extends QueryDefinition<any, any>>(o: CheckVersionBound<Q>): QuerySignatureFromDef<Q>; | ||
| } | ||
|
|
||
| // @public (undocumented) | ||
| export function createAttachmentFromRid(client: MinimalClient, rid: string): Attachment; | ||
|
|
||
| // @public (undocumented) | ||
| export const createClient: (baseUrl: string, ontologyRid: string | Promise<string>, tokenProvider: () => Promise<string>, options?: { | ||
| logger?: Logger; | ||
| } | undefined, fetchFn?: typeof fetch | undefined) => Client; | ||
|
|
||
| // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen | ||
| // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen | ||
| // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen | ||
| // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen | ||
| // | ||
| // @public | ||
| export function createPlatformClient(baseUrl: string, tokenProvider: () => Promise<string>, options?: undefined, fetchFn?: typeof globalThis.fetch): SharedClientContext; | ||
|
|
||
| export { InterfaceObjectSet } | ||
|
|
||
| // @public (undocumented) | ||
| export function isOk(result: ResultOrError<any>): result is { | ||
| type: "ok"; | ||
| }; | ||
|
|
||
| export { NOOP } | ||
|
|
||
| export { ObjectSet } | ||
|
|
||
| export { Osdk } | ||
|
|
||
| export { OsdkActionParameters } | ||
|
|
||
| export { OsdkObject } | ||
|
|
||
| export { PageResult } | ||
|
|
||
| export { PalantirApiError } | ||
|
|
||
| // @public (undocumented) | ||
| export type ResultOrError<T extends object> = ({ | ||
| type: "ok"; | ||
| err?: never; | ||
| } & T) | { | ||
| type: "err"; | ||
| data?: never; | ||
| err?: unknown; | ||
| }; | ||
|
|
||
| export { WhereClause } | ||
|
|
||
| // (No @packageDocumentation comment for this package) | ||
|
|
||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", | ||
| "extends": "@osdk/monorepo.api-extractor/base.json", | ||
| "mainEntryPointFilePath": "<projectFolder>/build/esm/index.d.ts" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters