Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update several tags in common and frontend @beta to public #1068

Merged
merged 9 commits into from
Mar 31, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion common/api/imodeljs-backend.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4080,7 +4080,7 @@ export enum SqliteValueType {
String = 3
}

// @internal
// @public
export class StandaloneDb extends IModelDb {
get changeSetId(): undefined;
static createEmpty(filePath: string, args: CreateEmptyStandaloneIModelProps): StandaloneDb;
Expand Down
22 changes: 11 additions & 11 deletions common/api/imodeljs-common.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1937,7 +1937,7 @@ export enum DownloadBriefcaseStatus {
// @beta
export type DPoint2dProps = number[];

// @beta
// @public
export const Easing: {
Linear: {
None: (k: number) => number;
Expand Down Expand Up @@ -1994,7 +1994,7 @@ export const Easing: {
};
};

// @beta (undocumented)
// @public (undocumented)
export type EasingFunction = (k: number) => number;

// @public
Expand Down Expand Up @@ -3779,7 +3779,7 @@ export abstract class IModel implements IModelProps {
toJSON(): IModelConnectionProps;
}

// @alpha (undocumented)
// @public
export type IModelConnectionProps = IModelProps & IModelRpcProps;

// @beta
Expand Down Expand Up @@ -4040,7 +4040,7 @@ export enum InternetConnectivityStatus {
Online = 0
}

// @beta
// @public
export const Interpolation: {
Linear: (v: any, k: number) => number;
Bezier: (v: any, k: number) => number;
Expand All @@ -4053,7 +4053,7 @@ export const Interpolation: {
};
};

// @beta (undocumented)
// @public (undocumented)
export type InterpolationFunction = (v: any, k: number) => number;

// @internal (undocumented)
Expand Down Expand Up @@ -5730,7 +5730,7 @@ export interface RelatedElementProps {
export interface RelationshipProps extends EntityProps, SourceAndTarget {
}

// @beta
// @public
export type RemoveFunction = () => void;

// @beta
Expand Down Expand Up @@ -7001,7 +7001,7 @@ export interface SpatialViewDefinitionProps extends ViewDefinition3dProps {
modelSelectorId: Id64String;
}

// @beta
// @public
export type StandaloneOpenOptions = OpenDbKey;

// @beta
Expand Down Expand Up @@ -7629,7 +7629,7 @@ export enum TreeFlags {
UseProjectExtents = 1
}

// @beta
// @public
export class Tween {
constructor(_group: Tweens, _object: any);
// (undocumented)
Expand Down Expand Up @@ -7684,10 +7684,10 @@ export class Tween {
yoyo(yoyo: boolean): this;
}

// @beta (undocumented)
// @public (undocumented)
export type TweenCallback = (obj: any) => void;

// @beta
// @public
export class Tweens {
// (undocumented)
add(tween: Tween): void;
Expand Down Expand Up @@ -7767,7 +7767,7 @@ export enum TypeOfChange {
Property = 1
}

// @beta (undocumented)
// @public (undocumented)
export type UpdateCallback = (obj: any, t: number) => void;

// @beta
Expand Down
6 changes: 3 additions & 3 deletions common/api/imodeljs-frontend.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1209,10 +1209,10 @@ export function areaToEyeHeight(view3d: ViewState3d, area: GlobalLocationArea, o
// @internal
export function areaToEyeHeightFromGcs(view3d: ViewState3d, area: GlobalLocationArea, offset?: number): Promise<number>;

// @beta
// @public
export type AsyncFunction = (...args: any) => Promise<any>;

// @beta
// @public
export type AsyncMethodsOf<T> = {
[P in keyof T]: T[P] extends AsyncFunction ? P : never;
}[keyof T];
Expand Down Expand Up @@ -7109,7 +7109,7 @@ export enum PrimitiveVisibility {
Uninstanced = 2
}

// @beta
// @public
export type PromiseReturnType<T extends AsyncFunction> = T extends (...args: any) => Promise<infer R> ? R : any;

// @internal (undocumented)
Expand Down
2 changes: 1 addition & 1 deletion common/api/summary/imodeljs-backend.exports.csv
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ internal;SqliteStatement
internal;SqliteStatementCache
internal;SqliteValue
internal;SqliteValueType
internal;StandaloneDb
public;StandaloneDb
internal;StringParam
public;SubCategory
public;Subject
Expand Down
22 changes: 11 additions & 11 deletions common/api/summary/imodeljs-common.exports.csv
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,8 @@ public;DisplayStyleSubCategoryProps
beta;DomainOptions
internal;DownloadBriefcaseStatus
beta;DPoint2dProps = number[]
beta;Easing:
beta;EasingFunction = (k: number) => number
public;Easing:
public;EasingFunction = (k: number) => number
public;EcefLocation
public;EcefLocationProps
public;ECJsNames
Expand Down Expand Up @@ -250,7 +250,7 @@ public;ImageSourceFormat
internal;ImdlFlags
internal;ImdlHeader
public;class IModel
alpha;IModelConnectionProps = IModelProps & IModelRpcProps
public;IModelConnectionProps = IModelProps & IModelRpcProps
beta;IModelCoordinatesRequestProps
beta;IModelCoordinatesResponseProps
public;IModelEncryptionProps
Expand All @@ -271,8 +271,8 @@ public;InformationPartitionElementProps
internal;initializeRpcRequest: () => void
internal;INSTANCE: unique symbol
beta;InternetConnectivityStatus
beta;Interpolation:
beta;InterpolationFunction = (v: any, k: number) => number
public;Interpolation:
public;InterpolationFunction = (v: any, k: number) => number
internal;IpcAppChannel
internal;IpcAppFunctions
internal;IpcAppNotifications
Expand Down Expand Up @@ -414,7 +414,7 @@ internal;REGISTRY: unique symbol
public;RelatedElement
public;RelatedElementProps
public;RelationshipProps
beta;RemoveFunction = () => void
public;RemoveFunction = () => void
beta;class RenderMaterial
beta;RenderMaterial
beta;RenderMaterialProps
Expand Down Expand Up @@ -515,7 +515,7 @@ public;SolarShadowSettingsProps
public;SourceAndTarget
beta;SpatialClassificationProps
public;SpatialViewDefinitionProps
beta;StandaloneOpenOptions = OpenDbKey
public;StandaloneOpenOptions = OpenDbKey
beta;StorageValue = string | number | boolean | null | Uint8Array
public;SubCategoryAppearance
public;SubCategoryAppearance
Expand Down Expand Up @@ -570,15 +570,15 @@ internal;TileTreeMetadata
internal;TileTreeProps
alpha;TileVersionInfo
internal;TreeFlags
beta;Tween
beta;TweenCallback = (obj: any) => void
beta;Tweens
public;Tween
public;TweenCallback = (obj: any) => void
public;Tweens
public;TxnAction
internal;TxnNotifications
public;TypeDefinition
public;TypeDefinitionElementProps
internal;TypeOfChange
beta;UpdateCallback = (obj: any, t: number) => void
public;UpdateCallback = (obj: any, t: number) => void
beta;UpgradeOptions
public;UrlLinkProps
public;ViewAttachmentLabelProps
Expand Down
6 changes: 3 additions & 3 deletions common/api/summary/imodeljs-frontend.exports.csv
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ internal;ArcGisTokenManager
internal;ArcGisUtilities
internal;areaToEyeHeight(view3d: ViewState3d, area: GlobalLocationArea, offset?: number): number
internal;areaToEyeHeightFromGcs(view3d: ViewState3d, area: GlobalLocationArea, offset?: number): Promise
beta;AsyncFunction = (...args: any) => Promise
beta;AsyncMethodsOf
public;AsyncFunction = (...args: any) => Promise
public;AsyncMethodsOf
public;AuthorizedFrontendRequestContext
public;AuxCoordSystem2dState
public;AuxCoordSystem3dState
Expand Down Expand Up @@ -387,7 +387,7 @@ beta;PlanarClipMaskState
internal;PlanarTilePatch
public;class PrimitiveTool
alpha;PrimitiveVisibility
beta;PromiseReturnType
public;PromiseReturnType
internal;QuadId
beta;QuantityFormatOverridesChangedArgs
beta;QuantityFormatsChangedArgs
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"changes": [
{
"packageName": "@bentley/imodeljs-common",
"comment": "",
"type": "none"
}
],
"packageName": "@bentley/imodeljs-common",
"email": "33296803+kabentley@users.noreply.github.com"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"changes": [
{
"packageName": "@bentley/imodeljs-frontend",
"comment": "",
"type": "none"
}
],
"packageName": "@bentley/imodeljs-frontend",
"email": "33296803+kabentley@users.noreply.github.com"
}
12 changes: 6 additions & 6 deletions core/backend/src/IModelDb.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2639,10 +2639,11 @@ export class SnapshotDb extends IModelDb {
}

/** Standalone iModels are read/write files that are not managed by iModelHub.
* They are relevant only for single-practitioner scenarios where team collaboration is necessary.
* However, Standalone iModels are designed such that the API interaction between Standalone iModels and Briefcase
* They are relevant only for small-scale single-user scenarios.
* Standalone iModels are designed such that the API for Standalone iModels and Briefcase
* iModels (those synchronized with iModelHub) are as similar and consistent as possible.
* This leads to a straightforward process where the practitioner can optionally choose to upgrade to iModelHub.
* This leads to a straightforward process where the a user starts with StandaloneDb and can
* optionally choose to upgrade to iModelHub.
*
* Some additional details. Standalone iModels:
* - always have [Guid.empty]($bentley) for their contextId (they are "unassociated" files)
Expand All @@ -2651,9 +2652,8 @@ export class SnapshotDb extends IModelDb {
* - may be opened without supplying any user credentials
* - may be opened read/write
* - may optionally support undo/redo via [[TxmManager]]
* - cannot apply a changeset to nor generate a changesets
* - are only available to authorized applications
* @internal
* - cannot apply a changeset to nor generate a changesets (since there is no timeline from which to get/push changesets)
* @public
pmconne marked this conversation as resolved.
Show resolved Hide resolved
*/
export class StandaloneDb extends IModelDb {
public get isStandalone(): boolean { return true; }
Expand Down
12 changes: 8 additions & 4 deletions core/common/src/IModel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export interface RootSubjectProps {
description?: string;
}

/** Properties that are about an iModel.
/** Properties of an iModel that are always held in memory whenever one is opened, both on the frontend and on the backend .
* @public
*/
export interface IModelProps {
Expand All @@ -76,7 +76,11 @@ export interface IModelProps {
name?: string;
}

/** @alpha */
/**
* The properties returned by the backend when creating a new [[IModelConnection]] from the frontend, either with Rpc or with Ipc.
* These properties describe the iModel held on the backend for thew newly formed connection and are used to construct a new
* [[IModelConnection]] instance on the frontend to access it.
* @public */
export type IModelConnectionProps = IModelProps & IModelRpcProps;

/** The properties that can be supplied when creating a *new* iModel.
Expand Down Expand Up @@ -123,8 +127,8 @@ export interface SnapshotOpenOptions extends IModelEncryptionProps, OpenDbKey {
autoUploadBlocks?: boolean;
}

/** Options that can be supplied when opening an existing StandaloneDb.
* @beta
/** Options supplied to open a StandaloneDb.
pmconne marked this conversation as resolved.
Show resolved Hide resolved
* @public
*/
export type StandaloneOpenOptions = OpenDbKey;

Expand Down
16 changes: 8 additions & 8 deletions core/common/src/Tween.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
* like the global object `TWEEN` in tween.js. You must create an instance of this class, and then create [[Tween]]s by
* calling [[Tweens.create]] or by calling `new Tween()` and pass your Group as its first argument.
* @see The [tween.js users guide](https://github.com/tweenjs/tween.js/blob/master/docs/user_guide.md)
* @beta
* @public
*/
export class Tweens {
private _tweens: any = {};
Expand Down Expand Up @@ -113,18 +113,18 @@ export class Tweens {
}
}

/** @beta */
/** @public */
export type TweenCallback = (obj: any) => void;
/** @beta */
/** @public */
export type UpdateCallback = (obj: any, t: number) => void;
/** @beta */
/** @public */
export type EasingFunction = (k: number) => number;
/** @beta */
/** @public */
export type InterpolationFunction = (v: any, k: number) => number;

/** A Tween for interpolating values of an object. Instances of this class are owned by a `Tweens` group.
* @see The [tween.js users guide](https://github.com/tweenjs/tween.js/blob/master/docs/user_guide.md)
* @beta
* @public
*/
export class Tween {
private _isPaused = false;
Expand Down Expand Up @@ -426,7 +426,7 @@ export class Tween {
}

/** Easing functions from tween.js
* @beta
* @public
*/
export const Easing = {
Linear: {
Expand Down Expand Up @@ -642,7 +642,7 @@ export const Easing = {
};

/** Interpolation functions from tween.js
* @beta
* @public
*/
export const Interpolation = {

Expand Down
2 changes: 1 addition & 1 deletion core/common/src/ipc/IpcSocket.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export type IpcListener = (evt: Event, ...args: any[]) => void;

/**
* Function returned when establishing an Ipc `receive` listener or `invoke` handler. Call this method to remove the listener/handler.
* @beta
* @public
*/
export type RemoveFunction = () => void;

Expand Down
6 changes: 3 additions & 3 deletions core/frontend/src/IpcApp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ import { IModelApp, IModelAppOptions } from "./IModelApp";

/**
* type check for an function that returns a Promise
* @beta
* @public
*/
export type AsyncFunction = (...args: any) => Promise<any>;
/**
* a type that is the list of the asynchronous functions in an interface
* @beta
* @public
*/
export type AsyncMethodsOf<T> = { [P in keyof T]: T[P] extends AsyncFunction ? P : never }[keyof T];
/**
* get the type of the promised value of an asynchronous function
* @beta
* @public
*/
export type PromiseReturnType<T extends AsyncFunction> = T extends (...args: any) => Promise<infer R> ? R : any;

Expand Down
2 changes: 1 addition & 1 deletion core/frontend/src/NativeApp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { IModelApp } from "./imodeljs-frontend";
import { AsyncMethodsOf, IpcApp, IpcAppOptions, NotificationHandler, PromiseReturnType } from "./IpcApp";
import { NativeAppLogger } from "./NativeAppLogger";

/** Properties for specifying the Briefcaseid for downloading
/** Properties for specifying the BriefcaseId for downloading
* @beta
*/
export type DownloadBriefcaseId =
Expand Down